Gnr/clustermgmt/server/configure: POST

Configures a new node or an mmvdisk node class for IBM Storage Scale RAID servers.

Availability

Available with IBM Storage Scale Erasure Code Edition only.

Description

The POST Gnr/clustermgmt/server/configure request creates and configures a new node or an mmvdisk node class for the IBM Storage Scale RAID servers. The nodes or node class must not already be configured or must not be serving a recovery group. For more information about the fields in the data structures that are returned, see the mmvdisk server command.

Request URL

https://<IP address or host name of API server>:port/scalemgmt/v2/gnr/clustermgmt/server/configure

Request headers

Accept: application/json

Request data

The following list of attributes are available in the request data:

{
  "node": "Node name",
  "recycle": "none | one| all | Number",
  "pagePool": "nM | nG | n%",
  "maxBlockSize": "2M |4M |8M |16M",
}
The details of the parameters are given in the following list:
"node": The name of the node
The node name that is to be configured.
"recycle": none | one | all | Number
Specifies the number of nodes that can be simultaneously restarted so that IBM Storage Scale configuration changes can take effect.
none
This is the default value and indicates that the administrator must use the commands mmstartup and mmshutdown to recycle the nodes or node class.
one
Specifying this value indicates that recycling occurs one node at a time .
all
Specifying this value indicates that all specified nodes are recycled simultaneously.
Number
Specifying a number indicates that the defined number of nodes can be chosen to be recycled at the same time.
"pagepool": nM | nG | n%
The IBM Storage Scale page pool value. This option should only be used under instruction from IBM®.
"maxBlockSize" : 2M |4M |8M|16M
The maximum file system block size to be used with IBM Storage Scale RAID.

Response data

{
   "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "jobs": [
      {
         "result":"", 
           { 
             "commands":"String",
             "progress":"String,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"String",
           },
         "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":"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 is success and nonzero 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":
Optional.
"jobId":"ID",
The unique ID of the job.
"submitted":"Date and Time"
Specifies the date and the time at which the job was submitted.
"completed":"Date and Time"
Specifies the date and the 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 configure a new node named ess-11 .

Request data: 
curl -k -u admin:admin001 -X POST --header 'accept:application/json' 'https://198.51.100.1:443/scalemgmt/v2/gnr/clustermgmt/server/configure'

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" : 563,
    "request" : {
      "type" : "POST",
      "url" : "scalemgmt/v2/gnr/clustermgmt/server/configure"
      "data": " "
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ "mmvdisk server configure {--node-class NcName | -N Node[,Node...]}  
                         [--recycle {none |one |all | Number}]
                         [--pagepool {nM |nG | n%}]
                         [--maxblocksize {2M | 4M | 8M | 16M}] 
                         [--update]" ],
      "stdout" : [ " " ],
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}