airshipctl/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden
Sirisha Gopigiri 21f015b502 Updating cmd files for documentation
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
2021-06-09 09:56:21 +00:00

26 lines
1.1 KiB
Plaintext

Bootstrap bare metal host. It targets bare metal host from airship inventory based
on the --iso-url, --name, --namespace, --label and --timeout flags provided.
Usage:
remotedirect [flags]
Examples:
Perform bootstrap action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal remotedirect --name rdm9r3s3
Perform bootstrap action against hosts with name rdm9r3s3 in metal3 namespace
# airshipctl baremetal remotedirect --name rdm9r3s3 --namespace metal3
Perform bootstrap action against hosts with a label 'foo=bar'
# airshipctl baremetal remotedirect --labels "foo=bar"
Flags:
-h, --help help for remotedirect
--iso-url string specify iso url for host to boot from
-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)