{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"type":{"value":"list"},"printable":{"value":"false"}},"macroMetadata":{"macroId":{"value":"2e663373-69ea-4697-a2e7-131958f2be23"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c88607e8-1d49-44ae-b74b-ad356905d860"}},{"type":"paragraph","content":[{"text":"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:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"3b7d7664-4715-43ac-a123-ae96c4b08ac7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[77.0]},"content":[{"type":"paragraph","content":[{"text":"Cluster","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[683.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a storage cluster","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Read a storage cluster's settings","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update a storage cluster's settings","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[77.0]},"content":[{"type":"paragraph","content":[{"text":"Chassis","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[683.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a chassis to the cluster","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Read a chassis' settings","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update a chassis' settings","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[77.0]},"content":[{"type":"paragraph","content":[{"text":"Software","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[683.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Upgrade a storage cluster's software","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add or update a storage license","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update the storage cluster configuration, such as the location of Syslog and NTP servers ","type":"text"}]}]}]}]}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"CLI Command","type":"text","marks":[{"type":"strong"}]},{"text":" - The command for the CLI is \"","type":"text"},{"text":"scsctl","type":"text","marks":[{"type":"code"}]},{"text":"\", and subcommands are listed in order after. To view settings, a command like \"","type":"text"},{"text":"scsctl settings view","type":"text","marks":[{"type":"strong"}]},{"text":"\" is used (with arguments as needed). ","type":"text"}]},{"type":"paragraph","content":[{"text":"API Interaction","type":"text","marks":[{"type":"strong"}]},{"text":" - The CLI uses the SCS API directly as a client. Use the CLI as a set of examples for integrating with the SCS API.","type":"text"}]},{"type":"paragraph","content":[{"text":"Component Settings","type":"text","marks":[{"type":"strong"}]},{"text":" - Most setting definitions have a default value. For those depending on ","type":"text"},{"text":"an","type":"text","marks":[{"type":"em"}]},{"text":" environment, the CLI prompts for a value. For secure settings (such as passwords), the CLI does not echo an entry.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"97bde6de-dcb8-4637-8795-e6eb0bd47169"}}]}]},{"type":"paragraph","content":[{"text":"Provides basic control and visibility in to the SCS service.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","attrs":{"language":"none"},"content":[{"text":"usage: scsctl [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ...\n\nProvides basic control and visibility into the Platform service.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl auth help'\n\n options:\n auth Manages persisted credentials for contacting the Platform\n API.\n backup Manages backing up and restoring the Platform service.\n diagnostics Performs diagnostics on the Platform server setup.\n init Utilities for setting up a Swarm environment.\n license Manages the license for this Swarm ecosystem installation.\n repo Manages the Platform repository. The repository contains\n installed component versions and other third-party software.\n system Performs administrative operations on the system.\n Manage the \"\" component.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl ","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages a component in the Swarm ecosystem.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--version VERSION]\n [-b] [--pretty]\n options: ...\n\nManage the \"\" component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --version VERSION A specific installed version to view. (default: None)\n -b, --brief If present, will display component details in compact\n mode. (default: True)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl add help'\n\n options:\n add Shorthand for component \"instance add\".\n config Manage configuration for this component.\n group Manage groups within this component.\n instance Manage instances of this component.\n list Shorthand for component \"instance list\".\n show Display this component's details.\n software Manage software for this component.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Add","type":"text"}]},{"type":"paragraph","content":[{"text":"Shorthand for component \"instance add\".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl add [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--show-detail]\n (-g GROUP_NAME | -d)\n options: ... name\n\nShorthand for component \"instance add\".\n\npositional arguments:\n name The name of the instance.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --show-detail If specified, then advanced detail about the state of\n the added instance will be shown (default behavior is\n to just show the ID). (default: False)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group to which the instance will be\n added. (default: _default)\n -d, --default-group If specified, then the instance will be added to the\n default group. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl add DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"Manage configuration for this component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d] [-i INSTANCE] [-a]\n [--pretty]\n options: ...\n\nManage configuration for this component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group for which to list. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n listing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance for which to list.\n (default: None)\n -a, --include-advanced\n If provided, then advanced settings will be included\n in the listing. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config file help'\n\n options:\n file Manages component configuration files.\n list Lists configuration settings for the current\n component.\n set Updates a configuration setting for the current\n component.\n show Displays a configuration setting for the current\n component.\n unset Removes a previously-set configuration setting value\n of the given component.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration File","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages component configuration files.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config file\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d] [-i INSTANCE]\n options: ...\n\nManages component configuration files.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group for which to list. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n listing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance for which to list.\n (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config file list help'\n\n options:\n list Lists configuration files for the current component.\n set Updates a configuration file for the current\n component.\n show Shows a configuration file for the current component.\n unset Removes a customized configuration file for the\n current component.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration File List","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists configuration files for the current component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config file list\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d] [-i INSTANCE]\n options: ...\n\nLists configuration files for the current component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group for which to list. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n listing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance for which to list.\n (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config file list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration File Set","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates a configuration file for the current component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config file set\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-g GROUP_NAME | -d) [-i INSTANCE]\n (-f FILE | -u URL)\n options: ... name\n\nUpdates a configuration file for the current component.\n\npositional arguments:\n name The name of the configuration file to update.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group where the update should occur.\n (default: None)\n -d, --default-group If specified, then the default group will be used for\n the update. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance where the update should\n occur. (default: None)\n -f FILE, --file FILE Path to config file to use for the update, or '-' to\n read from stdin. (default: None)\n -u URL, --url URL URL of config file to use for the update. (default:\n None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config file set DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration File Show","type":"text"}]},{"type":"paragraph","content":[{"text":"Shows a configuration file for the current component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config file show\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d] [-i INSTANCE]\n [-r]\n options: ... name\n\nShows a configuration file for the current component.\n\npositional arguments:\n name The name of the configuration file to show.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group for which to show. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n showing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance for which to show.\n (default: None)\n -r, --raw Whether or not to show the raw (un-rendered)\n configuration file. Only applies if \"instance\" is\n specified. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config file show DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration File Unset","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes a customized configuration file for the current component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config file unset\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-g GROUP_NAME | -d) [-i INSTANCE]\n options: ... name\n\nRemoves a customized configuration file for the current component.\n\npositional arguments:\n name The name of the customized configuration file to\n remove.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group where the removal should occur.\n (default: None)\n -d, --default-group If specified, then the default group will be used for\n removing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance where the removal\n should occur. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config file unset DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration List","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists configuration settings for the current component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config list\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d] [-i INSTANCE] [-a]\n [--pretty]\n options: ...\n\nLists configuration settings for the current component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group for which to list. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n listing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance for which to list.\n (default: None)\n -a, --include-advanced\n If provided, then advanced settings will be included\n in the listing. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration Set","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates a configuration setting for the current component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config set\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-g GROUP_NAME | -d) [-i INSTANCE]\n [-f FILE] [-u URL]\n options: ... [setting_assignment]\n\nUpdates a configuration setting for the current component.\n\npositional arguments:\n setting_assignment A setting assignment in the form of:\n setting_name=new_value (default: None)\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group where the update should occur.\n (default: None)\n -d, --default-group If specified, then the default group will be used for\n updating. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance where the update should\n occur. (default: None)\n -f FILE, --file FILE Path to JSON file with object of name/value pairs to\n use for the update, or '-' to read from stdin.\n (default: None)\n -u URL, --url URL URL of JSON file with object of name/value pairs to\n use for the update. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config set DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration Show","type":"text"}]},{"type":"paragraph","content":[{"text":"Displays a configuration setting for the current component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config show\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d] [-i INSTANCE]\n [--show-detail] [--pretty]\n options: ... name\n\nDisplays a configuration setting for the current component.\n\npositional arguments:\n name The name of the configuration setting to show.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group for which to show. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n showing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance for which to show.\n (default: None)\n --show-detail If specified, then advanced detail about the state of\n the configuration setting will be shown (default\n behavior is to just show the value). (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config show DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Configuration Unset","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes a previously-set configuration setting value of the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl config unset\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-g GROUP_NAME | -d) [-i INSTANCE]\n options: ... name\n\nRemoves a previously-set configuration setting value of the given component.\n\npositional arguments:\n name The name of the configuration setting to un-set.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group for which to un-set. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n removing. (default: None)\n -i INSTANCE, --instance INSTANCE\n The name or ID of the instance for which to un-set.\n (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl config unset DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Group","type":"text"}]},{"type":"paragraph","content":[{"text":"Manage groups within this component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl group [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [--no-default-marker] [--pretty]\n options: ...\n\nManage groups within this component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --no-default-marker If specified, hides the marker designating which group\n is the default. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl group add help'\n\n options:\n add Adds a group to the given component.\n list Lists groups of the given component.\n makedefault Marks a group as the default group in the given\n component.\n remove Removes a group from the given component.\n show Displays information about a group of the given\n component.\n update Updates a group in the given component.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Group Add","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a group to the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl group add\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-d DESCRIPTION] [--make-default]\n options: ... name\n\nAdds a group to the given component.\n\npositional arguments:\n name The name of the group to be added.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -d DESCRIPTION, --description DESCRIPTION\n A description of the cluster (purpose, location, etc.)\n (default: )\n --make-default If given, then the newly added group will be marked as\n the default. Note that if this is the first group in\n the component it will automatically be marked as\n default. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl group add DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Group List","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists groups of the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl group list\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [--no-default-marker] [--pretty]\n options: ...\n\nLists groups of the given component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --no-default-marker If specified, hides the marker designating which group\n is the default. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl group list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Group Makedefault","type":"text"}]},{"type":"paragraph","content":[{"text":"Marks a group as the default group in the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl group makedefault\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ... name\n\nMarks a group as the default group in the given component.\n\npositional arguments:\n name The name of the group to be marked as default.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl group makedefault DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Group Remove","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes a group from the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl group remove\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--force]\n [-y]\n options: ... name\n\nRemoves a group from the given component.\n\npositional arguments:\n name The name of the group to remove.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n --force If set, forces the group to be removed even if it is marked\n as the default group. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n -y, --yes If specified, will bypass all confirmation prompts. (default:\n False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl group remove DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Group Show","type":"text"}]},{"type":"paragraph","content":[{"text":"Displays information about a group of the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl group show\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--pretty]\n options: ... name\n\nDisplays information about a group of the given component.\n\npositional arguments:\n name The name of the group to show.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl group show DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Group Update","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates a group in the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl group update\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-d DESCRIPTION]\n options: ... name\n\nUpdates a group in the given component.\n\npositional arguments:\n name The name of the group to be updated.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -d DESCRIPTION, --description DESCRIPTION\n A description of the cluster (purpose, location, etc.)\n (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl group update DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Manage instances of this component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl instance\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d]\n [-s {group,id,ip_address,name}] [--pretty]\n options: ...\n\nManage instances of this component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group to list. If missing, then all\n instances in all groups will be listed. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n listing. (default: None)\n -s {group,id,ip_address,name}, --sort-by {group,id,ip_address,name}\n The column to use for sorting. (default: name)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl instance add help'\n\n options:\n list Lists instances of the given component.\n remove Removes an instance of the given component.\n show Displays information about an instance of the given\n component.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Instance List","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists instances of the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl instance list\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d]\n [-s {group,id,ip_address,name}]\n [--pretty]\n options: ...\n\nLists instances of the given component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group to list. If missing, then all\n instances in all groups will be listed. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n listing. (default: None)\n -s {group,id,ip_address,name}, --sort-by {group,id,ip_address,name}\n The column to use for sorting. (default: name)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl instance list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Instance Remove","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes an instance of the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl instance remove\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-g GROUP_NAME | -d)\n options: ... instance\n\nRemoves an instance of the given component.\n\npositional arguments:\n instance The name or ID of the instance to remove.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group from which to remove. (default:\n None)\n -d, --default-group If specified, then the instance will be looked up\n within the default group. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl instance remove DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Instance Show","type":"text"}]},{"type":"paragraph","content":[{"text":"Displays information about an instance of the given component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl instance show\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-g GROUP_NAME | -d) [--pretty]\n options: ... instance\n\nDisplays information about an instance of the given component.\n\npositional arguments:\n instance The name or ID of the instance to show.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group containing the instance.\n (default: None)\n -d, --default-group If specified, then the instance will be looked up\n within the default group. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl instance show DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl List","type":"text"}]},{"type":"paragraph","content":[{"text":"Shorthand for component \"instance list\".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl list [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [-g GROUP_NAME | -d]\n [-s {group,id,ip_address,name}] [--pretty]\n options: ...\n\nShorthand for component \"instance list\".\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -g GROUP_NAME, --group GROUP_NAME\n The name of the group to list. If missing, then all\n instances in all groups will be listed. (default:\n None)\n -d, --default-group If specified, then the default group will be used for\n listing. (default: None)\n -s {group,id,ip_address,name}, --sort-by {group,id,ip_address,name}\n The column to use for sorting. (default: group)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Show","type":"text"}]},{"type":"paragraph","content":[{"text":"Display this component's details.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl show [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [--version VERSION] [-b] [--pretty]\n options: ...\n\nDisplay this component's details.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --version VERSION A specific installed version to view. (default: None)\n -b, --brief If present, will display component details in compact\n mode. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl show DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Software","type":"text"}]},{"type":"paragraph","content":[{"text":"Manage software for this component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl software\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--pretty]\n options: ...\n\nManage software for this component.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl software activate help'\n\n options:\n activate Activates an installed version of a component in the Swarm\n ecosystem.\n list Lists installed software versions for a component in the\n Swarm ecosystem.\n show Displays software information for an installed version of the\n component.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Software Activate","type":"text"}]},{"type":"paragraph","content":[{"text":"Activates an installed version of a component in the Swarm ecosystem.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl software activate\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ... [version]\n\nActivates an installed version of a component in the Swarm ecosystem.\n\npositional arguments:\n version The installed version to activate. Consult the list of\n installed versions for valid values. (default: None)\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl software activate DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Software List","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists installed software versions for a component in the Swarm ecosystem.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl software list\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [--pretty]\n options: ...\n\nLists installed software versions for a component in the Swarm ecosystem.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl software list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Software Show","type":"text"}]},{"type":"paragraph","content":[{"text":"Displays software information for an installed version of the component.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl software show\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [--pretty]\n options: ... version\n\nDisplays software information for an installed version of the component.\n\npositional arguments:\n version The installed version to view.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl software show DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Auth","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages persisted credentials for contacting the SCS API.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl auth [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ...\n\nManages persisted credentials for contacting the Platform API.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl auth login help'\n\n options:\n login Stores new credentials for contacting the Platform API.\n logout Clears previously-stored credentials for contacting the\n Platform API.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Auth Login","type":"text"}]},{"type":"paragraph","content":[{"text":"Stores new credentials for contacting the SCS API.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl auth login [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ...\n\nStores new credentials for contacting the Platform API.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl auth login DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Auth Logout","type":"text"}]},{"type":"paragraph","content":[{"text":"Clears previously-stored credentials for contacting the SCS API.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl auth logout [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ...\n\nClears previously-stored credentials for contacting the Platform API.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl auth logout DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Backup","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages backing up and restoring the SCS service.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl backup [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--no-repo] [-o OUTPUT]\n options: ...\n\nManages backing up and restoring the Platform service.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --no-repo If specified, then repo data (binaries, etc.) will be\n excluded from the backup. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n -o OUTPUT, --output OUTPUT\n Where to send the result of the command (non-verbose\n output; default is stdout, same as specifying \"-\").\n (default: -)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl backup create help'\n\n options:\n create Performs a backup of the Platform service.\n restore Performs a restore of the Platform service from a\n backup file.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Backup Create","type":"text"}]},{"type":"paragraph","content":[{"text":"Performs a backup of the SCS service.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl backup create [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--no-repo]\n [-o OUTPUT]\n options: ...\n\nPerforms a backup of the Platform service.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --no-repo If specified, then repo data (binaries, etc.) will be\n excluded from the backup. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n -o OUTPUT, --output OUTPUT\n Where to send the result of the command (non-verbose\n output; default is stdout, same as specifying \"-\").\n (default: -)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl backup create DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Backup Restore","type":"text"}]},{"type":"paragraph","content":[{"text":"Performs a restore of the SCS service from a backup file.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl backup restore [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-o OUTPUT]\n options: ... backup_file\n\nPerforms a restore of the Platform service from a backup file.\n\npositional arguments:\n backup_file Path to backup image to be restored.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n -o OUTPUT, --output OUTPUT\n Where to send the result of the command (non-verbose\n output; default is stdout, same as specifying \"-\").\n (default: -)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl backup restore DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Diagnostics","type":"text"}]},{"type":"paragraph","content":[{"text":"Performs diagnostics on the SCS server setup.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl diagnostics [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--quick]\n [--scan-only] [--pretty]\n options: ...\n\nPerforms diagnostics on the Platform server setup.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n --quick Only performs a quick scan of potential configuration issues\n (implies --scan-only). (default: False)\n --scan-only Only performs a quick scan of potential configuration issues.\n (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl diagnostics config help'\n\n options:\n config Checks configuration across the ecosystem.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Diagnostics Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"Checks configuration across the ecosystem.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl diagnostics config [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--quick]\n [--scan-only] [--pretty]\n options: ...\n\nChecks configuration across the ecosystem.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n --quick Only performs a quick scan of potential configuration issues\n (implies --scan-only). (default: False)\n --scan-only Only performs a quick scan of potential configuration issues.\n (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl diagnostics config scan_missing help'\n\n options:\n scan_missing\n Checks for missing configuration values.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl Diagnostics Configuration scan_missing","type":"text"}]},{"type":"paragraph","content":[{"text":"Checks for missing configuration values.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl diagnostics config scan_missing\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n [--quick] [--scan-only]\n [--pretty]\n options: ...\n\nChecks for missing configuration values.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n --quick Only performs a quick scan of potential configuration issues\n (implies --scan-only). (default: False)\n --scan-only Only performs a quick scan of potential configuration issues.\n (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl diagnostics config scan_missing DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl init","type":"text"}]},{"type":"paragraph","content":[{"text":"Utilities for setting up a Swarm environment.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl init [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--force] [--next-steps]\n [--allow-all-system-updates]\n [--details-path [DETAILS_PATH]]\n options: ...\n\nUtilities for setting up a Swarm environment.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --force If set, forces wizard to restart the entire process.\n (default: False)\n --next-steps If specified, will only display the next steps to run\n after this wizard and exit. (default: False)\n --allow-all-system-updates\n WARNING: Setting this will BYPASS ALL PROMPTS warning\n of changes to the system! Use with caution. (default:\n False)\n --details-path [DETAILS_PATH]\n If given, then all details of the init process will be\n captured in the specified file. To disable, specify\n this argument but do not provide a value. (default:\n ./init-details.log)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl init configs help'\n\n options:\n configs Performs an import of config values for multiple\n components into the default group for each. Each\n component's config values are in a file for that\n component, with the component name as the base\n (\"your_component.cfg\", \"your_coomponent.json\", etc.)\n dhcp Configures on-box DHCP service for use with Platform.\n wizard Walks the user through the init process to get the\n environment set up.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl init Configs","type":"text"}]},{"type":"paragraph","content":[{"text":"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.)","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl init configs [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-d DIRECTORY]\n options: ...\n\nPerforms an import of config values for multiple components into the default\ngroup for each. Each component's config values are in a file for that\ncomponent, with the component name as the base (\"your_component.cfg\",\n\"your_coomponent.json\", etc.)\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -d DIRECTORY, --directory DIRECTORY\n Path to the directory where the files are stored.\n (default: .)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl init configs DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl init dhcp","type":"text"}]},{"type":"paragraph","content":[{"text":"Configures on-box DHCP service for use with SCS.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl init dhcp [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] --dns-domain DNS_DOMAIN\n --dns-servers DNS_SERVERS --ntp-servers NTP_SERVERS\n [--dhcp-lease-default DHCP_LEASE_DEFAULT]\n [--dhcp-lease-max DHCP_LEASE_MAX]\n [--dhcp-reserve-lower DHCP_RESERVE_LOWER]\n [--dhcp-reserve-upper DHCP_RESERVE_UPPER]\n [--dhcp-transient-percent DHCP_TRANSIENT_PERCENT]\n options: ...\n\nConfigures on-box DHCP service for use with Platform.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl init dhcp DUMMY help'\n\n options:\n\nRelated Services:\n --dns-domain DNS_DOMAIN\n DNS domain name (default: None)\n --dns-servers DNS_SERVERS\n DNS servers to be used, comma-delimited (default:\n None)\n --ntp-servers NTP_SERVERS\n NTP servers to be used, comma-delimited (default:\n None)\n\nDHCP-specific Settings:\n Specifies timeouts and pool ranges within the subnet. Note that at least\n one of dhcp-reserve-lower or dhcp-reserve-upper MUST be set.\n\n --dhcp-lease-default DHCP_LEASE_DEFAULT\n Default DHCP lease time for storage nodes (default:\n 172800)\n --dhcp-lease-max DHCP_LEASE_MAX\n Maximum allowed DHCP lease time for storage nodes\n (default: 604800)\n --dhcp-reserve-lower DHCP_RESERVE_LOWER\n Number of IP addresses to reserve in lower subnet\n range (default: 0)\n --dhcp-reserve-upper DHCP_RESERVE_UPPER\n Number of IP addresses to reserve in upper subnet\n range (default: 0)\n --dhcp-transient-percent DHCP_TRANSIENT_PERCENT\n Percentage of DHCP managed range for transient clients\n (default: 50)","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl init Wizard","type":"text"}]},{"type":"paragraph","content":[{"text":"Walks the user through the init process to get the environment set up.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl init wizard [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--force]\n [--next-steps] [--allow-all-system-updates]\n [--details-path [DETAILS_PATH]]\n options: ...\n\nWalks the user through the init process to get the environment set up.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n --force If set, forces wizard to restart the entire process.\n (default: False)\n --next-steps If specified, will only display the next steps to run\n after this wizard and exit. (default: False)\n --allow-all-system-updates\n WARNING: Setting this will BYPASS ALL PROMPTS warning\n of changes to the system! Use with caution. (default:\n False)\n --details-path [DETAILS_PATH]\n If given, then all details of the init process will be\n captured in the specified file. To disable, specify\n this argument but do not provide a value. (default:\n ./init-details.log)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl init wizard DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl License","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages the license for this Swarm ecosystem installation.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl license [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--pretty]\n options: ...\n\nManages the license for this Swarm ecosystem installation.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl license add help'\n\n options:\n add Installs a new Swarm license into the Platform service.\n show Displays the license installed in the Platform service.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl License Add","type":"text"}]},{"type":"paragraph","content":[{"text":"Installs a new Swarm license into the SCS service.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl license add [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] (-f FILE | -u URL)\n options: ...\n\nInstalls a new Swarm license into the Platform service.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -f FILE, --file FILE Path to license file to install, or '-' to read from\n stdin. (default: None)\n -u URL, --url URL URL of license file to install. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl license add DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl License Show","type":"text"}]},{"type":"paragraph","content":[{"text":"Displays the license installed in the SCS service.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl license show [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--pretty]\n options: ...\n\nDisplays the license installed in the Platform service.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n --pretty If specified, will format output to be more human-friendly.\n (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl license show DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages the SCS repository. The repository contains installed component versions and other third-party software.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-t] [-c]\n [-s {name,bytes,md5}] [--pretty]\n options: ...\n\nManages the Platform repository. The repository contains installed component\nversions and other third-party software.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -t, --table If present, will list all installed component versions\n in a tabular view (default is a compact view).\n (default: False)\n -c, --csv If present, will list in CSV format. (default: False)\n -s {name,bytes,md5}, --sort-by {name,bytes,md5}\n The column to use for sorting. (default: name)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo component help'\n\n options:\n component Manages component installations within the Platform\n repository.\n thirdparty Manages third-party software installations within the\n Platform repository.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Component","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages component installations within the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo component [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-t | -c]\n [-s {name,is_active}] [--pretty]\n options: ...\n\nManages component installations within the Platform repository.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -t, --table If present, will list all installed component versions\n in a tabular view (default is a compact view).\n (default: False)\n -c, --csv If present, will list all installed component versions\n in CSV format. (default: False)\n -s {name,is_active}, --sort-by {name,is_active}\n The column to use for sorting (table and csv output\n only). (default: name)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo component add help'\n\n options:\n add Adds a component version to the Platform repository.\n build Builds a component bundle that can be imported into\n the Platform repository.\n delete Removes a component version from the Platform\n repository.\n list Lists installed component versions within the Platform\n repository. The default view is a compact listing of\n active and inactive components.\n reload Reloads the on-disk component registry.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Component Add","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a component version to the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo component add [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-f FILE | -u URL) [--force]\n [-s | --prompt-for-defaults]\n options: ...\n\nAdds a component version to the Platform repository.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -f FILE, --file FILE Path to component bundle to be added to the\n repository, or '-' to read from stdin. (default: None)\n -u URL, --url URL URL of component bundle to be added to the repository.\n (default: None)\n --force If set, forces overwrite of a previously-installed\n matching component version. (default: False)\n -s, --silent If set, disables prompting for missing configuration\n value defaults. (default: False)\n --prompt-for-defaults\n If set, will prompt for missing configuration\n defaults, even if those defaults had been previously\n set during a prior installation (normally previously-\n set defaults are automatically used). (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo component add DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Component Build","type":"text"}]},{"type":"paragraph","content":[{"text":"Builds a component bundle that can be imported into the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo component build\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] -d\n DEFINITION_PATH -c SETTINGS_PATH\n [-f TEMPLATE_PATHS] [-s BINARY_PATHS]\n [-o OUTPUT]\n options: ...\n\nBuilds a component bundle that can be imported into the Platform repository.\n\nrequired arguments:\n -d DEFINITION_PATH, --with-definition DEFINITION_PATH\n Path to component definition YAML. (default: None)\n -c SETTINGS_PATH, --with-config-definitions SETTINGS_PATH\n Path to configuration definitions. (default: None)\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -f TEMPLATE_PATHS, --with-config-file TEMPLATE_PATHS\n Path to a configuration file to add to the bundle.\n (default: None)\n -s BINARY_PATHS, --with-software-file BINARY_PATHS\n Path to a software file to add to the bundle.\n (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n -o OUTPUT, --output OUTPUT\n Where to send the result of the command (non-verbose\n output; default is stdout, same as specifying \"-\").\n (default: -)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo component build DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Component Delete","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes a component version from the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo component delete\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [--force]\n [-y]\n options: ... name version\n\nRemoves a component version from the Platform repository.\n\npositional arguments:\n name The name of the component to remove.\n version The version of the component to remove.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n --force If set, forces removal of requested version, even if it is\n the active version. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n -y, --yes If specified, will bypass all confirmation prompts. (default:\n False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo component delete DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Component List","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists installed component versions within the SCS repository. The default view is a compact listing of active and inactive components.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo component list\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-t | -c]\n [-s {name,is_active}] [--pretty]\n options: ...\n\nLists installed component versions within the Platform repository. The default\nview is a compact listing of active and inactive components.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -t, --table If present, will list all installed component versions\n in a tabular view (default is a compact view).\n (default: False)\n -c, --csv If present, will list all installed component versions\n in CSV format. (default: False)\n -s {name,is_active}, --sort-by {name,is_active}\n The column to use for sorting (table and csv output\n only). (default: name)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo component list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Component Reload","type":"text"}]},{"type":"paragraph","content":[{"text":"Reloads the on-disk component registry.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo component reload\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-y]\n options: ...\n\nReloads the on-disk component registry.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n -y, --yes If specified, will bypass all confirmation prompts. (default:\n False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo component reload DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Third-Party","type":"text"}]},{"type":"paragraph","content":[{"text":"Manages third-party software installations within the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo thirdparty [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-c]\n [-s {name,bytes,md5}] [--pretty]\n options: ...\n\nManages third-party software installations within the Platform repository.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -c, --csv If present, will list in CSV format. (default: False)\n -s {name,bytes,md5}, --sort-by {name,bytes,md5}\n The column to use for sorting. (default: name)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo thirdparty add help'\n\n options:\n add Adds third-party software to the Platform repository.\n delete Removes third-party software from the Platform\n repository.\n list Lists installed third-party software within the\n Platform repository.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Third-Party Add","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds third-party software to the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo thirdparty add\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n (-f FILE | -u URL) [--force]\n options: ... name\n\nAdds third-party software to the Platform repository.\n\npositional arguments:\n name The name that the repository should use for the\n uploaded software.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -f FILE, --file FILE Path to software file to be added to the repository,\n or '-' to read from stdin. (default: None)\n -u URL, --url URL URL of software file to be added to the repository.\n (default: None)\n --force If set, forces overwrite of an existing matching\n repository entry. (default: False)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo thirdparty add DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Third-Party Delete","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes third-party software from the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo thirdparty delete\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-y]\n options: ... name\n\nRemoves third-party software from the Platform repository.\n\npositional arguments:\n name The name of the third-party software to be removed.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n -y, --yes If specified, will bypass all confirmation prompts. (default:\n False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo thirdparty delete DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl repo Third-Party List","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists installed third-party software within the SCS repository.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl repo thirdparty list\n [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN] [-c]\n [-s {name,bytes,md5}] [--pretty]\n options: ...\n\nLists installed third-party software within the Platform repository.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is\n included, then this must be in the form\n \"{user_name}:{password}\" (default: None)\n --token TOKEN Authentication token. (default: None)\n -c, --csv If present, will list in CSV format. (default: False)\n -s {name,bytes,md5}, --sort-by {name,bytes,md5}\n The column to use for sorting. (default: name)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose\n output is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default:\n None)\n --debug-log Set debug-level verbosity (equivalent to -vv).\n (default: None)\n --trace-log Set trace-level verbosity (equivalent to -vvv).\n (default: None)\n --pretty If specified, will format output to be more human-\n friendly. (default: False)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl repo thirdparty list DUMMY help'\n\n options:","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl System","type":"text"}]},{"type":"paragraph","content":[{"text":"Performs administrative operations on the system.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl system [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ...\n\nPerforms administrative operations on the system.\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl system reset help'\n\n options:\n reset DANGER! This action will completely reset all post-\n installation changes to your Platform server!","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"scsctl System Reset","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Warning","type":"text"}]},{"type":"paragraph","content":[{"text":"This action completely resets all post-installation changes to the SCS server!","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage","type":"text"}]},{"type":"codeBlock","content":[{"text":"usage: scsctl system reset [-v | --info-log | --debug-log | --trace-log]\n [--user USER | --token TOKEN]\n options: ...\n\nDANGER! This action will completely reset all post-installation changes to\nyour Platform server!\n\noptional arguments:\n --user USER User name and (optionally) password. If password is included,\n then this must be in the form \"{user_name}:{password}\"\n (default: None)\n --token TOKEN Authentication token. (default: None)\n\noutput options:\n These options affect the way output is displayed.\n\n -v, --verbose Increase output verbosity (ex: -v, -vv, -vvv). Verbose output\n is always sent to stdout. (default: None)\n --info-log Set info-level verbosity (equivalent to -v). (default: None)\n --debug-log Set debug-level verbosity (equivalent to -vv). (default:\n None)\n --trace-log Set trace-level verbosity (equivalent to -vvv). (default:\n None)\n\nsubcommands:\n Which action you wish to perform. To get detailed help, add 'help' to the\n end. For example: 'scsctl system reset DUMMY help'\n\n options:","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported