Client library for OpenStack Compute 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.
python-novaclient is licensed under the Apache License like the rest of OpenStack.
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-project-name params, but it’s easier to just set them as environment variables:
export OS_USERNAME=<username> export OS_PASSWORD=<password> export OS_PROJECT_NAME=<project-name>
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 environment variables as well and set the OS_AUTH_URL to the keystone endpoint:
export OS_AUTH_URL=http://<url-to-openstack-keystone>:5000/v3/ export OS_COMPUTE_API_VERSION=2.1
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
There’s also a complete Python API, with documentation linked below.
To use with keystone as the authentication system:
>>> from keystoneauth1.identity import v3 >>> from keystoneauth1 import session >>> from novaclient import client >>> auth = v3.Password(auth_url='http://example.com:5000/v3', ... username='username', ... password='password', ... project_name='project-name', ... user_domain_id='default', ... project_domain_id='default') >>> sess = session.Session(auth=auth) >>> nova = client.Client("2.1", session=sess) >>> nova.flavors.list() [...] >>> nova.servers.list() [...] >>> nova.keypairs.list() [...]
There are multiple test targets that can be run to validate the code.
Functional testing assumes the existence of a clouds.yaml file as supported by os-client-config (http://docs.openstack.org/developer/os-client-config) It assumes the existence of a cloud named devstack that behaves like a normal devstack installation with a demo and an admin user/tenant - or clouds named functional_admin and functional_nonadmin.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|python_novaclient-9.0.1-py2.py3-none-any.whl (303.2 kB) Copy SHA256 Checksum SHA256||py2.py3||Wheel||Jun 16, 2017|
|python-novaclient-9.0.1.tar.gz (266.0 kB) Copy SHA256 Checksum SHA256||–||Source||Jun 16, 2017|