scalectl config command

Manage the configuration settings for the administration daemon (scaleadmd) and mmfsd daemon.

Synopsis

scalectl config admin  {get {AttributeName} [--running]| list [-n {MaxItemNumber}] [-x] [-p {PageSize}] [-t {PageToken}] [--running]| update [-a {AttributeName=Value[,AttributeName=Value]}] [-i] [-c {NodeClass[,NodeClass...]}] [-p] [-N {Node[,Node...]}]}
Or 
scalectl config cluster {get {AtttributeName} [--running] | list [-n {MaxItemNumber}] [-x] [-p {PageSize}] [-t {PageToken}] [--running] [-view {nsd-raid | trace | mmhealth | default | all | am}] | update [-a {AttributeName=Value[,AttributeName=Value]}] [-i] [-c {NodeClass[,NodeClass...]}] [-p] [-N {Node[,Node...]}]}

Availability

Available on all IBM Storage Scale editions.

Description

Use the scalectl config command to query and update a cluster configuration. This cluster configuration includes the following areas:
  • scalectl config admin: Configuration options for the adminstration daemon for IBM Storage Scale native REST API.
  • scalectl config cluster: Classic IBM Storage Scale configuration options that were previously managed by mmchconfig and mmlsconfig commands.
You can modify configuration attributes to take effect on the next restart of the IBM Storage Scale cluster. Sometimes, the changes are applied immediately. Also, you can use this command to assign settings as a global or common value. In some cases, you can assign attributes to specific nodes in the cluster or to a node class.

Parameters

admin
Specifies the cluster configuration for administration daemon.
get {AttributeName}
Retrieves an administration daemon configuration value. To run this command, you must have the RBAC permission for the get action on the /scalemgmt/v3/config/admin/{name} resource.
–-running
Displays the configuration value that is running on the node.
list
List the current configuration data for the administration daemon that is stored on a disk. To run this command, you must have the RBAC permission for the get action on the /scalemgmt/v3/config/admin resource.
-n or --max-items {MaxItemNumber}
Specifies the maximum number of items to list at a time.
-x or --no-pagination
Disables pagination tokens on the client side.
-p or --page-size {PageSize}
Specifies the number of items to list per API request.
-t or --page-token {PageToken}
Specifies the page token that is received from previous file system list command. You can provide this page token to retrieve the next page.
–-running
Displays the configuration values that are running on the node.
update
Updates the configuration value of an administration daemon.
-a or --attribute {AttributeName=Value[,AttributeName=Value]}
Specifies the name of the attribute to be changed and its associated value. More than one attribute and value pair can be specified. This command supports a special value, DEFAULT, which restores the default setting in the administration daemon for an attribute.
-i or --immediate
If specified, the change takes effect immediately.
-c or --node-classes {NodeClass[,NodeClass...]}
Specifies to list of IBM Storage Scale node classes.
-p or --permanent
If specified, the change is persistent across the administration daemon restart.
-N or --target-nodes {Node[,Node...]}
Specifies the list of target IBM Storage Scale nodes.
cluster
Specifies the cluster configuration for an IO daemon.
get {Atttribute}
Retrieves the configuration value for an administration daemon. The value might be set on a single node, a set of nodes, or globally for the entire cluster. To run this command, you must have the RBAC permission for the get action on the /scalemgmt/v3/config/cluster/{name} resource.
–-running
Displays the configuration value that is running on the node.
list
Lists the current configuration data for the administration daemon that is stored on a disk. The value might be set on a single node, a set of nodes, or globally for the entire cluster. To run this command, you must have the RBAC permission for the get action on the /scalemgmt/v3/config/cluster resource.
-n or --max-items {MaxItemNumber}
Specifies the maximum number of items to list at a time.
-x or --no-pagination
Disables pagination tokens on the client side.
-p or --page-size {PageSize}
Specifies the number of items to list per API request.
-t or --page-token {PageToken}
Specifies the page token that is received from previous file system list command. You can provide this page token to retrieve the next page.
-v or --view {nsd-raid | trace | mmhealth | default | all | am}
Specifies the view for configuration content. The possible values are nsd-raid, trace, mmhealth, default, all, am. The default value is default.
–-running
Displays the configuration values that are running on the node.
update
Updates a configuration value of an administration daemon.
-a, --attribute {AttributeName=Value[,AttributeName=Value]}
Specifies the name of the attribute to be changed and its associated value. More than one attribute and value pair can be specified. This command supports the following special values:
DEFAULT
Restores the GPFS default setting for an attribute.
DELETE
Removes the specified attribute from the GPFS configuration file.

If -N is not specified (or -N all), the DELETE value is equivalent to the DEFAULT value.

-i or --immediate
If specified, the change takes effect immediately.
-c or --node-classes {NodeClass[,NodeClass...]}
Specifies to list of IBM Storage Scale node classes.
-p or --permanent
If specified, the change is persistent across GPFS restart.
-N or --target-nodes {Node[,Node...]}
Specifies the list of target IBM Storage Scale nodes.

Global flags

The following global flags can be used 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.
--version
Specifies the scalectl build information.

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 the configuration value, issue the following command: 
    scalectl config admin get log.level
    A sample output is as follows:
    |================|=======|=======|
| Attribute Name | Value | Nodes |
|================|=======|=======|
| log.level | info | |
|================|=======|=======|
  2. To update the configuration value, issue the following command: 
    scalectl config cluster update -p -a afmAsyncDelay=20
    A sample output is as follows:
      Node Name | Attribute     | Value | Status   
============================================
            | afmAsyncDelay | 20    | changed

See also

Location

/usr/lpp/mmfs/bin