Gnr/diskmgmt/vdiskset/delete/{vdiskSet}: DELETE

Deletes member vdisk NSDs from a vdisk set.

Availability

Available with IBM Storage Scale Erasure Code Edition only

Description

The DELETE gnr/diskmgmt/vdiskset/delete/{vdiskSet} request deletes a member vdisk NSD from a vdisk set. For more information about the fields in the data structures that are returned, see the mmvdisk command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/gnr/diskmgmt/vdiskset/delete/{vdiskSet}
where
vdiskset/delete/{vdiskSet}
Specifies the vdisk set from which the member NSDs must be deleted. Required.

Request headers


Accept: application/json

Parameters

Table 1. List of parameters
Parameter name Description and applicable keywords Required/Optional
vdiskSet Name of the vdisk set from which member vdisk NSDs are to be removed. Required

Request data

No request data.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   jobs: [
      {
         "result":"", 
           { 
             "commands":"Commands used",
             "progress":"Request progress,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"CLI messages",
           },
         "request":" ",
           {
             "type":"{GET | DELETE | DELETE | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
          "runtime":duration
         "status":"Job status",
         }   
        ],
   }
For more information about the fields in the following data structures, see the links at the end of the topic.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"jobs":
An array of elements that describe jobs. Each element describes one job.
"result"
"commands":"String"
Array of commands that are run in this job.
"progress":"String"
Progress information for the request.
"exitCode":"Exit code"
Exit code of command. Zero indicates success, and any value other than zero denotes failure.
"stderr":"Error"
CLI messages from stderr.
"stdout":"String"
CLI messages from stdout.
"request"
"type":"{GET | POST | PUT | DELETE}"
HTTP request type.
"url":"URL"
The URL through which the job is submitted.
"data":
Specifies the request data. Optional.
"jobId":"ID",
The unique ID of the job.
"submitted":"Time"
The time at which the job was submitted.
"completed":"Time"
The time at which the job was completed.
"runtime":duration
Specifies the duration for which the job ran.
"status":"RUNNING | COMPLETED | FAILED"
Status of the job.

Examples

The following example shows how to delete member vdisk NSDs from the vdisk set vs1:

Request data: 
 curl -k -u admin:admin001 -X DELETE --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/gnr/diskmgmt/vdiskset/delete/vs1'

Response data:

Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
  "jobs" : [ {
    "jobId" : 1000000000002,
    "status" : "COMPLETED",
    "submitted" : "2021-01-30 18:01:45,173",
    "completed" : "2021-01-30 18:01:45,737",
    "runtime" : 566,
    "request" : {
      "type" : "DELETE",
      "url" : "scalemgmt/v2/gnr/diskmgmt/vdiskset/undefine/vs1"
      "data": " "
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ "mmvdisk vdiskset delete --vdisk-set {all | VdiskSet[,VdiskSet...]} |
                        [--recovery-group  RgName[,RgName...]] [-p]" ],
      "stdout" : [ " " ],
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}