CES/services/{service}: GET

Gets information about a CES service.

Availability

Available on all IBM Storage Scale editions.

Description

The GET ces/services/service request gets information about a CES (Cluster Export Services) service in the cluster. For more information about the fields in the returned data structure, see mmces command.

Request URL

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

where

ces/services: Specifies ces/services as the resource.
service: Specifies the service 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
service	Name of the service about which you need the details.	Required.

Request data

No request data.

Response data


{ 
   "status": {
      "code": ReturnCode,
      "message": "ReturnMessage"
   }
   "cesservices": {
        "protocolStates": [
         {
            "service":"Service"
            "enabled":"{yes | no}",            
         }
       ]
      "protocolNodes": [
         {
            "nodeName":"Node"
            "serviceStates": [
               {
                  "service":"Service" 
                  "running":"{yes | no}",                   
               }
            ]
         }
      ],
   },
  
}

status:

Return status.

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

cesservices:

Information about CES services. The information consists of two arrays, protocolNodes and protocolStates. Each array contains multiple elements, with one element for each CES service. For more information about the fields in these structures, see the link at the end of this topic.

protocolStates:

An array of information about the services. Each element describes one service:

"service":"Service": Identifies the service such as CES, NETWORK, NFS, or SMB.
"enabled":"{yes | no}": Indicates whether the service is enabled.

protocolNodes

An array of information about protocol nodes. Each array element describes one protocol node.

"nodeName":"Node"

The name of the node.

serviceStates:

An array of information about the services for which the node is a protocol node.

"service":"Service": Name of the service.
"running":"{yes | no}": Indicates whether the service is running.

Examples

The following example gets information about the SMB service.

Request data:

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

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.

The protocolNodes array returns the details of the node on which the SMB protocol is configured. The protocolStates array provides the status of the SMB protocol.

{
  "status": {
    "code": "200",
    "message": "The request finished successfully"
  },
  "cesservices": {
    "protocolStates": [
      {
        "service": "SMB",
        "enabled": "yes"
      }
    ],
    "protocolNodes": [
      {
        "nodeName": "testnode-1.localnet.com",
        "serviceStates": [
          {
            "service": "SMB",
            "running": "yes"
          }
        ]
      }
    ]
  }
}