OpenStack Block Storage API Client Library
Project description
This is a client for the OpenStack Cinder API. There’s a Python API (the cinderclient module), and a command-line script (cinder). Each implements 100% of the OpenStack Cinder API.
See the OpenStack CLI Reference for information on how to use the cinder 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 OpenStack. Patches must be submitted using Gerrit.
This code is a fork of Jacobian’s python-cloudservers. If you need API support for the Rackspace API solely or the BSD license, you should use that repository. python-cinderclient is licensed under the Apache License like the rest of OpenStack.
License: Apache License, Version 2.0
PyPi - package installation
Blueprints - feature specifications
Bugs - issue tracking
Command-line API
Installing this package gets you a shell command, cinder, that you can use to interact with any Rackspace compatible API (including OpenStack).
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-volume-api-version. Or set them as environment variables as well:
export OS_AUTH_URL=http://example.com:8774/v1.1/ export OS_VOLUME_API_VERSION=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 cinder help:
usage: cinder [--debug] [--os-username <auth-user-name>]
[--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>] [--os-auth-url <auth-url>]
[--os-region-name <region-name>] [--service-type <service-type>]
[--service-name <service-name>]
[--volume-service-name <volume-service-name>]
[--endpoint-type <endpoint-type>]
[--os-volume-api-version <compute-api-ver>]
[--os-cacert <ca-certificate>] [--retries <retries>]
<subcommand> ...
Command-line interface to the OpenStack Cinder API.
Positional arguments:
<subcommand>
absolute-limits Print a list of absolute limits for a user
create Add a new volume.
credentials Show user credentials returned from auth
delete Remove a volume.
endpoints Discover endpoints that get returned from the
authenticate services
extra-specs-list Print a list of current 'volume types and extra specs'
(Admin Only).
list List all the volumes.
quota-class-show List the quotas for a quota class.
quota-class-update Update the quotas for a quota class.
quota-defaults List the default quotas for a tenant.
quota-show List the quotas for a tenant.
quota-update Update the quotas for a tenant.
rate-limits Print a list of rate limits for a user
rename Rename a volume.
show Show details about a volume.
snapshot-create Add a new snapshot.
snapshot-delete Remove a snapshot.
snapshot-list List all the snapshots.
snapshot-rename Rename a snapshot.
snapshot-show Show details about a snapshot.
type-create Create a new volume type.
type-delete Delete a specific volume type
type-key Set or unset extra_spec for a volume type.
type-list Print a list of available 'volume types'.
bash-completion Prints all of the commands and options to stdout so
that the
help Display help about this program or one of its
subcommands.
list-extensions List all the os-api extensions that are available.
Optional arguments:
-d, --debug Print debugging output
--os-username <auth-user-name>
Defaults to env[OS_USERNAME].
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-auth-url <auth-url>
Defaults to env[OS_AUTH_URL].
--os-region-name <region-name>
Defaults to env[OS_REGION_NAME].
--service-type <service-type>
Defaults to compute for most actions
--service-name <service-name>
Defaults to env[CINDER_SERVICE_NAME]
--volume-service-name <volume-service-name>
Defaults to env[CINDER_VOLUME_SERVICE_NAME]
--endpoint-type <endpoint-type>
Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL.
--os-volume-api-version <compute-api-ver>
Accepts 1,defaults to env[OS_VOLUME_API_VERSION].
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--retries <retries> Number of retries.
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 cinderclient.v1 import client >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="volume") >>> nt.volumes.list() [...]
See release notes and more at http://docs.openstack.org/developer/python-cinderclient/.
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
Built Distribution
Hashes for python-cinderclient-1.8.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 63c0ae43eec773fb4c738be1e09eeb1c4c1fcadc70f154b2572b71ceb1f192a7 |
|
| MD5 | 64e521c75b96a9eae14c0fa51999a0e5 |
|
| BLAKE2b-256 | 1b1c70292b923f01d20c859a9daadf3addd7f0956f13894d2024e6d6f9042453 |
Hashes for python_cinderclient-1.8.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3f784f811b0fa3fbc45fe699979517ed16b68715215cfdcee8ec06ce1cd685cb |
|
| MD5 | ea1c9aebcd95c5f7b96cf4b5c19dab30 |
|
| BLAKE2b-256 | 19e53a1b20058e4843199cda55aca4a79ccd0cb07f84ecf3556ad568edaa4cc4 |
