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

Removes a vdisk set definition from IBM Storage Scale RAID recovery groups.

Availability

Available with IBM Storage Scale Erasure Code Edition only.

Description

The DELETE gnr/diskmgmt/vdiskset/undefine/{vdiskSet} request removes the definition of vdisk sets from recovery groups that belong to IBM Storage Scale RAID. 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/undefine/{vdiskSet}
where
{vdiskSet}
Specifies the vdisk set that must be removed from the recovery groups. 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 whose definition is to be removed. Required

Request data

No request data.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   jobs: [
      {
         "result":"", 
           { 
             "commands":"Commands issued ",
             "progress":"Request progress status,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"CLI messages",
           },
         "request":" ",
           {
             "type":"{GET | DELETE | DELETE | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "completed":Duration
         "status":"Job status",
         }   
        ],
   }
For more information about the fields in the following data structures, see the link 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":"commnds issued "
An array of commands that are issued in this job.
"progress":"Request progress"
Specifies the progress information for the request.
"exitCode":"Exit code"
Specifies the Exit code of the command. Zero indicates success, and any value other than zero denotes failure.
"stderr":"Error"
Specifies the CLI messages from stderr.
"stdout":"CLI messages"
Specifies the CLI messages from stdout.
"request"
"type":"{GET | POST | PUT | DELETE}"
Specifies the HTTP request type.
"url":"URL"
Specifies the URL through which the job is submitted.
"data":
Specifies the request data. Optional.
"jobId":"ID",
Specifies the unique ID of the job.
"submitted":"Date and Time"
Specifies the data and time at which the job was submitted.
"completed": "Date and Time"
Specifies the data and time at which the job was completed.
"runtime": "duration"
Specifies the duration for which the job ran.
"status":"RUNNING | COMPLETED | FAILED"
Specifies the status of the job.

Examples

The following example shows how to remove the vdisk set definition 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/undefine/vs1'

The request URL with no field or filter parameter returns only the details that uniquely identify the object.

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" : 1000000000003,
    "status" : "COMPLETED",
    "submitted" : "2021-01-30 18:01:45,173",
    "completed" : "2021-01-30 18:01:45,737",
    "runtime" : 564,
    "request" : {
      "type" : "DELETE",
      "url" : "scalemgmt/v2/gnr/diskmgmt/vdiskset/undefine/vs1"
      "data": " "
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ "mmvdisk vdiskset undefine  --vdisk-set VdiskSet [--confirm]" ],
      "stdout" : [ " " ],
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}