python-cinderclient

OpenStack Block Storage API Client Library

These details have not been verified by PyPI

Project links

Homepage

Project description

http://governance.openstack.org/badges/python-cinderclient.svg

Python bindings to the OpenStack Cinder API

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
Online Documentation
Blueprints - feature specifications
Bugs - issue tracking
Source
Specs
How to Contribute

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/.

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

9.6.0

Aug 29, 2024

9.5.0

Mar 1, 2024

9.4.0

Sep 1, 2023

9.3.0

Feb 17, 2023

9.2.0

Dec 16, 2022

9.1.1

May 2, 2023

9.1.0

Aug 31, 2022

9.0.0

Jul 15, 2022

8.3.0

Feb 25, 2022

8.2.0

Nov 25, 2021

8.1.0

Sep 3, 2021

8.0.0

Jul 22, 2021

7.4.1

Sep 1, 2021

7.4.0

Mar 15, 2021

7.3.0

Jan 25, 2021

7.2.2

Sep 27, 2021

7.2.1

Mar 8, 2021

7.2.0

Sep 16, 2020

7.1.0

Jun 18, 2020

7.0.2

Nov 15, 2021

7.0.1

Mar 11, 2021

7.0.0

Apr 8, 2020

6.0.0

Feb 13, 2020

5.0.2

Apr 8, 2021

5.0.1

Mar 25, 2020

5.0.0

Sep 12, 2019

4.3.0

Aug 22, 2019

4.2.2

Mar 25, 2020

4.2.1

Jul 11, 2019

4.2.0

May 16, 2019

4.1.0

Oct 8, 2018

4.0.3

Mar 4, 2020

4.0.2

May 10, 2019

4.0.1

Aug 1, 2018

4.0.0

Jul 27, 2018

3.6.1

Jun 22, 2018

3.6.0

Jun 11, 2018

3.5.0

Jan 24, 2018

3.4.0

Jan 8, 2018

3.3.0

Dec 8, 2017

3.2.0

Aug 31, 2017

3.1.1

Feb 14, 2019

3.1.0

Jul 27, 2017

3.0.0

Jul 21, 2017

2.2.0

Jun 5, 2017

2.1.0

May 25, 2017

2.0.1

Mar 15, 2017

2.0.0

Mar 13, 2017

1.11.0

Jan 27, 2017

This version

1.10.0

Jan 12, 2017

1.9.0

Sep 1, 2016

1.8.0

Jun 1, 2016

1.7.1

May 26, 2016

1.7.0

May 19, 2016

1.6.0

Mar 3, 2016

1.5.0

Dec 1, 2015

1.4.0

Sep 11, 2015

1.3.1

Jul 8, 2015

1.3.0

Jul 8, 2015

1.2.2

Jun 9, 2015

1.2.1

May 7, 2015

1.2.0

Apr 21, 2015

1.1.3

Feb 16, 2016

1.1.2

Jul 23, 2015

1.1.1

Sep 26, 2014

1.1.0

Sep 13, 2014

1.0.9

Apr 21, 2014

1.0.8

Feb 5, 2014

1.0.7

Oct 31, 2013

1.0.6

Oct 4, 2013

1.0.5

Aug 6, 2013

1.0.4

May 2, 2013

1.0.3

Apr 1, 2013

1.0.2

Dec 21, 2012

1.0.1

Dec 6, 2012

1.0.0

Oct 1, 2012

0.2

Aug 14, 2012

0.1

Jun 30, 2012

Download files

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

Source Distribution

python-cinderclient-1.10.0.tar.gz (233.8 kB view details)

Uploaded Jan 12, 2017 Source

Built Distribution

python_cinderclient-1.10.0-py2.py3-none-any.whl (294.9 kB view details)

Uploaded Jan 12, 2017 Python 2 Python 3

File details

Details for the file python-cinderclient-1.10.0.tar.gz.

File metadata

Download URL: python-cinderclient-1.10.0.tar.gz
Upload date: Jan 12, 2017
Size: 233.8 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for python-cinderclient-1.10.0.tar.gz
Algorithm	Hash digest
SHA256	`08dde1df6dbbeebd6c338f8a4f375b86907dd5c0014d47a4d738a2ac06d98d61`
MD5	`7f2b8a6c3e8f5a684404a6088b1b6224`
BLAKE2b-256	`de14e4bd3212ac73e415f4e5dc99fc8becffdef54e97fde404e60d10c4838b33`

See more details on using hashes here.

Provenance

File details

Details for the file python_cinderclient-1.10.0-py2.py3-none-any.whl.

File metadata

Download URL: python_cinderclient-1.10.0-py2.py3-none-any.whl
Upload date: Jan 12, 2017
Size: 294.9 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for python_cinderclient-1.10.0-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`8b68cf7baf523b097f6097937aff5a84f0e0845e9a38f422a523cea60e0a4b28`
MD5	`921746a862d746f8348ee37063c853fd`
BLAKE2b-256	`a4cb44156c4a3abaf01445013feb43e6d2a64d050c0ad99bd2357985d80f7a58`