OpenStack Compute (Nova) Client

Go to file

Solly Ross 0b1a29e7b0 Show Exception Name in Shell Output Currently, when the CLI encounters an exception, only the exception message is shown. However, the name of the exception can be quite informative as well. For instance, an error message might read "Cannot do xyz", which simply indicates the operation was unsucessful. However, the attached exception name (HTTPNotImplemented, for instance) indicates the reason that the call was unsuccessful. Change-Id: I0298477bd9d40d98c95bb797c68c47dbc952b345		2014-03-18 17:23:18 -04:00
doc	Update broken command line reference link	2014-02-13 23:17:34 +08:00
novaclient	Show Exception Name in Shell Output	2014-03-18 17:23:18 -04:00
tools	Removed undefined method in install_env.py 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	Update my mailmap	2014-02-05 19:37:46 +00:00
.testr.conf	Move tests into the novaclient package.	2013-05-25 08:23:14 +02:00
CONTRIBUTING.rst	Add CONTRIBUTING file.	2013-05-25 08:23:14 +02: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
MANIFEST.in	Update to latest openstack.common.setup.	2013-03-28 06:40:13 +01:00
openstack-common.conf	oslo-sync of low hanging fruit	2014-02-26 17:25:11 -08:00
README.rst	Removes copy of output of 'nova help' from README	2014-03-13 21:15:56 +10:30
requirements.txt	Updated from global requirements	2014-02-26 23:34:59 +00:00
run_tests.sh	Migrate to flake8.	2013-05-25 08:22:39 +02:00
setup.cfg	Add classifiers for specific versions of Python	2014-03-03 20:09:28 +01:00
setup.py	Update pbr usage	2013-09-20 16:02:57 -07:00
test-requirements.txt	Updated from global requirements	2014-02-23 09:31:50 +00:00
tox.ini	Remove tox locale overrides	2014-02-10 03:21:02 +00:00

README.rst

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.

Contents:

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=http://example.com:8774/v1.1/
export OS_COMPUTE_API_VERSION=1.1

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

export OS_AUTH_URL=http://example.com:5000/v2.0/

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.

Quick-start using keystone:

# use v2.0 auth with http://example.com:5000/v2.0/")
>>> 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()
[...]