/
Swarm Cluster Services (SCS) CLI Commands
Swarm Cluster Services (SCS) CLI Commands
- Mary Connor (Deactivated)
- Bala Harish A(AC)
- Rumena Zlatkova (Deactivated)
Owned by Mary Connor (Deactivated)
- 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
usage: scsctl <component> config [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d] [-i INSTANCE] [-a]
[--pretty]
options: ...
Manage configuration for this 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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group for which to list. (default:
None)
-d, --default-group If specified, then the default group will be used for
listing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance for which to list.
(default: None)
-a, --include-advanced
If provided, then advanced settings will be included
in the listing. (default: False)
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> config file help'
options:
file Manages component configuration files.
list Lists configuration settings for the current
component.
set Updates a configuration setting for the current
component.
show Displays a configuration setting for the current
component.
unset Removes a previously-set configuration setting value
of the given component.scsctl <component> Configuration File
Manages component configuration files.
Usage
usage: scsctl <component> config file
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d] [-i INSTANCE]
options: ...
Manages component configuration files.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group for which to list. (default:
None)
-d, --default-group If specified, then the default group will be used for
listing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance for which to list.
(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> config file list help'
options:
list Lists configuration files for the current component.
set Updates a configuration file for the current
component.
show Shows a configuration file for the current component.
unset Removes a customized configuration file for the
current component.scsctl <component> Configuration File List
Lists configuration files for the current component.
Usage
usage: scsctl <component> config file list
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d] [-i INSTANCE]
options: ...
Lists configuration files for the current 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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group for which to list. (default:
None)
-d, --default-group If specified, then the default group will be used for
listing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance for which to list.
(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> config file list DUMMY help'
options:scsctl <component> Configuration File Set
Updates a configuration file for the current component.
Usage
usage: scsctl <component> config file set
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-g GROUP_NAME | -d) [-i INSTANCE]
(-f FILE | -u URL)
options: ... name
Updates a configuration file for the current component.
positional arguments:
name The name of the configuration file to update.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group where the update should occur.
(default: None)
-d, --default-group If specified, then the default group will be used for
the update. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance where the update should
occur. (default: None)
-f FILE, --file FILE Path to config file to use for the update, or '-' to
read from stdin. (default: None)
-u URL, --url URL URL of config file to use for the update. (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> config file set DUMMY help'
options:scsctl <component> Configuration File Show
Shows a configuration file for the current component.
Usage
usage: scsctl <component> config file show
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d] [-i INSTANCE]
[-r]
options: ... name
Shows a configuration file for the current component.
positional arguments:
name The name of the configuration file to show.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group for which to show. (default:
None)
-d, --default-group If specified, then the default group will be used for
showing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance for which to show.
(default: None)
-r, --raw Whether or not to show the raw (un-rendered)
configuration file. Only applies if "instance" is
specified. (default: False)
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> config file show DUMMY help'
options:scsctl <component> Configuration File Unset
Removes a customized configuration file for the current component.
Usage
usage: scsctl <component> config file unset
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-g GROUP_NAME | -d) [-i INSTANCE]
options: ... name
Removes a customized configuration file for the current component.
positional arguments:
name The name of the customized configuration file to
remove.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group where the removal should occur.
(default: None)
-d, --default-group If specified, then the default group will be used for
removing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance where the removal
should occur. (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> config file unset DUMMY help'
options:scsctl <component> Configuration List
Lists configuration settings for the current component.
Usage
usage: scsctl <component> config list
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d] [-i INSTANCE] [-a]
[--pretty]
options: ...
Lists configuration settings for the current 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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group for which to list. (default:
None)
-d, --default-group If specified, then the default group will be used for
listing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance for which to list.
(default: None)
-a, --include-advanced
If provided, then advanced settings will be included
in the listing. (default: False)
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> config list DUMMY help'
options:scsctl <component> Configuration Set
Updates a configuration setting for the current component.
Usage
usage: scsctl <component> config set
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-g GROUP_NAME | -d) [-i INSTANCE]
[-f FILE] [-u URL]
options: ... [setting_assignment]
Updates a configuration setting for the current component.
positional arguments:
setting_assignment A setting assignment in the form of:
setting_name=new_value (default: None)
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group where the update should occur.
(default: None)
-d, --default-group If specified, then the default group will be used for
updating. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance where the update should
occur. (default: None)
-f FILE, --file FILE Path to JSON file with object of name/value pairs to
use for the update, or '-' to read from stdin.
(default: None)
-u URL, --url URL URL of JSON file with object of name/value pairs to
use for the update. (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> config set DUMMY help'
options:scsctl <component> Configuration Show
Displays a configuration setting for the current component.
Usage
usage: scsctl <component> config show
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d] [-i INSTANCE]
[--show-detail] [--pretty]
options: ... name
Displays a configuration setting for the current component.
positional arguments:
name The name of the configuration setting to show.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group for which to show. (default:
None)
-d, --default-group If specified, then the default group will be used for
showing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance for which to show.
(default: None)
--show-detail If specified, then advanced detail about the state of
the configuration setting will be shown (default
behavior is to just show the value). (default: False)
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> config show DUMMY help'
options:scsctl <component> Configuration Unset
Removes a previously-set configuration setting value of the given component.
Usage
usage: scsctl <component> config unset
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-g GROUP_NAME | -d) [-i INSTANCE]
options: ... name
Removes a previously-set configuration setting value of the given component.
positional arguments:
name The name of the configuration setting to un-set.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group for which to un-set. (default:
None)
-d, --default-group If specified, then the default group will be used for
removing. (default: None)
-i INSTANCE, --instance INSTANCE
The name or ID of the instance for which to un-set.
(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> config unset DUMMY help'
options:scsctl <component> Group
Manage groups within this component.
Usage
usage: scsctl <component> group [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[--no-default-marker] [--pretty]
options: ...
Manage groups within this 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)
--no-default-marker If specified, hides the marker designating which group
is the default. (default: False)
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> group add help'
options:
add Adds a group to the given component.
list Lists groups of the given component.
makedefault Marks a group as the default group in the given
component.
remove Removes a group from the given component.
show Displays information about a group of the given
component.
update Updates a group in the given component.scsctl <component> Group Add
Adds a group to the given component.
Usage
usage: scsctl <component> group add
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-d DESCRIPTION] [--make-default]
options: ... name
Adds a group to the given component.
positional arguments:
name The name of the group to be added.
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)
-d DESCRIPTION, --description DESCRIPTION
A description of the cluster (purpose, location, etc.)
(default: )
--make-default If given, then the newly added group will be marked as
the default. Note that if this is the first group in
the component it will automatically be marked as
default. (default: False)
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> group add DUMMY help'
options:scsctl <component> Group List
Lists groups of the given component.
Usage
usage: scsctl <component> group list
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[--no-default-marker] [--pretty]
options: ...
Lists groups of the given 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)
--no-default-marker If specified, hides the marker designating which group
is the default. (default: False)
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> group list DUMMY help'
options:scsctl <component> Group Makedefault
Marks a group as the default group in the given component.
Usage
usage: scsctl <component> group makedefault
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
options: ... name
Marks a group as the default group in the given component.
positional arguments:
name The name of the group to be marked as default.
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 <component> group makedefault DUMMY help'
options:scsctl <component> Group Remove
Removes a group from the given component.
Usage
usage: scsctl <component> group remove
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--force]
[-y]
options: ... name
Removes a group from the given component.
positional arguments:
name The name of the group to remove.
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)
--force If set, forces the group to be removed even if it is marked
as the default group. (default: False)
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)
-y, --yes If specified, will bypass all confirmation prompts. (default:
False)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl <component> group remove DUMMY help'
options:scsctl <component> Group Show
Displays information about a group of the given component.
Usage
usage: scsctl <component> group show
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--pretty]
options: ... name
Displays information about a group of the given component.
positional arguments:
name The name of the group to show.
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)
--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> group show DUMMY help'
options:scsctl <component> Group Update
Updates a group in the given component.
Usage
usage: scsctl <component> group update
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-d DESCRIPTION]
options: ... name
Updates a group in the given component.
positional arguments:
name The name of the group to be updated.
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)
-d DESCRIPTION, --description DESCRIPTION
A description of the cluster (purpose, location, etc.)
(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> group update DUMMY help'
options:scsctl <component> Instance
Manage instances of this component.
Usage
usage: scsctl <component> instance
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d]
[-s {group,id,ip_address,name}] [--pretty]
options: ...
Manage instances of this 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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group to list. If missing, then all
instances in all groups will be listed. (default:
None)
-d, --default-group If specified, then the default group will be used for
listing. (default: None)
-s {group,id,ip_address,name}, --sort-by {group,id,ip_address,name}
The column to use for sorting. (default: name)
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> instance add help'
options:
list Lists instances of the given component.
remove Removes an instance of the given component.
show Displays information about an instance of the given
component.scsctl <component> Instance List
Lists instances of the given component.
Usage
usage: scsctl <component> instance list
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d]
[-s {group,id,ip_address,name}]
[--pretty]
options: ...
Lists instances of the given 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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group to list. If missing, then all
instances in all groups will be listed. (default:
None)
-d, --default-group If specified, then the default group will be used for
listing. (default: None)
-s {group,id,ip_address,name}, --sort-by {group,id,ip_address,name}
The column to use for sorting. (default: name)
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> instance list DUMMY help'
options:scsctl <component> Instance Remove
Removes an instance of the given component.
Usage
usage: scsctl <component> instance remove
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-g GROUP_NAME | -d)
options: ... instance
Removes an instance of the given component.
positional arguments:
instance The name or ID of the instance to remove.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group from which to remove. (default:
None)
-d, --default-group If specified, then the instance will be looked up
within 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> instance remove DUMMY help'
options:scsctl <component> Instance Show
Displays information about an instance of the given component.
Usage
usage: scsctl <component> instance show
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-g GROUP_NAME | -d) [--pretty]
options: ... instance
Displays information about an instance of the given component.
positional arguments:
instance The name or ID of the instance to show.
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group containing the instance.
(default: None)
-d, --default-group If specified, then the instance will be looked up
within 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)
--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> instance show DUMMY help'
options:scsctl <component> List
Shorthand for component "instance list".
Usage
usage: scsctl <component> list [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[-g GROUP_NAME | -d]
[-s {group,id,ip_address,name}] [--pretty]
options: ...
Shorthand for component "instance list".
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)
-g GROUP_NAME, --group GROUP_NAME
The name of the group to list. If missing, then all
instances in all groups will be listed. (default:
None)
-d, --default-group If specified, then the default group will be used for
listing. (default: None)
-s {group,id,ip_address,name}, --sort-by {group,id,ip_address,name}
The column to use for sorting. (default: group)
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> list DUMMY help'
options:scsctl <component> Show
Display this component's details.
Usage
usage: scsctl <component> show [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[--version VERSION] [-b] [--pretty]
options: ...
Display this component's details.
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: False)
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> show DUMMY help'
options:scsctl <component> Software
Manage software for this component.
Usage
usage: scsctl <component> software
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--pretty]
options: ...
Manage software for this 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)
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> software activate help'
options:
activate Activates an installed version of a component in the Swarm
ecosystem.
list Lists installed software versions for a component in the
Swarm ecosystem.
show Displays software information for an installed version of the
component.scsctl <component> Software Activate
Activates an installed version of a component in the Swarm ecosystem.
Usage
usage: scsctl <component> software activate
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
options: ... [version]
Activates an installed version of a component in the Swarm ecosystem.
positional arguments:
version The installed version to activate. Consult the list of
installed versions for valid values. (default: None)
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 <component> software activate DUMMY help'
options:scsctl <component> Software List
Lists installed software versions for a component in the Swarm ecosystem.
Usage
usage: scsctl <component> software list
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[--pretty]
options: ...
Lists installed software versions for a component in the Swarm ecosystem.
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)
--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> software list DUMMY help'
options:scsctl <component> Software Show
Displays software information for an installed version of the component.
Usage
usage: scsctl <component> software show
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[--pretty]
options: ... version
Displays software information for an installed version of the component.
positional arguments:
version The installed version to view.
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)
--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> software show DUMMY help'
options:scsctl Auth
Manages persisted credentials for contacting the SCS API.
Usage
usage: scsctl auth [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
options: ...
Manages persisted credentials for contacting the Platform API.
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 login help'
options:
login Stores new credentials for contacting the Platform API.
logout Clears previously-stored credentials for contacting the
Platform API.scsctl Auth Login
Stores new credentials for contacting the SCS API.
Usage
usage: scsctl auth login [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
options: ...
Stores new credentials for contacting the Platform API.
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 login DUMMY help'
options:scsctl Auth Logout
Clears previously-stored credentials for contacting the SCS API.
Usage
usage: scsctl auth logout [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
options: ...
Clears previously-stored credentials for contacting the Platform API.
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 logout DUMMY help'
options:scsctl Backup
Manages backing up and restoring the SCS service.
Usage
usage: scsctl backup [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--no-repo] [-o OUTPUT]
options: ...
Manages backing up and restoring 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)
--no-repo If specified, then repo data (binaries, etc.) will be
excluded from the backup. (default: False)
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)
-o OUTPUT, --output OUTPUT
Where to send the result of the command (non-verbose
output; default is stdout, same as specifying "-").
(default: -)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl backup create help'
options:
create Performs a backup of the Platform service.
restore Performs a restore of the Platform service from a
backup file.scsctl Backup Create
Performs a backup of the SCS service.
Usage
usage: scsctl backup create [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--no-repo]
[-o OUTPUT]
options: ...
Performs a backup of 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)
--no-repo If specified, then repo data (binaries, etc.) will be
excluded from the backup. (default: False)
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)
-o OUTPUT, --output OUTPUT
Where to send the result of the command (non-verbose
output; default is stdout, same as specifying "-").
(default: -)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl backup create DUMMY help'
options:scsctl Backup Restore
Performs a restore of the SCS service from a backup file.
Usage
usage: scsctl backup restore [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-o OUTPUT]
options: ... backup_file
Performs a restore of the Platform service from a backup file.
positional arguments:
backup_file Path to backup image to be restored.
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)
-o OUTPUT, --output OUTPUT
Where to send the result of the command (non-verbose
output; default is stdout, same as specifying "-").
(default: -)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl backup restore DUMMY help'
options:scsctl Diagnostics
Performs diagnostics on the SCS server setup.
Usage
usage: scsctl diagnostics [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--quick]
[--scan-only] [--pretty]
options: ...
Performs diagnostics on the Platform server setup.
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)
--quick Only performs a quick scan of potential configuration issues
(implies --scan-only). (default: False)
--scan-only Only performs a quick scan of potential configuration issues.
(default: False)
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 diagnostics config help'
options:
config Checks configuration across the ecosystem.scsctl Diagnostics Configuration
Checks configuration across the ecosystem.
Usage
usage: scsctl diagnostics config [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--quick]
[--scan-only] [--pretty]
options: ...
Checks configuration across the ecosystem.
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)
--quick Only performs a quick scan of potential configuration issues
(implies --scan-only). (default: False)
--scan-only Only performs a quick scan of potential configuration issues.
(default: False)
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 diagnostics config scan_missing help'
options:
scan_missing
Checks for missing configuration values.scsctl Diagnostics Configuration scan_missing
Checks for missing configuration values.
Usage
usage: scsctl diagnostics config scan_missing
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
[--quick] [--scan-only]
[--pretty]
options: ...
Checks for missing configuration values.
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)
--quick Only performs a quick scan of potential configuration issues
(implies --scan-only). (default: False)
--scan-only Only performs a quick scan of potential configuration issues.
(default: False)
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 diagnostics config scan_missing DUMMY help'
options:scsctl init
Utilities for setting up a Swarm environment.
Usage
usage: scsctl init [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--force] [--next-steps]
[--allow-all-system-updates]
[--details-path [DETAILS_PATH]]
options: ...
Utilities for setting up a Swarm environment.
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)
--force If set, forces wizard to restart the entire process.
(default: False)
--next-steps If specified, will only display the next steps to run
after this wizard and exit. (default: False)
--allow-all-system-updates
WARNING: Setting this will BYPASS ALL PROMPTS warning
of changes to the system! Use with caution. (default:
False)
--details-path [DETAILS_PATH]
If given, then all details of the init process will be
captured in the specified file. To disable, specify
this argument but do not provide a value. (default:
./init-details.log)
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 init configs help'
options:
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_coomponent.json", etc.)
dhcp Configures on-box DHCP service for use with Platform.
wizard Walks the user through the init process to get the
environment set up.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
usage: scsctl init configs [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-d DIRECTORY]
options: ...
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_coomponent.json", etc.)
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)
-d DIRECTORY, --directory DIRECTORY
Path to the directory where the files are stored.
(default: .)
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 init configs DUMMY help'
options:scsctl init dhcp
Configures on-box DHCP service for use with SCS.
Usage
usage: scsctl init dhcp [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] --dns-domain DNS_DOMAIN
--dns-servers DNS_SERVERS --ntp-servers NTP_SERVERS
[--dhcp-lease-default DHCP_LEASE_DEFAULT]
[--dhcp-lease-max DHCP_LEASE_MAX]
[--dhcp-reserve-lower DHCP_RESERVE_LOWER]
[--dhcp-reserve-upper DHCP_RESERVE_UPPER]
[--dhcp-transient-percent DHCP_TRANSIENT_PERCENT]
options: ...
Configures on-box DHCP service for use with Platform.
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 init dhcp DUMMY help'
options:
Related Services:
--dns-domain DNS_DOMAIN
DNS domain name (default: None)
--dns-servers DNS_SERVERS
DNS servers to be used, comma-delimited (default:
None)
--ntp-servers NTP_SERVERS
NTP servers to be used, comma-delimited (default:
None)
DHCP-specific Settings:
Specifies timeouts and pool ranges within the subnet. Note that at least
one of dhcp-reserve-lower or dhcp-reserve-upper MUST be set.
--dhcp-lease-default DHCP_LEASE_DEFAULT
Default DHCP lease time for storage nodes (default:
172800)
--dhcp-lease-max DHCP_LEASE_MAX
Maximum allowed DHCP lease time for storage nodes
(default: 604800)
--dhcp-reserve-lower DHCP_RESERVE_LOWER
Number of IP addresses to reserve in lower subnet
range (default: 0)
--dhcp-reserve-upper DHCP_RESERVE_UPPER
Number of IP addresses to reserve in upper subnet
range (default: 0)
--dhcp-transient-percent DHCP_TRANSIENT_PERCENT
Percentage of DHCP managed range for transient clients
(default: 50)scsctl init Wizard
Walks the user through the init process to get the environment set up.
Usage
usage: scsctl init wizard [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--force]
[--next-steps] [--allow-all-system-updates]
[--details-path [DETAILS_PATH]]
options: ...
Walks the user through the init process to get the environment set up.
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)
--force If set, forces wizard to restart the entire process.
(default: False)
--next-steps If specified, will only display the next steps to run
after this wizard and exit. (default: False)
--allow-all-system-updates
WARNING: Setting this will BYPASS ALL PROMPTS warning
of changes to the system! Use with caution. (default:
False)
--details-path [DETAILS_PATH]
If given, then all details of the init process will be
captured in the specified file. To disable, specify
this argument but do not provide a value. (default:
./init-details.log)
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 init wizard DUMMY help'
options:scsctl License
Manages the license for this Swarm ecosystem installation.
Usage
usage: scsctl license [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--pretty]
options: ...
Manages the license for this Swarm ecosystem installation.
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)
--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 license add help'
options:
add Installs a new Swarm license into the Platform service.
show Displays the license installed in the Platform service.scsctl License Add
Installs a new Swarm license into the SCS service.
Usage
usage: scsctl license add [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] (-f FILE | -u URL)
options: ...
Installs a new Swarm license 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)
-f FILE, --file FILE Path to license file to install, or '-' to read from
stdin. (default: None)
-u URL, --url URL URL of license file to install. (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 license add DUMMY help'
options:scsctl License Show
Displays the license installed in the SCS service.
Usage
usage: scsctl license show [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--pretty]
options: ...
Displays the license installed in 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)
--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 license show DUMMY help'
options:scsctl repo
Manages the SCS repository. The repository contains installed component versions and other third-party software.
Usage
usage: scsctl repo [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-t] [-c]
[-s {name,bytes,md5}] [--pretty]
options: ...
Manages the Platform repository. The repository contains installed component
versions and other third-party software.
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)
-t, --table If present, will list all installed component versions
in a tabular view (default is a compact view).
(default: False)
-c, --csv If present, will list in CSV format. (default: False)
-s {name,bytes,md5}, --sort-by {name,bytes,md5}
The column to use for sorting. (default: name)
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 repo component help'
options:
component Manages component installations within the Platform
repository.
thirdparty Manages third-party software installations within the
Platform repository.scsctl repo Component
Manages component installations within the SCS repository.
Usage
usage: scsctl repo component [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-t | -c]
[-s {name,is_active}] [--pretty]
options: ...
Manages component installations within the Platform repository.
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)
-t, --table If present, will list all installed component versions
in a tabular view (default is a compact view).
(default: False)
-c, --csv If present, will list all installed component versions
in CSV format. (default: False)
-s {name,is_active}, --sort-by {name,is_active}
The column to use for sorting (table and csv output
only). (default: name)
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 repo component add help'
options:
add Adds a component version to the Platform repository.
build Builds a component bundle that can be imported into
the Platform repository.
delete Removes a component version from the Platform
repository.
list Lists installed component versions within the Platform
repository. The default view is a compact listing of
active and inactive components.
reload Reloads the on-disk component registry.scsctl repo Component Add
Adds a component version to the SCS repository.
Usage
usage: scsctl repo component add [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-f FILE | -u URL) [--force]
[-s | --prompt-for-defaults]
options: ...
Adds a component version to the Platform repository.
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)
-f FILE, --file FILE Path to component bundle to be added to the
repository, or '-' to read from stdin. (default: None)
-u URL, --url URL URL of component bundle to be added to the repository.
(default: None)
--force If set, forces overwrite of a previously-installed
matching component version. (default: False)
-s, --silent If set, disables prompting for missing configuration
value defaults. (default: False)
--prompt-for-defaults
If set, will prompt for missing configuration
defaults, even if those defaults had been previously
set during a prior installation (normally previously-
set defaults are automatically used). (default: False)
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 repo component add DUMMY help'
options:scsctl repo Component Build
Builds a component bundle that can be imported into the SCS repository.
Usage
usage: scsctl repo component build
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] -d
DEFINITION_PATH -c SETTINGS_PATH
[-f TEMPLATE_PATHS] [-s BINARY_PATHS]
[-o OUTPUT]
options: ...
Builds a component bundle that can be imported into the Platform repository.
required arguments:
-d DEFINITION_PATH, --with-definition DEFINITION_PATH
Path to component definition YAML. (default: None)
-c SETTINGS_PATH, --with-config-definitions SETTINGS_PATH
Path to configuration definitions. (default: None)
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)
-f TEMPLATE_PATHS, --with-config-file TEMPLATE_PATHS
Path to a configuration file to add to the bundle.
(default: None)
-s BINARY_PATHS, --with-software-file BINARY_PATHS
Path to a software file to add to the bundle.
(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)
-o OUTPUT, --output OUTPUT
Where to send the result of the command (non-verbose
output; default is stdout, same as specifying "-").
(default: -)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl repo component build DUMMY help'
options:scsctl repo Component Delete
Removes a component version from the SCS repository.
Usage
usage: scsctl repo component delete
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [--force]
[-y]
options: ... name version
Removes a component version from the Platform repository.
positional arguments:
name The name of the component to remove.
version The version of the component to remove.
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)
--force If set, forces removal of requested version, even if it is
the active version. (default: False)
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)
-y, --yes If specified, will bypass all confirmation prompts. (default:
False)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl repo component delete DUMMY help'
options: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
usage: scsctl repo component list
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-t | -c]
[-s {name,is_active}] [--pretty]
options: ...
Lists installed component versions within the Platform repository. The default
view is a compact listing of active and inactive components.
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)
-t, --table If present, will list all installed component versions
in a tabular view (default is a compact view).
(default: False)
-c, --csv If present, will list all installed component versions
in CSV format. (default: False)
-s {name,is_active}, --sort-by {name,is_active}
The column to use for sorting (table and csv output
only). (default: name)
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 repo component list DUMMY help'
options:scsctl repo Component Reload
Reloads the on-disk component registry.
Usage
usage: scsctl repo component reload
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-y]
options: ...
Reloads the on-disk component registry.
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)
-y, --yes If specified, will bypass all confirmation prompts. (default:
False)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl repo component reload DUMMY help'
options:scsctl repo Third-Party
Manages third-party software installations within the SCS repository.
Usage
usage: scsctl repo thirdparty [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-c]
[-s {name,bytes,md5}] [--pretty]
options: ...
Manages third-party software installations within the Platform repository.
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)
-c, --csv If present, will list in CSV format. (default: False)
-s {name,bytes,md5}, --sort-by {name,bytes,md5}
The column to use for sorting. (default: name)
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 repo thirdparty add help'
options:
add Adds third-party software to the Platform repository.
delete Removes third-party software from the Platform
repository.
list Lists installed third-party software within the
Platform repository.scsctl repo Third-Party Add
Adds third-party software to the SCS repository.
Usage
usage: scsctl repo thirdparty add
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
(-f FILE | -u URL) [--force]
options: ... name
Adds third-party software to the Platform repository.
positional arguments:
name The name that the repository should use for the
uploaded software.
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)
-f FILE, --file FILE Path to software file to be added to the repository,
or '-' to read from stdin. (default: None)
-u URL, --url URL URL of software file to be added to the repository.
(default: None)
--force If set, forces overwrite of an existing matching
repository entry. (default: False)
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 repo thirdparty add DUMMY help'
options:scsctl repo Third-Party Delete
Removes third-party software from the SCS repository.
Usage
usage: scsctl repo thirdparty delete
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-y]
options: ... name
Removes third-party software from the Platform repository.
positional arguments:
name The name of the third-party software to be removed.
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)
-y, --yes If specified, will bypass all confirmation prompts. (default:
False)
subcommands:
Which action you wish to perform. To get detailed help, add 'help' to the
end. For example: 'scsctl repo thirdparty delete DUMMY help'
options:scsctl repo Third-Party List
Lists installed third-party software within the SCS repository.
Usage
usage: scsctl repo thirdparty list
[-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN] [-c]
[-s {name,bytes,md5}] [--pretty]
options: ...
Lists installed third-party software within the Platform repository.
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)
-c, --csv If present, will list in CSV format. (default: False)
-s {name,bytes,md5}, --sort-by {name,bytes,md5}
The column to use for sorting. (default: name)
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 repo thirdparty list DUMMY help'
options:scsctl System
Performs administrative operations on the system.
Usage
usage: scsctl system [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
options: ...
Performs administrative operations on the system.
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 system reset help'
options:
reset DANGER! This action will completely reset all post-
installation changes to your Platform server!scsctl System Reset
Warning
This action completely resets all post-installation changes to the SCS server!
Usage
usage: scsctl system reset [-v | --info-log | --debug-log | --trace-log]
[--user USER | --token TOKEN]
options: ...
DANGER! This action will completely reset all post-installation changes to
your Platform server!
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 system reset DUMMY help'
options:
, multiple selections available,
Related content
Finalize Swarm Configuration Settings
Finalize Swarm Configuration Settings
Read with this
SCS Administration
SCS Administration
More like this
Swarm 17.0 Proxmox 8.3 Bundle Rocky Linux 8 Package
Swarm 17.0 Proxmox 8.3 Bundle Rocky Linux 8 Package
Read with this
Swarm Cluster Services (SCS) Implementation
Swarm Cluster Services (SCS) Implementation
More like this
Swarm 16 Highlights
Swarm 16 Highlights
Read with this
Swarm Cluster Services 1.6 Release Notes
Swarm Cluster Services 1.6 Release Notes
More like this
© DataCore Software Corporation. · https://www.datacore.com · All rights reserved.