Filesystems/{fileSystemName}/vdiskset/{vdiskset}: POST

Adds a IBM Storage Scale RAID vdisk set to mmvdisk file systems.

Availability

Available with IBM Storage Scale Erasure Code Edition only.

Description

The POST filessystems/{filesystemName}/vdiskset/{vdiskSet} request adds a IBM Storage Scale RAID vdisk set to mmvdisk file systems. 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/filesystems/fileSystemName/vdiskset/vdiskset
where:
fileSystemName
Specifies the mmvdisk file system where the vdisk set is to be added. Required.
vdiskset
Specifies the vdisk set that is to be added. 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
fileSystemName The name of the file system name where the vdisk is to be added. Required.
vdiskset The name of the vdisk that is added. Minimum 1 Required.

Response data

{
   "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "jobs": [
      {
         "result":"", 
           { 
             "commands":"Commands issued",
             "progress":"Request progress,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"CLI messages",
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted": "Date and Time",
         "completed": "Date and Time",
         "runtime": "Duration",
         "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":"Commands issued"
An array of commands that are run in this job.
"progress":"Request progress"
Specifies the progress information for the request.
"exitCode":"Exit code"
Specifies the exit code of command. Zero indicates success and any value other than zero denotes failure.
"stderr":"Error"
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":"Date and Time"
Specifies the date and time at which the job was submitted.
"completed":Date and Time"
Specifies the date 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.
"pids":"Process ID"
Specifies the process IDs of all the active sub processes that manage the job.

Examples

The following example shows how to add the vdisk set vs1 to the file system udata.

Request data: 
curl -k -u admin:admin001 -X POST --header 'accept:application/json' 'https://198.51.100.1:443/scalemgmt/v2/filesystem/udata/vdisk/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/filesystem/udata/vdisk/vs1"
      "data": " "
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ mmvdisk filesystem add --file-system udata --vdisk-set VS1 ],
      "stdout" : [ " " ],
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}