Swarm Cluster Services (SCS) CLI Commands
- 1 scsctl
- 1.1 Usage
- 2 scsctl <component>
- 2.1 Usage
- 3 scsctl <component> Add
- 3.1 Usage
- 4 scsctl <component> Configuration
- 4.1 Usage
- 5 scsctl <component> Configuration File
- 5.1 Usage
- 6 scsctl <component> Configuration File List
- 6.1 Usage
- 7 scsctl <component> Configuration File Set
- 7.1 Usage
- 8 scsctl <component> Configuration File Show
- 8.1 Usage
- 9 scsctl <component> Configuration File Unset
- 9.1 Usage
- 10 scsctl <component> Configuration List
- 10.1 Usage
- 11 scsctl <component> Configuration Set
- 11.1 Usage
- 12 scsctl <component> Configuration Show
- 12.1 Usage
- 13 scsctl <component> Configuration Unset
- 13.1 Usage
- 14 scsctl <component> Group
- 14.1 Usage
- 15 scsctl <component> Group Add
- 15.1 Usage
- 16 scsctl <component> Group List
- 16.1 Usage
- 17 scsctl <component> Group Makedefault
- 17.1 Usage
- 18 scsctl <component> Group Remove
- 18.1 Usage
- 19 scsctl <component> Group Show
- 19.1 Usage
- 20 scsctl <component> Group Update
- 20.1 Usage
- 21 scsctl <component> Instance
- 21.1 Usage
- 22 scsctl <component> Instance List
- 22.1 Usage
- 23 scsctl <component> Instance Remove
- 23.1 Usage
- 24 scsctl <component> Instance Show
- 24.1 Usage
- 25 scsctl <component> List
- 25.1 Usage
- 26 scsctl <component> Show
- 26.1 Usage
- 27 scsctl <component> Software
- 27.1 Usage
- 28 scsctl <component> Software Activate
- 28.1 Usage
- 29 scsctl <component> Software List
- 29.1 Usage
- 30 scsctl <component> Software Show
- 30.1 Usage
- 31 scsctl Auth
- 31.1 Usage
- 32 scsctl Auth Login
- 32.1 Usage
- 33 scsctl Auth Logout
- 33.1 Usage
- 34 scsctl Backup
- 34.1 Usage
- 35 scsctl Backup Create
- 35.1 Usage
- 36 scsctl Backup Restore
- 36.1 Usage
- 37 scsctl Diagnostics
- 37.1 Usage
- 38 scsctl Diagnostics Configuration
- 38.1 Usage
- 39 scsctl Diagnostics Configuration scan_missing
- 39.1 Usage
- 40 scsctl init
- 40.1 Usage
- 41 scsctl init Configs
- 41.1 Usage
- 42 scsctl init dhcp
- 42.1 Usage
- 43 scsctl init Wizard
- 43.1 Usage
- 44 scsctl License
- 44.1 Usage
- 45 scsctl License Add
- 45.1 Usage
- 46 scsctl License Show
- 46.1 Usage
- 47 scsctl repo
- 47.1 Usage
- 48 scsctl repo Component
- 48.1 Usage
- 49 scsctl repo Component Add
- 49.1 Usage
- 50 scsctl repo Component Build
- 50.1 Usage
- 51 scsctl repo Component Delete
- 51.1 Usage
- 52 scsctl repo Component List
- 52.1 Usage
- 53 scsctl repo Component Reload
- 53.1 Usage
- 54 scsctl repo Third-Party
- 54.1 Usage
- 55 scsctl repo Third-Party Add
- 55.1 Usage
- 56 scsctl repo Third-Party Delete
- 56.1 Usage
- 57 scsctl repo Third-Party List
- 57.1 Usage
- 58 scsctl System
- 58.1 Usage
- 59 scsctl System Reset
- 59.1 Usage
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 |
|
|---|---|
Chassis |
|
Software |
|
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 advanced detail about the state of
the added instance will be shown (default behavior is
to just show the ID). (default: False)
-g GROUP_NAME, --group GROUP_NAME
The name of the group to which the instance will be
added. (default: _default)
-d, --default-group If specified, then the instance will be added to the
default group. (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 <component> add DUMMY help'
options:scsctl <component> Configuration
Manage configuration for this component.
Usage
scsctl <component> Configuration File
Manages component configuration files.
Usage
scsctl <component> Configuration File List
Lists configuration files for the current component.
Usage
scsctl <component> Configuration File Set
Updates a configuration file for the current component.
Usage
scsctl <component> Configuration File Show
Shows a configuration file for the current component.
Usage
scsctl <component> Configuration File Unset
Removes a customized configuration file for the current component.
Usage
scsctl <component> Configuration List
Lists configuration settings for the current component.
Usage
scsctl <component> Configuration Set
Updates a configuration setting for the current component.
Usage
scsctl <component> Configuration Show
Displays a configuration setting for the current component.
Usage
scsctl <component> Configuration Unset
Removes a previously-set configuration setting value of the given component.
Usage
scsctl <component> Group
Manage groups within this component.
Usage
scsctl <component> Group Add
Adds a group to the given component.
Usage
scsctl <component> Group List
Lists groups of the given component.
Usage
scsctl <component> Group Makedefault
Marks a group as the default group in the given component.
Usage
scsctl <component> Group Remove
Removes a group from the given component.
Usage
scsctl <component> Group Show
Displays information about a group of the given component.
Usage
scsctl <component> Group Update
Updates a group in the given component.
Usage
scsctl <component> Instance
Manage instances of this component.
Usage
scsctl <component> Instance List
Lists instances of the given component.
Usage
scsctl <component> Instance Remove
Removes an instance of the given component.
Usage
scsctl <component> Instance Show
Displays information about an instance of the given component.
Usage
scsctl <component> List
Shorthand for component "instance list".
Usage
scsctl <component> Show
Display this component's details.
Usage
scsctl <component> Software
Manage software for this component.
Usage
scsctl <component> Software Activate
Activates an installed version of a component in the Swarm ecosystem.
Usage
scsctl <component> Software List
Lists installed software versions for a component in the Swarm ecosystem.
Usage
scsctl <component> Software Show
Displays software information for an installed version of the component.
Usage
scsctl Auth
Manages persisted credentials for contacting the SCS API.
Usage
scsctl Auth Login
Stores new credentials for contacting the SCS API.
Usage
scsctl Auth Logout
Clears previously-stored credentials for contacting the SCS API.
Usage
scsctl Backup
Manages backing up and restoring the SCS service.
Usage
scsctl Backup Create
Performs a backup of the SCS service.
Usage
scsctl Backup Restore
Performs a restore of the SCS service from a backup file.
Usage
scsctl Diagnostics
Performs diagnostics on the SCS server setup.
Usage
scsctl Diagnostics Configuration
Checks configuration across the ecosystem.
Usage
scsctl Diagnostics Configuration scan_missing
Checks for missing configuration values.
Usage
scsctl init
Utilities for setting up a Swarm environment.
Usage
scsctl init Configs
Performs an import of config values for multiple components into the default group for each. Each component's config values are in a file for that component, with the component name as the base ("your_component.cfg", "your_component.json", etc.)
Usage
scsctl init dhcp
Configures on-box DHCP service for use with SCS.
Usage
scsctl init Wizard
Walks the user through the init process to get the environment set up.
Usage
scsctl License
Manages the license for this Swarm ecosystem installation.
Usage
scsctl License Add
Installs a new Swarm license into the SCS service.
Usage
scsctl License Show
Displays the license installed in the SCS service.
Usage
scsctl repo
Manages the SCS repository. The repository contains installed component versions and other third-party software.
Usage
scsctl repo Component
Manages component installations within the SCS repository.
Usage
scsctl repo Component Add
Adds a component version to the SCS repository.
Usage
scsctl repo Component Build
Builds a component bundle that can be imported into the SCS repository.
Usage
scsctl repo Component Delete
Removes a component version from the SCS repository.
Usage
scsctl repo Component List
Lists installed component versions within the SCS repository. The default view is a compact listing of active and inactive components.
Usage
scsctl repo Component Reload
Reloads the on-disk component registry.
Usage
scsctl repo Third-Party
Manages third-party software installations within the SCS repository.
Usage
scsctl repo Third-Party Add
Adds third-party software to the SCS repository.
Usage
scsctl repo Third-Party Delete
Removes third-party software from the SCS repository.
Usage
scsctl repo Third-Party List
Lists installed third-party software within the SCS repository.
Usage
scsctl System
Performs administrative operations on the system.
Usage
scsctl System Reset
Warning
This action completely resets all post-installation changes to the SCS server!
Usage
© DataCore Software Corporation. · https://www.datacore.com · All rights reserved.