Gnr/diskmgmt/vdiskset/create/{vdiskSet}: POST

Creates a member vdisk NSD for a vdisk set.

Availability

Available with IBM Storage Scale Erasure Code Edition only.

Description

The POST Gnr/diskmgmt/vdiskset/create/{vdiskSet} request creates a member vdisk NSD for 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/create/vdiskSet
where:
vdiskSet
Specifies the name of the vdisk set where the member vdisk NSD is created. Required.

Request headers

Accept: application/json

Request data

No request data.

Parameters

Table 1. List of parameters
Parameter name Description and applicable keywords Required/Optional
vdiskSet The name of the vdisk set where the member vdisk NSD is created. Required

Response data

{
   "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "jobs": [
      {
         "result":"", 
           { 
             "commands":"commands used",
             "progress":"Request progress status,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"CLI message",
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "status":"Job status",
         "pids":"Process IDs
         }
   ],
  }

The details of the parameters are provided in the following list:

"jobs":
An array of elements that describe jobs. Each element describes one job.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
""result"
"commands":"String"
An array of commands that are run in this job.
"progress":"String"
Specifies the progress information for the request.
"exitCode":"Exit code"
Specifies the exit code of the command. Zero is success and nonzero denotes failure.
"stderr":"String"
Specifies the CLI messages from stderr.
"stdout":"String""
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":"Time"
Specifies the data and time at which the job was submitted.
"completed":Time"
Specifies the data and time at which the job was completed.
"status":"RUNNING | COMPLETED | FAILED"
Specifies the status of the job.
"pids":"Process ID"
Specifies the process IDs of all the active sub processes that manage the job.

Examples

The following example shows how to define the member vdisk NSD in the vdisk set vs1.

Request data: 
curl -k -u admin:admin001 -X POST --header 'accept:application/json' 'https://198.51.100.1:443/scalemgmt/v2/gnr/diskmgmt/vdiskset/create/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" : 1000000000004,
    "status" : "COMPLETED",
    "submitted" : "2021-01-30 18:01:45,173",
    "completed" : "2021-01-30 18:01:45,737",
    "runtime" : 564,
    "request" : {
      "type" : "POST",
      "url" : "scalemgmt/v2/gnr/diskmgmt/vdiskset/create/vs1"
      "data": " "
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ mmvdisk vdiskset create  --vdisk-set {all | VdiskSet[,VdiskSet...]} ],
      "stdout" : [ " " ],
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}