scalectl node command

Use this command to add nodes to an existing IBM Storage Scale cluster. You can also manage the node and view its status information.

Synopsis

scalectl node add -N {NodeName} [--accept] [--admin-node-name {AdminNodeName}] [--license-type {server | client}] [--node-comment {NodeComment}] [--node-designations {manager | client | quorum | nonquorum}]
Or
scalectl node config [delete] [get] [set [-c {Certificate}] [-C {CA_Chain}] [-i {ip_address}] [-p {Certificate}] [-s {https}] [-k {KeyFile}] [-I {ip_address}] [-P {PortNumber}] [-S {https}]
Or
scalectl node start [--env-var {EnvironmentVariable}] [-N {Node[,Node...]}]
Or
scalectl node status [-N {Node[,Node...]}]
Or
scalectl node stop [--accept] [-N {Node[,Node...]}] [--unmount-timeout {Time}]

Availability

Available on all IBM Storage Scale editions.

Description

Use the scalectl node command to add and manage a node.

Parameters

add
Adds an IBM Storage Scale node to the local cluster.
--accept
Accepts the terms of the applicable license agreement.
--admin-node-name {AdminNodeName}
Specifies a separate node name for administrative commands.
--license-type {server | client}
Specifies the license type for the node. The possible values are server and client.
--node-comment {NodeComment}
Specifies additional information about the node.
--node-designations {manager | client | quorum | nonquorum}
Specifies an optional, comma-separated list of node roles.
-N or --node-name {NodeName}

Specifies the hostname or IP address of the node for I/O daemon-to-daemon communication. If the --admin-node-name parameter is not specified, this address is also used for communication between administration daemons.

config
Configures the node.
delete
Deletes an existing node identity.
get
Lists the node identity.
set
Sets the node configuration parameters.
Note: Use the scalectl node config set command to configure certificates locally on the node. These options are supported only through the administration daemon using the Unix Domain Socket (UDS) connection and are not available through the REST interface over HTTPS. You cannot configure these options remotely by using the --url flag.
-c or --cert {Certificate}
Specifies the client or endpoint certificate file.
-C or --chain {CA_Chain}
Specifies the CA certificate chain.
-i or --grpc-interface {ip_address}
Specifies the host IP address that the gRPC server binds to.
-p or --grpc-port {Certificate}
Specifies the gRPC server port number.
-s or --grpc-scheme {https}
Specifies the gRPC interface scheme. The default value is https.
-k or --key {KeyFile}
Specifies the client or endpoint key file.
-I or --rest-interface {ip_address}
Specifies the host IP address that the REST server binds to.
-P or --rest-port {PortNumber}
Specifies the REST server port number.
-S or --rest-scheme {https}
Specifies the REST interface scheme. The default value is https.
start
Starts the mmfsd service on a node.
-E or --env-var {EnvironmentVariable}
Specifies the name and value of an environment variable to send to the IO daemon.
-N or --target-nodes {Node[,Node...]}
Specifies a list of target IBM Storage Scale nodes. The value can include any combination of node numbers, node number ranges, node names, IP addresses, or node classes.
status
Checks the mmfsd status of a cluster node.
-N or --target-nodes {Node[,Node...]}
Specifies a list of target IBM Storage Scale nodes. The value can include any combination of node numbers, node number ranges, node names, IP addresses, or node classes.
stop
Specifies to check mmfsd status for a cluster node.
--accept
Accepts stopping nodes if the command detects that shutting down the specified nodes cause a harmful condition.
-N or --target-nodes {Node[,Node...]}
Specifies a list of target IBM Storage Scale nodes. The value can include any combination of node numbers, node number ranges, node names, IP addresses, or node classes.
-t or --unmount-timeout {Time}
Specifies the maximum time in seconds for the unmount command is given to complete.

Global flags

Use the following global flags with any scalectl command and subcommand:
--bearer
If true, reads the OIDC_TOKEN from the environment and sends it as the authorization bearer header for the request. Use this flag with the --url option.
--cert {Certificate}
Specifies the path to the client certificate file for authentication.
--debug {Filepath[="stderr"]}
Enables the debug logging for the current request. Accepts an absolute file path to store logs by using --debug=<file>. If no file path is specified, logs are sent to stderr.
-h or --help
Lists the help for scalectl commands.
--domain {DomainName}
Sets the domain for the request. The default value is StorageScaleDomain.
--insecure-skip-tls-verify
If true, skips to verify the server certificate for validity. This option makes HTTPS connections insecure.
--json
Displays output in JSON format.
--key {PrivateKeyFile}
Specifies the path to the client certificate private key file for authentication.
--url {ip_address}
Sends the request over HTTPS to the specified endpoint <FQDN/IP>:<port>. For IPv6 address, use square brackets. For example, [IPv6]:<port>. If no port specified, 46443 is used by default.

Exit status

0
Successful completion.
nonzero
A failure occurred.

Security

You must have the specific role-based access control (RBAC) permission to run the command. For more information, see Role-based access control.

Examples

  1. To add a node to the local cluster, issue the following command: 
    scalectl node add -N mos-remote-4 --accept --licenseType server --nodeComment "Server Node" --nodeDesignations manager
    A sample output is as follows:
    Node add: Command successfully completed
  2. To start all nodes, issue the following command: 
    scalectl node start -N all
    A sample output is as follows:
    Node Start: Command successfully completed
  3. To get the status of all nodes, issue the following command: 
    scalectl node status -N all
    A sample output is as follows:
    node number | admin node name | status | reason
================================================
  1           | mos-dev-2       | active |
  2           | mos-remote-4    | active |
  4. To stop all nodes, issue the following command: 
    scalectl node stop -N all
    A sample output is as follows:
    Node Stop: Command successfully completed

See also

Location

/usr/lpp/mmfs/bin