Nodes/{name}: GET

Gets information about a node.

Availability

Available on all IBM Spectrum Scale™ editions.

Description

The GET nodes/nodeName request gets information about the specified node. For more information about the fields in the data structures that are returned, see the topics mmchnode command and mmgetstate command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/nodes/nodeName

where

nodes: Is the nodes resource. Required.
nodeName: Specifies the node about which you want to get information. Required.

Request headers

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

Request data

No request data.

Request parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of request parameters
Parameter name	Description and applicable keywords	Required/optional
fields	Comma separated list of fields to be included in response. ':all:' selects all available fields.	Optional.
filter	Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET'	Optional.
name	Name of the node.	Required.

Response data

{  
  "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "paging": 
    {
    "next": "URL"
    },
   nodes: [
      {
        "adminNodename":"IP or host name",
        "nodeNumber":"Node ID",
        "config":
            {
             "adminLoginName":"Admin login name",
             "designatedLicense":"Designated license",
             "requiredLicense":"Required license",
            }, 
        "status":         
           {
             "osName":"Operating system",
             "nodeState":"Health status",
             "gpfsState":"GPFS status",
             "productVersion":"Version",
            },
        "network":
            {
             "adminIPAddress":"IP address or host name",
             "daemonNodeName":"GPFS daemon node name",
             "daemonIPAddress":"IP address",
             "getcnfsNodeName":"Host name used by cNFS",
            },
        "roles"
            {
             "snmpNode":"yes | no",
             "managerNode":"yes | no",
             "gatewayNode":"yes | no",
             "cnfsNode":"yes | no",
             "cesNode":"yes | no",
             "quorumNode":"yes | no",
             "cloudGatewayNode":"yes | no",
             "otherNodeRoles":"Roles",
             "designation":"quorum | quorumManager |manager",
            }, 
        "cnfsInfo" 
           {
             "cnfsState":"cNFS state",
             "cnfsGroupId":"cNFS gruop ID",
             "cnfsIplist":"cNFS IP aadresses",
           }, 
        "cesInfo":
            {
              ""cesState"":"CES state",
              "cesGroup":"CES group",
              "cesIpList":"CES IPs",
              "ipAddress":"IP address of this node",
            }
          }
        ]
}

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

"status":

Return status.

"message": "ReturnMessage",: The return message.
"code": ReturnCode: The return code.

"paging": The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.

"nodes":

adminNodename":"IP or host name"

The host name that is used by the GPFS admin network.

"nodeNumber":"Node ID"

The GPFS node ID.

"config":

"adminLoginName":"Admin login name": The name of the admin login.
"designatedLicense":"Designated license": The license this node is running on.
"requiredLicense":"client | FPO | server": Controls the type of GPFS required license that is associated with the nodes in the cluster.

"status":

"osName":"Operating system": The name of Operating System running on this node.
"nodeState":"Health status": The state of the node as reported by the mmhealth node show command.
"gpfsState":"GPFS status": The state of GPFS on this node as reported the mmhealth node show command.
"productVersion":"Version": The IBM Spectrum Scale version that is installed on this node.

"network":

"adminIPAddress":"IP address or host name": The IP address that is used by the GPFS admin network.
"daemonNodeName":"GPFS daemon node name": The host name that is used by the GPFS daemon network.
"daemonIPAddress":"IP address": The IP address that is used by the GPFS daemon network.
"getcnfsNodeName":"Host name used by cNFS": The hostname that is used by cNFS.

"roles":

"snmpNode":"yes | no": Specifies whether this node is an SNMP node.
"managerNode":"yes | no": Specifies whether this node is a manager node.
"gatewayNode":"yes | no": Specifies whether this node is a gateway node.
"cnfsNode":"yes | no": Specifies whether this node is a cNFS node.
"cesNode":"yes | no": Specifies whether this node is a CES node.
"quorumNode":"yes | no": Specifies whether this node is a quorum node.
"cloudGatewayNode":"yes | no": Specifies whether this node is a cloud gateway node.
"otherNodeRoles":"Roles": Other roles of this node.
"designation":"quorum | quorumManager |manager": The designated role.

"cnfsInfo":

"cnfsState":"cNFS state"
"cnfsGroupId":"cNFS gruop ID"
"cnfsIplist":"cNFS IP aadresses"

"cesInfo":

""cesState"":"CES state": The state of CNFS on this node.
"cesGroup":"CES group": The CNFS group ID.
"cesIpList":"CES IPs": A list of CNFS IP addresses.
"ipAddress":"IP address of this node": The actual IP address of this node.

Examples

The following example gets information about the node testnode1-d.localnet.com.

Request data:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/node/testnode1-d.localnet.com

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": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/node/testnode1-d.localnet.com?lastId=1001"
  },
  "nodes": [
    {
      "adminNodeName": "testnode1-a.localnet.com",
      "nodeNumber": "1",
      "config": {
        "adminLoginName": "root",
        "designatedLicense": "server",
        "requiredLicense": "true"
      },
      "status": {
        "osName": "Red Hat Enterprise Linux Server 7.2 (Maipo)",
        "nodeState": "HEALTHY",
        "gpfsState": "HEALTHY",
        "productVersion": "4.2.3.0"
      },
      "network": {
        "adminIPAddress": "10.0.200.21",
        "daemonNodeName": "testnode1-d.localnet.com",
        "daemonIPAddress": "10.0.100.21",
        "getcnfsNodeName": "string"
      },
      "roles": {
        "snmpNode": "true",
        "managerNode": "false",
        "gatewayNode": "false",
        "cnfsNode": "true",
       
        "cesNode": "false",
        "quorumNode": "true",
        "cloudGatewayNode": "true",
        "otherNodeRoles": "perfmonNode,cesNode",
        "designation": "quorum"
      },
      "cnfsInfo": {
        "cnfsState": "enabled",
        "cnfsGroupId": "5",
        "cnfsIplist": "10.0.100.1,10.0.100.2"
      },
      "cesInfo": {
        "cesState": "e",
        "cesGroup": "LAN_4",
        "cesIpList": "192.168.2.11,192.168.2.13,192.168.2.15",
        "ipAddress": "10.0.100.23"
      }
    }
  ]
}