The cinderclient.v1.client Module

class cinderclient.v1.client.Client(username, api_key, project_id=None, auth_url='', insecure=False, timeout=None, tenant_id=None, proxy_tenant_id=None, proxy_token=None, region_name=None, endpoint_type='publicURL', extensions=None, service_type='volume', service_name=None, volume_service_name=None, retries=None, http_log_debug=False, cacert=None)

Bases: object

Top-level object to access the OpenStack Volume API.

Create an instance with your creds:

>>> client = Client(USERNAME, PASSWORD, PROJECT_ID, AUTH_URL)

Then call methods on its managers:

>>> client.volumes.list()
...

authenticate()

Authenticate against the server.

Normally this is called automatically when you first access the API, but you can call this method to force authentication right now.

Returns on success; raises exceptions.Unauthorized if the credentials are wrong.