airshipctl/airshipctl_baremetal_powerstatus.md at 96b6a1da71d3130cdd872361e8fdea4916339421

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.4 KiB

Raw Blame History

airshipctl baremetal powerstatus

Airshipctl command to retrieve the power status of a bare metal host

Synopsis

Retrieve the power status of a bare metal host. It targets a bare metal host from airship inventory based on the --name, --namespace, --label and --timeout flags provided.

airshipctl baremetal powerstatus [flags]

Examples


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

Perform action against host with name rdm9r3s3 in namespace metal3
# airshipctl baremetal powerstatus --name rdm9r3s3 --namespace metal3

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

Options

  -h, --help               help for powerstatus
  -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

1.4 KiB Raw Blame History