where to get cinder blocks

Team and repository tags

Python bindings to the OpenStack Cinder API

This is a customer 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 control-line tool. You lot may as well want to look at the OpenStack API documentation.

The project is hosted on Launchpad, where bugs can exist filed. The lawmaking is hosted on OpenStack. Patches must be submitted using Gerrit.

License: Apache License, Version 2.0
PyPi - parcel installation
Online Documentation
Blueprints - feature specifications
Bugs - issue tracking
Source
Specs
How to Contribute

Contents:

Command-line API
Python API

Command-line API

Installing this parcel gets yous a beat out command, cinder, that y'all can use to interact with whatever 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 --bone-tenant-proper name params, but it's easier to just fix them as surroundings 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 besides. Since Block Storage API V2 is officially deprecated, you are encouraged to set OS_VOLUME_API_VERSION=3. If you are using Keystone, you need to set the OS_AUTH_URL to the keystone endpoint:

consign OS_AUTH_URL=http://controller:5000/v3 consign OS_VOLUME_API_VERSION=3

Since Keystone can return multiple regions in the Service Itemize, y'all can specify the one y'all want with --os-region-name (or export OS_REGION_NAME). It defaults to the first in the list returned.

You lot'll notice complete documentation on the shell by running cinder help:

usage: cinder [--version] [-d] [--os-auth-system <auth-system>]               [--service-blazon <service-type>] [--service-name <service-name>]               [--volume-service-name <volume-service-name>]               [--os-endpoint-type <os-endpoint-type>]               [--endpoint-type <endpoint-type>]               [--os-volume-api-version <book-api-ver>]               [--retries <retries>]               [--profile HMAC_KEY] [--os-auth-strategy <auth-strategy>]               [--os-username <auth-user-proper name>] [--os-password <auth-password>]               [--bone-tenant-name <auth-tenant-name>]               [--os-tenant-id <auth-tenant-id>] [--bone-auth-url <auth-url>]               [--os-user-id <auth-user-id>]               [--os-user-domain-id <auth-user-domain-id>]               [--bone-user-domain-proper noun <auth-user-domain-name>]               [--os-project-id <auth-projection-id>]               [--os-project-proper name <auth-project-proper noun>]               [--os-projection-domain-id <auth-project-domain-id>]               [--bone-project-domain-name <auth-project-domain-name>]               [--os-region-name <region-proper name>] [--os-token <token>]               [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]               [--os-cert <certificate>] [--os-fundamental <central>] [--timeout <seconds>]               <subcommand> ...  Control-line interface to the OpenStack Cinder API.  Positional arguments:   <subcommand>     absolute-limits     Lists absolute limits for a user.     api-version         Brandish the server API version data. (Supported                         by API versions 3.0 - 3.latest)     availability-zone-listing                         Lists all availability zones.     backup-create       Creates a volume backup.     backup-delete       Removes 1 or more backups.     backup-export       Export backup metadata record.     backup-import       Import backup metadata record.     fill-in-list         Lists all backups.     backup-reset-state  Explicitly updates the backup state.     backup-restore      Restores a backup.     backup-show         Shows backup details.     cgsnapshot-create   Creates a cgsnapshot.     cgsnapshot-delete   Removes 1 or more than cgsnapshots.     cgsnapshot-listing     Lists all cgsnapshots.     cgsnapshot-show     Shows cgsnapshot details.     consisgroup-create  Creates a consistency group.     consisgroup-create-from-src                         Creates a consistency group from a cgsnapshot or a                         source CG.     consisgroup-delete  Removes one or more consistency groups.     consisgroup-list    Lists all consistency groups.     consisgroup-show    Shows details of a consistency group.     consisgroup-update  Updates a consistency group.     create              Creates a book.     credentials         Shows user credentials returned from auth.     delete              Removes 1 or more volumes.     encryption-type-create                         Creates encryption type for a volume blazon. Admin simply.     encryption-type-delete                         Deletes encryption blazon for a volume type. Admin only.     encryption-blazon-list                         Shows encryption type details for volume types. Admin                         merely.     encryption-type-bear witness                         Shows encryption type details for a volume type. Admin                         only.     encryption-type-update                         Update encryption type data for a volume blazon                         (Admin Merely).     endpoints           Discovers endpoints registered past hallmark                         service.     extend              Attempts to extend size of an existing volume.     extra-specs-list    Lists current volume types and extra specs.     failover-host       Failover a replicating cinder-volume host.     strength-delete        Attempts force-delete of volume, regardless of state.     freeze-host         Freeze and disable the specified cinder-volume host.     become-capabilities    Show backend volume stats and backdrop. Admin only.     go-pools           Show pool information for backends. Admin just.     image-metadata      Sets or deletes volume prototype metadata.     image-metadata-show                         Shows book image metadata.     list                Lists all volumes.     manage              Manage an existing book.     metadata            Sets or deletes volume metadata.     metadata-prove       Shows volume metadata.     metadata-update-all                         Updates book metadata.     migrate             Migrates book to a new host.     qos-associate       Assembly qos specs with specified volume type.     qos-create          Creates a qos specs.     qos-delete          Deletes a specified qos specs.     qos-disassociate    Disassociates qos specs from specified book type.     qos-disassociate-all                         Disassociates qos specs from all its associations.     qos-get-association                         Lists all associations for specified qos specs.     qos-key             Sets or unsets specifications for a qos spec.     qos-list            Lists qos specs.     qos-show            Shows qos specs details.     quota-class-prove    Lists quotas for a quota class.     quota-class-update  Updates quotas for a quota class.     quota-defaults      Lists default quotas for a tenant.     quota-delete        Delete the quotas for a tenant.     quota-show          Lists quotas for a tenant.     quota-update        Updates quotas for a tenant.     quota-usage         Lists quota usage for a tenant.     rate-limits         Lists rate limits for a user.     readonly-mode-update                         Updates volume read-just admission-mode flag.     rename              Renames a volume.     reset-state         Explicitly updates the volume land in the Cinder                         database.     retype              Changes the book type for a volume.     service-disable     Disables the service.     service-enable      Enables the service.     service-list        Lists all services. Filter by host and service binary.                         (Supported past API versions 3.0 - 3.latest)     set up-bootable        Update bootable status of a volume.     testify                Shows volume details.     snapshot-create     Creates a snapshot.     snapshot-delete     Removes one or more snapshots.     snapshot-list       Lists all snapshots.     snapshot-manage     Manage an existing snapshot.     snapshot-metadata   Sets or deletes snapshot metadata.     snapshot-metadata-testify                         Shows snapshot metadata.     snapshot-metadata-update-all                         Updates snapshot metadata.     snapshot-rename     Renames a snapshot.     snapshot-reset-state                         Explicitly updates the snapshot country.     snapshot-bear witness       Shows snapshot details.     snapshot-unmanage   End managing a snapshot.     thaw-host           Thaw and enable the specified cinder-volume host.     transfer-accept     Accepts a book transfer.     transfer-create     Creates a volume transfer.     transfer-delete     Undoes a transfer.     transfer-list       Lists all transfers.     transfer-show       Shows transfer details.     type-access-add     Adds volume type access for the given project.     type-admission-list    Print access information about the given book type.     blazon-access-remove  Removes volume type access for the given projection.     blazon-create         Creates a volume type.     type-default        List the default volume type.     type-delete         Deletes volume type or types.     type-key            Sets or unsets extra_spec for a book type.     blazon-list           Lists available 'volume types'.     type-show           Show book type details.     blazon-update         Updates volume type proper noun, description, and/or                         is_public.     unmanage            Cease managing a volume.     upload-to-image     Uploads volume to Image Service as an image.     version-list        List all API versions. (Supported past API versions 3.0                         - three.latest)     bash-completion     Prints arguments for bash_completion.     help                Shows assistance about this program or one of its                         subcommands.     listing-extensions  Optional arguments:   --version             evidence program's version number and exit   -d, --debug           Shows debugging output.   --os-auth-system <auth-organization>                         Defaults to env[OS_AUTH_SYSTEM].   --service-type <service-type>                         Service blazon. For most actions, default is volume.   --service-name <service-name>                         Service name. Default=env[CINDER_SERVICE_NAME].   --volume-service-name <volume-service-name>                         Book service name.                         Default=env[CINDER_VOLUME_SERVICE_NAME].   --os-endpoint                         Use this API endpoint instead of the Service Itemize.                         Default=env[CINDER_ENDPOINT]   --bone-endpoint-type <os-endpoint-type>                         Endpoint type, which is publicURL or internalURL.                         Default=env[OS_ENDPOINT_TYPE] or nova                         env[CINDER_ENDPOINT_TYPE] or publicURL.   --endpoint-type <endpoint-type>                         DEPRECATED! Use --os-endpoint-blazon.   --bone-book-api-version <volume-api-ver>                         Block Storage API version. Accepts Ten, 10.Y (where 10 is                         major and Y is pocket-sized                         role).Default=env[OS_VOLUME_API_VERSION].   --retries <retries>   Number of retries.   --profile HMAC_KEY    HMAC cardinal to use for encrypting context information for                         performance profiling of operation. This key needs to                         match the one configured on the cinder api server.                         Without key the profiling will non be triggered even                         if osprofiler is enabled on server side.                         Defaults to env[OS_PROFILE].   --os-auth-strategy <auth-strategy>                         Authentication strategy (Env: OS_AUTH_STRATEGY,                         default keystone). For now, any other value will                         disable the authentication.   --bone-username <auth-user-name>                         OpenStack user name. Default=env[OS_USERNAME].   --bone-password <auth-password>                         Countersign for OpenStack user. Default=env[OS_PASSWORD].   --os-tenant-name <auth-tenant-proper noun>                         Tenant name. Default=env[OS_TENANT_NAME].   --os-tenant-id <auth-tenant-id>                         ID for the tenant. Default=env[OS_TENANT_ID].   --os-auth-url <auth-url>                         URL for the hallmark service.                         Default=env[OS_AUTH_URL].   --bone-user-id <auth-user-id>                         Hallmark user ID (Env: OS_USER_ID).   --os-user-domain-id <auth-user-domain-id>                         OpenStack user domain ID. Defaults to                         env[OS_USER_DOMAIN_ID].   --os-user-domain-name <auth-user-domain-name>                         OpenStack user domain proper noun. Defaults to                         env[OS_USER_DOMAIN_NAME].   --os-project-id <auth-project-id>                         Some other fashion to specify tenant ID. This option is                         mutually exclusive with --bone-tenant-id. Defaults to                         env[OS_PROJECT_ID].   --bone-projection-name <auth-projection-name>                         Another way to specify tenant proper name. This selection is                         mutually exclusive with --os-tenant-name. Defaults to                         env[OS_PROJECT_NAME].   --os-project-domain-id <auth-projection-domain-id>                         Defaults to env[OS_PROJECT_DOMAIN_ID].   --os-project-domain-name <auth-project-domain-name>                         Defaults to env[OS_PROJECT_DOMAIN_NAME].   --bone-region-name <region-name>                         Region name. Default=env[OS_REGION_NAME].   --os-token <token>    Defaults to env[OS_TOKEN].   --bone-url <url>        Defaults to env[OS_URL].  API Connectedness Options:   Options controlling the HTTP API Connections    --insecure            Explicitly allow client to perform "insecure" TLS                         (https) requests. The server'due south certificate will not be                         verified against whatsoever certificate authorities. This                         selection should be used with caution.   --os-cacert <ca-certificate>                         Specify a CA bundle file to employ in verifying a TLS                         (https) server certificate. Defaults to                         env[OS_CACERT].   --bone-cert <certificate>                         Defaults to env[OS_CERT].   --os-primal <key>        Defaults to env[OS_KEY].   --timeout <seconds>   Set request timeout (in seconds).  Run "cinder help SUBCOMMAND" for help on a subcommand.

If you desire to get a item version API help message, you can add --os-volume-api-version <volume-api-ver> in help command, similar this:

cinder --bone-volume-api-version three.28 assistance

Python API

There'south also a consummate Python API, but it has non yet been documented.

Quick-start using keystone:

# use v3 auth with http://controller:5000/v3 >>> from cinderclient.v3 import customer >>> nt = customer.Client(USERNAME, Countersign, PROJECT_ID, AUTH_URL) >>> nt.volumes.list() [...]

See release notes and more than at https://docs.openstack.org/python-cinderclient/latest/.