Files

Ruby Loo 5516fe0e8d Add documentation for ironic CLI

Adds a short description about how to get started with the
ironic CLI.

Change-Id: I86247c36d9c3ce482dde009bef7e59fcdc493c64
Partial-Bug: #1300990

2014-04-15 12:59:15 +00:00

1.9 KiB

Raw Blame History

`ironic` Command-Line Interface (CLI)

ironic

SYNOPSIS

ironic [options] <command> [command-options]

ironic help

ironic help <command>

DESCRIPTION

The ironic command-line interface (CLI) interacts with the OpenStack Bare Metal Service (Ironic).

In order to use the CLI, you must provide your OpenStack username, password, project (historically called tenant), and auth endpoint. You can use configuration options --os-username, --os-password, --os-tenant-id (or --os-tenant-name), and --os-auth-url, or set the corresponding environment variables:

export OS_USERNAME=user
export OS_PASSWORD=password
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b   # or OS_TENANT_NAME
export OS_TENANT_NAME=project                          # or OS_TENANT_ID
export OS_AUTH_URL=http://auth.example.com:5000/v2.0

The command-line tool will attempt to reauthenticate using the provided credentials for every request. You can override this behavior by manually supplying an auth token using --ironic-url and --os-auth-token, or by setting the corresponding environment variables:

export IRONIC_URL=http://ironic.example.org:6385/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

OPTIONS

To get a list of available (sub)commands and options, run:

ironic help

To get usage and options of a command, run:

ironic help <command>

EXAMPLES

Get information about the node-create command:

ironic help node-create

Get a list of available drivers:

ironic driver-list

Enroll a node with "fake" deploy driver and "ipmitool" power driver:

ironic node-create -d fake_ipmitool -i ipmi_address=1.2.3.4

Get a list of nodes:

ironic node-list

1.9 KiB Raw Blame History

ironic Command-Line Interface (CLI)