python-novaclient/doc/source/shell.rst
Dean Troyer 9101741960 Change '_' to '-' in options
This changes every command-line option with a '_' in its name
and changes them to '-'.  The old option names are maintained
for backward compatibility but are no longer in the help text.

BP command-options

Note: there is a dodgy hack in novaclient/shell.py to handle
usage-list's --end option that conflicts with --endpoint-type
if --endpoint_type is also present for backward compatibility.
If --endpoint_type is not added to the parser it works.  Go figure.
Better solutions that do not break backward compatibility are welcome.

Rebased due to https://review.openstack.org/11072 merging.
Note: --availability_zone changed to --availability-zone with no
backward compatability since this s a new option.

Change-Id: I09ab546659be0a0d3f0eadb22ab5e13fac2f059d
2012-08-24 15:22:44 -05:00

1.4 KiB

The nova shell utility

nova

The nova shell utility interacts with OpenStack Nova API from the command line. It supports the entirety of the OpenStack Nova API.

First, you'll need an OpenStack Nova account and an API key. You get this by using the nova-manage command in OpenStack Nova.

You'll need to provide nova with your OpenStack username and API key. You can do this with the --os-username, --os-password and --os-tenant-id options, but it's easier to just set them as environment variables by setting two environment variables:

OS_USERNAME

Your OpenStack Nova username.

OS_PASSWORD

Your password.

OS_TENANT_NAME

Project for work.

OS_AUTH_URL

The OpenStack API server URL.

OS_COMPUTE_API_VERSION

The OpenStack API version.

For example, in Bash you'd use:

export OS_USERNAME=yourname
export OS_PASSWORD=yadayadayada
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://...
export OS_COMPUTE_API_VERSION=1.1

From there, all shell commands take the form:

nova <command> [arguments...]

Run nova help to get a full list of all possible commands, and run nova help <command> to get detailed help for that command.