baremetal Standalone Command-Line Interface (CLI)

Synopsis

baremetal [options] <command> [command-options]

baremetal help <command>

Description

The standalone baremetal tool allows interacting with the Bare Metal service without installing the OpenStack Client tool as in openstack baremetal Command-Line Interface (CLI).

The standalone tool is mostly identical to its OSC counterpart, with two exceptions:

  1. No need to prefix commands with openstack.

  2. No authentication is assumed by default.

Check the OSC CLI reference for a list of available commands.

Inspector support

The standalone baremetal tool optionally supports the low-level bare metal introspection API provided by ironic-inspector. If ironic-inspector-client is installed, its commands are automatically available (also without the openstack prefix).

Standalone usage

To use the CLI with a standalone bare metal service, you need to provide an endpoint to connect to. It can be done in three ways:

  1. Provide an explicit --os-endpoint argument, e.g.:

    $ baremetal --os-endpoint https://ironic.host:6385 node list

  2. Set the corresponding environment variable, e.g.:

    $ export OS_ENDPOINT=https://ironic.host:6385
$ baremetal node list

  3. Populate a clouds.yaml file, setting baremetal_endpoint_override, e.g.:

    $ cat ~/.config/openstack/clouds.yaml
clouds:
  ironic:
    auth_type: none
    baremetal_endpoint_override: http://127.0.0.1:6385
$ export OS_CLOUD=ironic
$ baremetal node list

Inspector support works similarly, but the clouds.yaml option is called baremetal_introspection_endpoint_override. The two endpoints can be configured simultaneously, e.g.:

$ cat ~/.config/openstack/clouds.yaml
clouds:
  ironic:
    auth_type: none
    baremetal_endpoint_override: http://127.0.0.1:6385
    baremetal_introspection_endpoint_override: http://127.0.0.1:5050
$ export OS_CLOUD=ironic
$ baremetal node list
$ baremetal introspection list

Usage with OpenStack

The standalone CLI can also be used with the Bare Metal service installed as part of OpenStack. See Authentication for information on the required input.