airshipctl/cmd/config/testdata/TestConfigSetManagementConfigurationCmdGoldenOutput/config-cmd-set-management-config-with-help.golden
Sirisha Gopigiri 3274b41151 Config- updating cmd files for documentation
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: If3ec175e2f582919296576a4bff6ae64871a7333
2021-05-25 12:14:59 +05:30

28 lines
1.3 KiB
Plaintext

Creates or modifies management config information based on the MGMT_CONFIG_NAME passed. The allowed set
of optional flags are management-type, system-action-retries and system-reboot-delay. Use --use-proxy
and --insecure to enable proxy and insecure options respectively.
Usage:
set-management-config MGMT_CONFIG_NAME [flags]
Examples:
Create management configuration
# airshipctl config set-management-config default
Create or update management configuration named "default" with retry and to enable insecure options
# airshipctl config set-management-config default --insecure --system-action-retries 40
Enable proxy for "test" management configuration
# airshipctl config set-management-config test --use-proxy
Flags:
-h, --help help for set-management-config
--insecure ignore SSL certificate verification on out-of-band management requests
--management-type string set the out-of-band management type (default "redfish")
--system-action-retries int set the number of attempts to poll a host for a status (default 30)
--system-reboot-delay int set the number of seconds to wait between power actions (e.g. shutdown, startup) (default 30)
--use-proxy use the proxy configuration specified in the local environment (default true)