scalectl nodeclass command

Creates and manages user-defined node classes.

Synopsis

scalectl nodeclass  create [-m {Node[,Node...]}] [-n {NodeClassName}] [-s {Subclass[,Subclass...]}]
scalectl nodeclass  delete {NodeClassName}
scalectl nodeclass  get {NodeClassName} [--fields {FieldName}]
scalectl nodeclass  list [--fields {FieldName}] [-n {MaxItemNumber}] [-x {PageSize}] [-p {PageSize}] [-t {PageToken}]
scalectl nodeclass  update [-m {Node[,Node...]}] [-s {Subclass[,Subclass...]]

Availability

Available on all IBM Storage Scale editions.

Description

Use the scalectl nodeclass command to create user-defined node classes. After a node class is created, it can be specified as an argument on commands that accept the -N NodeClass option.

Parameters

create
Creates a node class.
-m or --members {Node[,Node...]}
Specifies the members of the node class.
-n or --name {NodeClassName}
Specified the name of the node class.
-s or --subclasses {Subclass[,Subclass...]
Specifies the subclasses of the node class.
delete {NodeClassName}
Deletes an existing node class.
get {NodeClassName}
Gets the members of a node class.
--fields {FieldName}
Filters output to display only the specified field names.
list
Lists all node classes that are registered to the cluster.
--fields {FieldName}
Filters output to display only the specified field names.
-n or --max-items {MaxItemNumber}
Specifies the maximum number of items to list at a time.
-x or --no-pagination
Specifies to disable subsequent pagination tokens on the client side.
-p or --page-size {PageSize}
Specifies the number of items to list per request to the API.
-t or --page-token {PageToken}
Specifies the page token that is received from previous list command. You can provide this page token to retrieve the next page.
update
Updates a node class. Rewrites all members or subclasses of the specified node class.
-m or --members {Node[,Node...]}
Specifies the members of the node class.
-s or --subclasses {Subclass[,SubClass...]
Specifies the subclasses of the node class.

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 list all node classes that are registered with the cluster, issue the following command: 
    scalectl nodeclass list
    A sample output is as follows:
      Node Class        | Members                                                                                                                                 | Sub Classes  
===========================================================================================================================================================================
  GUI_MGMT_SERVERS  | ansibleCluster2276-1.fyre.ibm.com                                                                                                       |              
  GUI_SERVERS       | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  aixNodes          |                                                                                                                                         |              
  all               | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  cesNodes          |                                                                                                                                         |              
  clientLicense     |                                                                                                                                         |              
  clientNodes       |                                                                                                                                         |              
  cnfsNodes         |                                                                                                                                         |              
  disabledCnfsNodes |                                                                                                                                         |              
  enabledCnfsNodes  |                                                                                                                                         |              
  linuxNodes        | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  managerNodes      | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  nonAixNodes       | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  nonCesNodes       | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  nonCnfsNodes      | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  nonLinuxNodes     |                                                                                                                                         |              
  nonNsdNodes       | ansibleCluster2276-1.fyre.ibm.com                                                                                                       |              
  nonQuorumNodes    |                                                                                                                                         |              
  nonWindowsNodes   | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  nsdNodes          | ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com                                   |              
  quorumNodes       | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  serverLicense     | ansibleCluster2276-1.fyre.ibm.com,ansibleCluster2276-2.fyre.ibm.com,ansibleCluster2276-3.fyre.ibm.com,ansibleCluster2276-4.fyre.ibm.com |              
  windowsNodes      |                                                                                                                                         |
  2. To get the details of a node class, issue the following command: 
    scalectl nodeclass get GUI_MGMT_SERVERS
    A sample output is as follows:
      Node Class       | Members                           | Sub Classes  
====================================================================
  GUI_MGMT_SERVERS | ansibleCluster2276-1.fyre.ibm.com |

See also

Location

/usr/lpp/mmfs/bin