======================== Team and repository tags ======================== .. image:: http://governance.openstack.org/badges/python-cinderclient.svg :target: http://governance.openstack.org/reference/tags/index.html .. Change things from this point on Python bindings to the OpenStack Cinder API =========================================== .. image:: https://img.shields.io/pypi/v/python-cinderclient.svg :target: https://pypi.python.org/pypi/python-cinderclient/ :alt: Latest Version .. image:: https://img.shields.io/pypi/dm/python-cinderclient.svg :target: https://pypi.python.org/pypi/python-cinderclient/ :alt: Downloads 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`_. .. _OpenStack CLI Reference: http://docs.openstack.org/cli-reference/overview.html .. _OpenStack API documentation: http://developer.openstack.org/api-ref.html The project is hosted on `Launchpad`_, where bugs can be filed. The code is hosted on `OpenStack`_. Patches must be submitted using `Gerrit`_. .. _OpenStack: https://git.openstack.org/cgit/openstack/python-cinderclient .. _Launchpad: https://launchpad.net/python-cinderclient .. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow 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. __ https://github.com/jacobian-archive/python-cloudservers * License: Apache License, Version 2.0 * `PyPi`_ - package installation * `Online Documentation`_ * `Blueprints`_ - feature specifications * `Bugs`_ - issue tracking * `Source`_ * `Specs`_ * `How to Contribute`_ .. _PyPi: https://pypi.python.org/pypi/python-cinderclient .. _Online Documentation: http://docs.openstack.org/developer/python-cinderclient .. _Blueprints: https://blueprints.launchpad.net/python-cinderclient .. _Bugs: https://bugs.launchpad.net/python-cinderclient .. _Source: https://git.openstack.org/cgit/openstack/python-cinderclient .. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html .. _Specs: http://specs.openstack.org/openstack/cinder-specs/ .. contents:: Contents: :local: 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 ] [--os-password ] [--os-tenant-name ] [--os-auth-url ] [--os-region-name ] [--service-type ] [--service-name ] [--volume-service-name ] [--endpoint-type ] [--os-volume-api-version ] [--os-cacert ] [--retries ] ... Command-line interface to the OpenStack Cinder API. Positional arguments: 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 Defaults to env[OS_USERNAME]. --os-password Defaults to env[OS_PASSWORD]. --os-tenant-name Defaults to env[OS_TENANT_NAME]. --os-auth-url Defaults to env[OS_AUTH_URL]. --os-region-name Defaults to env[OS_REGION_NAME]. --service-type Defaults to compute for most actions --service-name Defaults to env[CINDER_SERVICE_NAME] --volume-service-name Defaults to env[CINDER_VOLUME_SERVICE_NAME] --endpoint-type Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL. --os-volume-api-version Accepts 1,defaults to env[OS_VOLUME_API_VERSION]. --os-cacert Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT] --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 ``_.