Skip to main content

Client library for OpenStack Compute API

Project description

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=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()
[...]

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-novaclient-2.18.1.tar.gz (254.8 kB view details)

Uploaded Source

Built Distribution

python_novaclient-2.18.1-py2.py3-none-any.whl (342.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file python-novaclient-2.18.1.tar.gz.

File metadata

File hashes

Hashes for python-novaclient-2.18.1.tar.gz
Algorithm Hash digest
SHA256 d0fc0908ee493df4212ed5f636bb7eaab22b7e9d566c23ded5001530e3732bc7
MD5 f9476c3c254d657cd82372f3e524b188
BLAKE2b-256 4292721465140877c9456caa0baffc2aa487320bb985ad6ae9f480782d73866d

See more details on using hashes here.

Provenance

File details

Details for the file python_novaclient-2.18.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_novaclient-2.18.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cb744b338e43bb4399d733a6ee11d836336fa6a85efcc84b6f8f8a07df31ed3f
MD5 a072727007bc066b3ca4f35d3cadd4e9
BLAKE2b-256 414f288fb4476f865d1cdc9e84ba267f347a7adc8b9a65cab35d3fab3de3c5ef

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page