python-novaclient/doc/source/shell.rst
Andrey Kurilin 0a60aae852 Rename v1_1 to v2
Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3.
Since future development(microversioning) will be done across V2,
implementation should be done in appropriate module(to prevent misleading).

Despite the fact that implementation for all versions are equal, discover
method for contrib path worked only for v1.1. This patch fixes this bug and
modifies shell tests to check all versions.

Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b
2015-02-04 17:40:46 +02: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=2

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.