/scalemgmt/v3/clusters: GET

Lists information about the cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The GET clusters request lists information about the local cluster. For more information about the fields in the data structures that are returned, see scalectl cluster command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/clusters
where
clusters
Specifies the IBM Storage Scale clusters resource to list the clusters.

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
view The view for snapshot contents. The possible values are basic, ces, cnfs, and node-comments. Optional.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.
    {
  "clusters": [
    {
      "cesinfo": {
        "address_policy": "string",
        "ces_shared_root": "string",
        "cesnodes": [
          {
            "ces_group": "string",
            "ces_ip_list": "string",
            "ces_state": "ENABLED",
            "daemon_node_name": "string",
            "ip_address": "string",
            "node_number": "string"
          }
        ],
        "enabled_services": "string",
        "interface_mode": "string",
        "log_level": "string"
      },
      "cluster_id": "string",
      "cluster_name": "string",
      "cnfsinfo": {
        "cnfs_ganesha": "string",
        "cnfs_monitor_enabled": "string",
        "cnfs_mound_port": "string",
        "cnfs_nfsd_procs": "string",
        "cnfs_reboot": "string",
        "cnfs_shared_root": "string",
        "cnfsnodes": [
          {
            "cnfs_group_id": "string",
            "cnfs_ip_list": "string",
            "cnfs_state": true,
            "daemon_node_name": "string",
            "ip_address": "string",
            "node_number": "string"
          }
        ]
      },
      "manager": "string",
      "nodes": [
        {
          "admin_login_name": "string",
          "admin_node_name": "string",
          "daemon_node_name": "string",
          "designation": {
            "ces": true,
            "cloud_gateway": true,
            "cnfs": true,
            "gateway": true,
            "ionode": true,
            "manager": true,
            "perfmon": true,
            "quorum": true,
            "snmp_collector": true
          },
          "ip_address": "string",
          "node_comment": "string",
          "node_number": "string"
        }
      ],
      "primary_server": "string",
      "rcp_path": "string",
      "rcp_sudo_wrapper": "YES",
      "repository_type": "string",
      "rsh_path": "string",
      "rsh_sudo_wrapper": "YES",
      "secondary_server": "string",
      "uid_domain": "string"
    }
  ]
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example gets information about the local cluster.

Request data: 
curl  -n -k -X GET  \
https://localhost:46443/scalemgmt/v3/clusters  \
-H 'accept: application/json'
Response data: 
{
        "clusters": [
                {
                        "cluster_name": "gpfs-dev-1.gpfs.net",
                        "domain_name": "gpfs-dev-1.gpfs.net",
                        "remote_file_copy_cmd": "/usr/lpp/mmfs/bin/scaleadmremotetransfer",
                        "remote_shell_cmd": "/usr/lpp/mmfs/bin/scaleadmremoteexecute",
                        "cluster_id": "5930125853445074185",
                        "repository_type": "CCR",
                        "nodes": [
                                {
                                        "node_name": "gpfs-dev-1.gpfs.net",
                                        "admin_node_name": "gpfs-dev-1.gpfs.net",
                                        "node_designations": [
                                                "quorum",
                                                "manager"
                                        ],
                                        "node_number": "1",
                                        "daemon_ip_address": "10.114.205.169"
                                },
                                {
                                        "node_name": "gpfs-remote-2",
                                        "admin_node_name": "gpfs-remote-2",
                                        "node_designations": [
                                                "quorum"
                                        ],
                                        "node_number": "9",
                                        "daemon_ip_address": "10.114.205.224"
                                }
                        ],
                        "manager": "gpfs-dev-1.gpfs.net"
                }
        ]
}