liusheng 26880fc707 Improve moganclient documentation

* Reorganize the structure of client documentation
* Add commands descriptions
* Add contributor guide docs

Change-Id: Ibd4cd2a98e574c3c7606d0bc450de94d48e518e7

2017-09-06 10:45:58 +08:00

2.3 KiB

Raw Blame History

OpenStack Client Command-Line Interface (CLI)

openstack baremetalcompute

Synopsis

openstack [options] baremetalcompute <command> [command-options]

openstack help baremetalcompute <command>

Description

The OpenStack Client plugin interacts with the Bare Metal service through the openstack baremetalcompute command line interface (CLI).

To use openstack CLI, the OpenStackClient should be installed:

# pip install python-openstackclient

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

$ export OS_USERNAME=user
$ export OS_PASSWORD=password
$ export OS_PROJECT_NAME=project                         # or OS_PROJECT_ID
$ export OS_PROJECT_DOMAIN_ID=default
$ export OS_USER_DOMAIN_ID=default
$ export OS_IDENTITY_API_VERSION=3
$ export OS_AUTH_URL=http://auth.example.com:5000/identity

This CLI is provided by python-openstackclient and osc-lib projects:

Getting help

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

$ openstack help baremetalcompute

To get usage and options of a command, run:

$ openstack help baremetalcompute <sub-command>

Examples

Get information about the openstack baremetalcompute server create command:

$ openstack help baremetalcompute server create

Get a list of baremetalcompute flavors:

$ openstack baremetalcompute flavor list

Boot a Bare metal server:

$ openstack baremetalcompute server create --flavor <FLAVOR> --image <IMAGE> --nic net-id=<NETWORK> test

Get a list of baremetal nodes aggregates:

$ openstack baremetalcompute aggregate list

Command Reference

List of released CLI commands available in openstack client. These commands can be referenced by doing openstack help baremetalcompute.

v1/index

2.3 KiB Raw Blame History