4da8a54887
Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org
Steps to render the document locally
* Install sphinx: python3 -m pip install sphinx
* Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
* Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
* Run local server: cd _build; python3 -m http.server
* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document
Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352
62 lines
2.0 KiB
ReStructuredText
62 lines
2.0 KiB
ReStructuredText
.. _airshipctl_config_set-management-config:
|
|
|
|
airshipctl config set-management-config
|
|
---------------------------------------
|
|
|
|
Airshipctl command to create/modify out-of-band management configuration in airshipctl config file
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
|
|
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.
|
|
|
|
|
|
::
|
|
|
|
airshipctl config 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
|
|
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
::
|
|
|
|
-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)
|
|
|
|
Options inherited from parent commands
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
::
|
|
|
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
--debug enable verbose output
|
|
|
|
SEE ALSO
|
|
~~~~~~~~
|
|
|
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
|
|