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 batchAdd [--file {FilePath}] [--accept-all]
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.

batchAdd
Adds one or more IBM Storage Scale node to the local cluster.
--accept-all
Accepts the terms of the applicable license agreement for all nodes. This parameter is required only when a license type is used on any of the specified nodes. It is ignored if no nodes specify a license type.
-F or --file {FilePath}
Specifies the file path to a JSON formatted or classic node descriptor formatted file. This file must contain the list of nodes and node designations to be added to the IBM Storage Scale cluster.
Note:
  • The format of a node descriptor file is identical to the format that is used by the mmaddnode command. The same files can be used with both the scalectl command and the classic mmaddnode command.
  • Use the .json file extension for JSON input files and the .nd file extension for node descriptor input files to identify the input type.
Node descriptors are defined as:
NodeName:NodeDesignations:AdminNodeName:LicenseType:NodeComment
where:
NodeName
Specifies the host name or IP address of the node for GPFS daemon-to-daemon communication.
The host name or IP address must refer to the communication adapter over which the GPFS daemons communicate. Aliased interfaces are not allowed. Use the original address or a name that is resolved by the host command to that original address. You can specify a node using any of these forms:
  • Short host name (for example, h135n01)
  • Long, fully qualified, host name (for example, h135n01.ibm.com)
  • IP address (for example, 7.111.12.102). IPv6 addresses must be enclosed in brackets (for example, [2001:192::192:168:115:124]).

Regardless of which form you use, GPFS will resolve the input to a host name and an IP address and will store these in its configuration files. It is expected that those values will not change while the node belongs to the cluster.

NodeDesignations
An optional, "-" separated list of node roles:
  • manager | client – Indicates whether a node is part of the node pool from which file system managers and token managers can be selected. The default is client.
  • quorum | nonquorum – Indicates whether a node is counted as a quorum node. The default is nonquorum.
    Note: If you are designating a new node as a quorum node, and adminMode central is in effect for the cluster, GPFS must be down on all nodes in the cluster. Alternatively, you may choose to add the new nodes as nonquorum and once GPFS has been successfully started on the new nodes, you can change their designation to quorum using the mmchnode command.
AdminNodeName
Specifies an optional field that consists of a node interface name to be used by the administration commands to communicate between nodes. If AdminNodeName is not specified, the NodeName value is used.
Note: AdminNodeName must be a resolvable network host name. For more information, see GPFS node adapter interface names.
LicenseType
Assigns a license of the specified type to the node. Valid values are server and client. For information about these license types, see mmchlicense command.

The full text of the Licensing Agreement is provided with the installation media and can be found at the IBM® Software license agreements website (www.ibm.com/software/sla/sladb.nsf).

NodeComment
Specifies an optional field that provides additional information on the node. The comment field might also be included in the NodeFile file as a parameter.
Note:
  • Comments can only contain the following characters:
    0-9 A-Z a-z (space) # - . @ _
  • While running a command with the -N option or using a NodeFile attribute to provide multiple node descriptors, all comments that include one or more spaces must be enclosed within single quotation marks (') or double quotation marks ("). You must always use quotation marks with comments to avoid possible parsing errors.
  • Comments must not begin with a -.
  • Comments cannot be longer than 32 characters.
  • Comments that include spaces at the beginning or end will have the spaces trimmed.

The comment field adds new data that is stored in the cluster configuration file and is available only to nodes running on IBM Storage Scale 5.1.4 or later for reading and configuring.

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.
  • When you use -i (--grpc-interface) or -I (--rest-interface), specify the IP address of the administrative network interface only.
  • When you change -p (--grpc-port), configure the same port value on all nodes in the cluster. Updating this setting restarts only the local administration daemon services on the node.
-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.
--user-cert {Certificate}
Specifies the path to the client certificate file for authentication.
--user-cacert {CA_Certificate}
Specifies the path to the certificate authority (CA) trust chain to validate a server certificate.
--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.
Note: When you use the --json flag with an endpoint method that is a long-running operation (LRO), the LRO is submitted to the LRO manager, which handles its lifecycle. The lifecycle includes accepting, running, and monitoring operations. Although the command request returns quickly, you must ensure that the submitted operation reaches a Done state. Review any metadata that is associated with the request to ensure that it completed successfully. This step is especially important for endpoint methods that have follow-on methods. These follow-on methods are valid only if the initial method completed successfully. For more information about LRO, see Long-running operations.
--user-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.
--version
Specifies the scalectl build information. The --version flag is valid only with the top-level scalectl command.

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 --license-type server --node-comment "Server Node" --node-designations 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