/
Swarm Cluster Services (SCS) CLI Commands

Swarm Cluster Services (SCS) CLI Commands

Owned by Mary Connor (Deactivated)
Last updated: Jan 08, 2024 by Bala Harish A(AC)
47 min read

The SCS configures and manages Swarm storage clusters. This command-line interface helps automate hardware management tasks by enabling script common, high-level management tasks around cluster and node deployment:

Cluster

  • Create a storage cluster

  • Read a storage cluster's settings

  • Update a storage cluster's settings

Chassis

  • Add a chassis to the cluster

  • Read a chassis' settings

  • Update a chassis' settings

Software

  • Upgrade a storage cluster's software

  • Add or update a storage license

  • Update the storage cluster configuration, such as the location of Syslog and NTP servers 

SCS command-line interface (CLI) is a set of Python 3 modules; these modules follow a naming convention allowing dynamic discovery, which is then parsed for subcommands. This enables help at any level to learn how to build a command.

CLI Command - The command for the CLI is "scsctl", and subcommands are listed in order after. To view settings, a command like "scsctl settings view" is used (with arguments as needed). 

API Interaction - The CLI uses the SCS API directly as a client. Use the CLI as a set of examples for integrating with the SCS API.

Component Settings - Most setting definitions have a default value. For those depending on an environment, the CLI prompts for a value. For secure settings (such as passwords), the CLI does not echo an entry.

scsctl

Provides basic control and visibility in to the SCS service.

Usage

usage: scsctl [-v | --info-log | --debug-log | --trace-log] [--user USER | --token TOKEN] options: ... Provides basic control and visibility into the Platform service. optional arguments: --user USER User name and (optionally) password. If password is included, then this must be in the form "{user_name}:{password}" (default: None) --token TOKEN Authentication token. (default: None) output options: These options affect the way output is displayed. -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output is always sent to stdout. (default: None) --info-log Set info-level verbosity (equivalent to -v). (default: None) --debug-log Set debug-level verbosity (equivalent to -vv). (default: None) --trace-log Set trace-level verbosity (equivalent to -vvv). (default: None) subcommands: Which action you wish to perform. To get detailed help, add 'help' to the end. For example: 'scsctl auth help' options: auth Manages persisted credentials for contacting the Platform API. backup Manages backing up and restoring the Platform service. diagnostics Performs diagnostics on the Platform server setup. init Utilities for setting up a Swarm environment. license Manages the license for this Swarm ecosystem installation. repo Manages the Platform repository. The repository contains installed component versions and other third-party software. system Performs administrative operations on the system. <component> Manage the "<component>" component.

scsctl <component>

Manages a component in the Swarm ecosystem.

Usage

usage: scsctl <component> [-v | --info-log | --debug-log | --trace-log] [--user USER | --token TOKEN] [--version VERSION] [-b] [--pretty] options: ... Manage the "<component>" component. optional arguments: --user USER User name and (optionally) password. If password is included, then this must be in the form "{user_name}:{password}" (default: None) --token TOKEN Authentication token. (default: None) --version VERSION A specific installed version to view. (default: None) -b, --brief If present, will display component details in compact mode. (default: True) output options: These options affect the way output is displayed. -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output is always sent to stdout. (default: None) --info-log Set info-level verbosity (equivalent to -v). (default: None) --debug-log Set debug-level verbosity (equivalent to -vv). (default: None) --trace-log Set trace-level verbosity (equivalent to -vvv). (default: None) --pretty If specified, will format output to be more human- friendly. (default: False) subcommands: Which action you wish to perform. To get detailed help, add 'help' to the end. For example: 'scsctl <component> add help' options: add Shorthand for component "instance add". config Manage configuration for this component. group Manage groups within this component. instance Manage instances of this component. list Shorthand for component "instance list". show Display this component's details. software Manage software for this component.

scsctl <component> Add

Shorthand for component "instance add".

Usage

usage: scsctl <component> add [-v | --info-log | --debug-log | --trace-log] [--user USER | --token TOKEN] [--show-detail] (-g GROUP_NAME | -d) options: ... name Shorthand for component "instance add". positional arguments: name The name of the instance. optional arguments: --user USER User name and (optionally) password. If password is included, then this must be in the form "{user_name}:{password}" (default: None) --token TOKEN Authentication token. (default: None) --show-detail If specified, then advan