airship/airshipctl
Code Issues Proposed changes
airshipctl/docs/source/cli/airshipctl_baremetal_poweroff.md
Sirisha Gopigiri ec3840a866 Baremetal- 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: I323fa145b512e58cb878b117656c51bc39e76360
2021-05-07 19:23:55 +05:30

1.6 KiB
Raw Blame History

airshipctl baremetal poweroff

Airshipctl command to shutdown bare metal host(s)

Synopsis

Power off bare metal host(s). The command will target bare metal hosts from airship inventory based on the --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the inventory.

airshipctl baremetal poweroff [flags]

Examples


Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal poweroff --name rdm9r3s3

Perform action against hosts with name rdm9r3s3 in namespace metal3
# airshipctl baremetal poweroff --name rdm9r3s3 --namespace metal3

Perform action against all hosts defined in inventory
# airshipctl baremetal poweroff --all

Perform action against hosts with a label 'foo=bar'
# airshipctl baremetal poweroff --labels "foo=bar"

Options

      --all                specify this to target all hosts in the inventory
  -h, --help               help for poweroff
  -l, --labels string      label(s) to filter desired bare metal host documents
      --name string        name to filter desired bare metal host document
  -n, --namespace string   airshipctl phase that contains the desired bare metal host document(s)
      --timeout duration   timeout on bare metal action (default 10m0s)

Options inherited from parent commands

      --airshipconf string   Path to file for airshipctl configuration. (default "$HOME/.airship/config")
      --debug                enable verbose output

SEE ALSO