21f015b502
This PS updates cmd related to root, completion, document and version subcommands. It also updates minor details in other subcommands. 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: I562c15c0d25b2e9731c0eb03854d1d348eb435f2
30 lines
1.3 KiB
Plaintext
30 lines
1.3 KiB
Plaintext
Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship site inventory based on the
|
|
--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site
|
|
inventory.
|
|
|
|
Usage:
|
|
ejectmedia [flags]
|
|
|
|
Examples:
|
|
|
|
Perform ejectmedia action against hosts with name rdm9r3s3 in all namespaces where the host is found
|
|
# airshipctl baremetal ejectmedia --name rdm9r3s3
|
|
|
|
Perform ejectmedia action against hosts with name rdm9r3s3 in metal3 namespace
|
|
# airshipctl baremetal ejectmedia --name rdm9r3s3 --namespace metal3
|
|
|
|
Perform ejectmedia action against all hosts defined in inventory
|
|
# airshipctl baremetal ejectmedia --all
|
|
|
|
Perform ejectmedia action against hosts with a label 'foo=bar'
|
|
# airshipctl baremetal ejectmedia --labels "foo=bar"
|
|
|
|
|
|
Flags:
|
|
--all specify this to target all hosts in the site inventory
|
|
-h, --help help for ejectmedia
|
|
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
|
--name string name to filter desired bare metal host from site manifest document
|
|
-n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s)
|
|
--timeout duration timeout on bare metal action (default 10m0s)
|