CES/addresses/{cesAddress}: GET

Gets information about a CES address.

Availability

Available on all IBM Spectrum Scale™ editions.

Description

The GET ces/addresses/{cesAddress} request gets information about a specific CES (Cluster Export Services) address. For more information about the fields in the data structures that are returned, see mmces command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/ces/addresses/CesAddress

where

ces/addresses: Specifies CES address as the resource. Required.
CesAddress: Specifies the CES address about which you want to get information. Required.

Request headers

Accept: application/json

Parameters

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

Table 1. List of parameters
Parameter name	Description and applicable keywords	Required/optional
cesAddress	The IP address to query.	Required.

Request data

No request data.

Response data

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

{      
"status":
   {
      "code": ReturnCode
      "message": "ReturnMessage",   
   }
"paging": 
  {
    "next": "URL"
  },
   "cesaddresses": [
      {
         "oid": "Integer"
         "nodeNumber": "Integer"
         "nodeName": Node name
         "attributes": "Attributes",
         "cesAddress": "IP",
         "cesGroup": "Group",
         }
   ],
}

The details of the parameters are provided in the following list:

"status":

Return status.

"code": ReturnCode,: The HTTP status code that was returned by the request.
"message": "ReturnMessage": The return message.

"paging"

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

"cesaddresses":

An array of information about CES addresses. For more information about the fields in this structure, see the links at the end of this topic.

"oid": "Integer": Internal identifier that is used for paging.
"nodeNumber": "Integer": The number of the cesNode this address belongs to.
"nodeName": "Node": The CES node to which the address is assigned.
"Attributes": "Attributes": Protocol attributes that are associated with the CES address.
"cesAddress": "IP": The CES address that is assigned to the node.
"cesGroup": "Group": The group to which the CES address is assigned.

Examples

The following example gets information about the CES address 198.51.100.8.

Request data:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/ces/addresses/198.51.100.8'

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": "..."
  },
  "cesaddresses": [
    {
    "attributes" : "",
    "cesAddress" : "198.51.100.8",
    "cesGroup" : "",
    "nodeName" : "mari-13.localnet.com",
    "nodeNumber" : 3,
    "oid" : 1
    }
  ]
}