Gnr/recoverygroups/suspend/{recoveryGroupName}/{node}: PUT

Suspends a single node on a scale-out recovery group.

Availability

Available with IBM Storage Scale Erasure Code Edition only.

Description

The PUT gnr/recoverygroups/suspend/{recoveryGroupName}/{node} request suspends a single node in a scale-out recovery group for maintenance purposes. For more information about the fields in the data structures that are returned, see the mmvdisk recoverygroup command.

Request URL

https://<IP address or host name of API server>:<port>scalemgmt/v2/gnr/recoverygroups/suspend/{recoveryGroupName}/{node}
where
recoveryGroupName
Specifies recovery group to which the suspended node belongs. Required.
node
Specifies the node of the recovery group that is suspended. Required.

Request headers

Accept: application/json

Request data

No request data:

Response data

{
  "jobs": [
    {
      "jobId": ID of the job,
      "status": "Job status",
      "submitted": "Date and time ",
      "completed": "Date and time ",
      "runtime": Duration,
      "request": {
        "type": "Request Type",
        "url": "Resource URL"
      },
      "result": {},
      "pids": []
    }
  ],
  "status": {
    "code": return status code,
    "message": "Return message."
  }
}

For more information about the fields in the following data structures, see the links at the end of the topic.

"jobs":
An array of elements that describe jobs. Each element describes one job.
"jobId": "ID",
Specifies the unique ID of the job.
"submitted": "Time"
Specifies the date and time at which the job was submitted.
"completed": "Time"
Specifies the date and time at which the job was completed.
"runtime": "Time"
Specifies the duration for which the job ran.
"status": "RUNNING | COMPLETED | FAILED"
Specifies the Status of the job.
"result"
Array of commands that are run in this job.
"pids": list
A list of pids for this job.
"request"
"type": "{GET | POST | PUT | DELETE}"
Specifies the HTTP request type.
"url": "URL"
Specifies the URL through which the job is submitted.
"status":
Return status.
"message": "ReturnMessage",
Specifies the return message.
"code": ReturnCode
Specifies the return code.

Examples

The following example suspends the node hciece01-hs.gpfs.net of the recovery group rg1.

Request data: 
curl -k -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Basic a3JpdGlrYTE6YWRtaW4wMDE=' 'https://198.51.100.1:443/scalemgmt/v2/gnr/recoverygroups/suspend/rg1/hciece01-hs.gpfs.net'

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": 4000000000004,
      "status": "RUNNING",
      "submitted": "2021-04-27 06:31:37,838",
      "completed": "N/A",
      "runtime": 3,
      "request": {
        "type": "PUT",
        "url": "scalemgmt/v2/gnr/recoverygroups/suspend/rg1/hciece01-hs.gpfs.net"
      },
      "result": {},
      "pids": []
    }
  ],
  "status": {
    "code": 202,
    "message": "The request was accepted for processing."
  }
}