5516fe0e8d
Adds a short description about how to get started with the ironic CLI. Change-Id: I86247c36d9c3ce482dde009bef7e59fcdc493c64 Partial-Bug: #1300990
75 lines
1.9 KiB
ReStructuredText
75 lines
1.9 KiB
ReStructuredText
==============================================
|
|
:program:`ironic` Command-Line Interface (CLI)
|
|
==============================================
|
|
|
|
.. program:: ironic
|
|
.. highlight:: bash
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
:program:`ironic` [options] <command> [command-options]
|
|
|
|
:program:`ironic help`
|
|
|
|
:program:`ironic help` <command>
|
|
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
The :program:`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 :option:`--os-username`, :option:`--os-password`,
|
|
:option:`--os-tenant-id` (or :option:`--os-tenant-name`),
|
|
and :option:`--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 :option:`--ironic-url` and
|
|
:option:`--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
|