airshipctl/airshipctl_baremetal_ejectmedia.md at 88e648e5ed9174f1d127e8989004ff113d088de7

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

Raw Blame History

airshipctl baremetal ejectmedia

Airshipctl command to eject virtual media attached to a bare metal host

Synopsis

Eject virtual media attached to a bare metal host. 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 ejectmedia [flags]

Examples


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

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

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

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

Options

      --all                specify this to target all hosts in the inventory
  -h, --help               help for ejectmedia
  -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.7 KiB Raw Blame History