/scalemgmt/v3/clusters: POST

Creates the IBM Storage Scale cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The POST cluster request creates the IBM Storage Scale cluster. For more information about the fields in the data structures that are returned, see scalectl cluster command.

Note: When a cluster is created, the first node is automatically designated as both a quorum and manager node. You cannot select the node designations during the creation of the first cluster node.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/clusters

Request headers

Accept: application/json

Request parameters

Table 1. List of request parameters
Parameter name	Description and applicable keywords	Required/optional
node_name	The name of the node.	Required.
admin_node_name	The name of the admin node.	Optional.
cluster_name	The name of the cluster.	Optional.
domain_name	The UID domain name for the cluster.	Optional.
node_comment	The additional information about the node.	Optional.
port_number	The communication port number for the I/O daemon.	Optional.
remote_file_copy	The fully qualified path name for the mm-command CLI remote file copy program.	Optional.
remote_shell_command	The fully qualified path name for the mm-command CLI remote shell program.	Optional.
auto_load	Starts the I/O daemon automatically when nodes come up.	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

201: A successful response and the IBM Storage Scale Cluster was created.

{
  "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 displays how to create the cluster.

Request data:

curl -n -k -X POST https://localhost:46443/scalemgmt/v3/clusters -H 'accept: application/json' -d '{"cluster_name": "Test_Cluster1", "node": { "node_name": "gpfs-dev-3", "admin_node_name": "gpfs-dev-3", "node_comment": "REST test cluster" }, "autoload": true, "domain_name": "domain1", "port_number": "1191", "remote_file_copy_cmd": "/usr/lpp/mmfs/bin/scaleadmremotetransfer", "remote_shell_cmd": "/usr/lpp/mmfs/bin/scaleadmremoteexecute"}'

Response data:

{
    "cluster_name": "Test_Cluster1",
    "domain_name": "domain1",
    "remote_file_copy_cmd": "/usr/lpp/mmfs/bin/scaleadmremotetransfer",
    "remote_shell_cmd": "/usr/lpp/mmfs/bin/scaleadmremoteexecute",
    "cluster_id": "114615821127849099",
    "repository_type": "CCR",
    "nodes": [
        {
            "node_name": "gpfs-dev-3.gpfs.net",
            "admin_node_name": "gpfs-dev-3.gpfs.net",
            "node_designations": [
                "quorum",
                "manager"
            ],
            "node_number": "1",
            "daemon_ip_address": "10.114.205.7"
        }
    ],
    "manager": "<none>"
}