Gnr/clustermgmt/nodes/{names}/state: GET

Gets the status of the GPFS daemon on a specified node of the cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The GET gnr/clustermgmt/nodes/{names}/state request gets the details of the GPFS daemon on the node that is specified in the request parameter. For more information about the fields in the data structures that are returned, see the mmgetstate command in IBM Storage Scale: Command and Programming Reference in the IBM Storage Scale documentation.

Request URL

https://IP address of API server:<port>/scalemgmt/v2/gnr/clustermgmt/nodes/{names}/state
where
nodes
Specifies the resource of this GET call. Required.
names
Specifies the node names. Required.

Request headers

Content-Type: application/json
Accept: application/json

Request data

No request data.

Response data

{
  "status": {
    "code": Status code,
    "message": "Status message"
  },
  "nodeState": [
    {
      "nodeName": "Node name",
      "number": Node number,
      "state": "UNKNOWN | ACTIVE | ARBITRATING | DOWN ",
      "quorum": Node quorum,
      "quorumUp": Number of quorum nodes up,
      "totalNode": Total number of nodes,
      "remarks": "Comments",
      "daemonNodeName": "Name of node"
      "daemonShortName": "Shortname of node"
      "cnfsState": "The GPFS daemon state"
    }
  ]
}
For more information about the fields in the following data structures, see the links at the end of the topic.
"status":
Return status.
"message": "ReturnMessage"
The return message.
"code": ReturnCode
The return code.
"nodeState"
The state of the Nodes.
"nodeName":"Node name"
The name of the node.
"number": Node number
Specifies the number of the node.
"state":"UNKNOWN | ACTIVE | ARBITRATING | DOWN "
The status of GPFS daemon.
UNKNOWN
The state cannot be detected through the API request.
ACTIVE
The GPFS daemon is ready for operation.
ARBITRATING
A node is trying to form a quorum with the other available nodes.
DOWN
The GPFS daemon is not running on the node or is recovering from an internal error.
"quorum":"quorum nodes"
The number of quorum nodes.
"quorumUp":"quorum nodes that are up "
The number of quorum nodes that are up.
"totalnode":"All nodes"
The total number of nodes.
"remarks":"comments"
The additional comments on the node status.
"daemonNodeName":"Node name"
The name of the daemon node.
"daemonShortName":"Node shortname"
The shortname of the daemon node.
"cnfsState":"GPFS daemon state"
The state of the GPFS daemon.

Examples

The following example gets information on the status of the GPFS daemon on the node hciece01.

Request data:
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/gnr/clustermgmt/nodes/hciece01/state
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. 

{
  "status": {
    "code": 200,
    "message": "..."
  },
  "nodeStates": [
    {
      "nodeName": "hciece01",
      "daemonNodeName": "rhel-41.openstacklocal",
      "daemonShortName": "rhel-41",
      "number": 0,
      "state": "UNKNOWN",
      "quorum": 3,
      "quorumUp": 2,
      "totalNode": 3,
      "remarks": " ",
      "cnfsState": " "
    }
  ]
}

Related information:

mmgetstate command in the IBM Storage Scale documentation.