openstack/python-novaclient
Code Issues Proposed changes
d9e8e364e0
python-novaclient/doc/source/shell.rst
Andrey Kurilin 420782cc01 [docs] Fix length of underline 
Title length must match the underline

Change-Id: Ia7a2bf54a6697c63c423bacd53dfb125b9c620f6
2015-09-17 16:07:11 +03:00

1.4 KiB
Raw Blame History

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.