OpenStack Compute (Nova) Client
Go to file
OpenStack Proposal Bot 5ecfdac6b3 Updated from global requirements
Change-Id: Id91358b7d4efe79a4be5190dcdb4b0b7cb40f19b
2014-09-19 08:51:36 +00:00
doc Stop using intersphinx 2014-09-13 09:44:39 +02:00
novaclient Merge "Corrects typos "coearse," "proejct," and "unecrypts"" 2014-09-19 06:19:01 +00:00
tools Removed undefined method in file 2014-01-31 11:33:54 -06:00
.coveragerc Update .coveragerc 2013-02-06 16:47:06 +02:00
.gitignore Updates .gitignore 2013-11-28 22:36:20 +08:00
.gitreview Add .gitreview config file for gerrit. 2011-11-16 09:23:10 -08:00
.mailmap Add mailmap entry 2014-05-07 12:16:41 -07:00
.testr.conf Move tests into the novaclient package. 2013-05-25 08:23:14 +02:00
CONTRIBUTING.rst Fix the section name in CONTRIBUTING.rst 2014-07-01 15:16:36 +08:00
HACKING.rst Clean up a little cruft 2013-09-20 16:02:48 -07:00
LICENSE whitespace cleanups 2011-08-08 13:25:29 -07:00 Update to latest openstack.common.setup. 2013-03-28 06:40:13 +01:00
README.rst Quickstart (README) doc should refer to nova 2014-08-18 20:29:53 +01:00
openstack-common.conf Use oslo.utils 2014-08-28 12:17:22 +03:00
requirements.txt Updated from global requirements 2014-09-19 08:51:36 +00:00 Migrate to flake8. 2013-05-25 08:22:39 +02:00
setup.cfg Merge "Support building wheels (PEP-427)" 2014-03-28 18:56:47 +00:00 Updated from global requirements 2014-04-30 02:46:46 +00:00
test-requirements.txt Updated from global requirements 2014-09-19 08:51:36 +00:00
tox.ini delete python bytecode before every test run 2014-09-12 17:37:15 -04:00


Python bindings to the OpenStack Nova API

This is a client for the OpenStack Nova API. There's a Python API (the novaclient module), and a command-line script (nova). Each implements 100% of the OpenStack Nova API.

See the OpenStack CLI guide for information on how to use the nova command-line tool. You may also want to look at the OpenStack API documentation.

The project is hosted on Launchpad, where bugs can be filed. The code is hosted on Github. Patches must be submitted using Gerrit, not Github pull requests.

python-novaclient is licensed under the Apache License like the rest of OpenStack.


Command-line API

Installing this package gets you a shell command, nova, that you can use to interact with any OpenStack cloud.

You'll need to provide your OpenStack username and password. You can do this with the --os-username, --os-password and --os-tenant-name params, but it's easier to just set them as environment variables:

export OS_USERNAME=openstack
export OS_PASSWORD=yadayada
export OS_TENANT_NAME=myproject

You will also need to define the authentication url with --os-auth-url and the version of the API with --os-compute-api-version. Or set them as an environment variables as well:

export OS_AUTH_URL=

If you are using Keystone, you need to set the OS_AUTH_URL to the keystone endpoint:

export OS_AUTH_URL=

Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name (or export OS_REGION_NAME). It defaults to the first in the list returned.

You'll find complete documentation on the shell by running nova help

Python API

There's also a complete Python API, but it has not yet been documented.

To use with nova, with keystone as the authentication system:

# use v2.0 auth with")
>>> from novaclient.v1_1 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute")
>>> nt.flavors.list()
>>> nt.servers.list()
>>> nt.keypairs.list()