scalectl command

IBM Storage Scale native REST API includes a new scalectl command-line interface (CLI) to communicate with the IBM Storage Scale control plane. The scalectl command uses the scalectl <resource> <verb> <args> <flags> command structure to invoke the command. Each command and subcommand includes a --help flag that provides details about the command, available flags, and example invocations.

By default, the scalectl CLI attempts to communicate with the unix domain socket (UDS) that is available on a node where IBM Storage Scale is installed and running. Since scalectl is a lightweight client that calls the IBM Storage Scale native REST API, it also supports communication over TCP/IP by using the --url global flag. The same command-line arguments and flags apply, regardless of the communication method.

When scalectl processes long-running operations (LROs), it polls the returned operation name until the request is complete, if the request is not completed immediately. This behavior can have role-based access control (RBAC) implications. For an LRO, users might require permissions to query LROs in addition to the permissions to create the resource. These permissions are necessary for scalectl to retrieve the final output during the polling phase. If a user does not have the required RBAC permissions to query LROs, scalectl returns a PERMISSION_DENIED error. This error indicates that the user does not have the necessary permissions on the /scalemgmt/v3/operations/ resource. For more information about the role-based access control, see Role-based access control.