For details on how to use block_storage, see Using OpenStack Block Storage
The block_storage high-level interface is available through the
block_storage
member of a Connection
object.
The block_storage
member will only be added if the service is detected.
openstack.block_storage.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)¶create_volume
(**attrs)¶Create a new volume from attributes
attrs (dict) – Keyword arguments which will be used to create
a Volume
,
comprised of the properties on the Volume class.
The results of volume creation
Volume
delete_volume
(volume, ignore_missing=True)¶Delete a volume
volume – The value can be either the ID of a volume or a
Volume
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the volume does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent volume.
None
get_volume
(volume)¶Get a single volume
volume – The value can be the ID of a volume or a
Volume
instance.
One Volume
ResourceNotFound
when no resource can be found.
volumes
(details=True, **query)¶Retrieve a generator of volumes
details (bool) – When set to False
no extended attributes
will be returned. The default, True
, will cause objects with
additional attributes to be returned.
query (kwargs) –
Optional query parameters to be sent to limit the volumes being returned. Available parameters include:
name: Name of the volume as a string.
all_projects: Whether return the volumes in all projects
on “available” for example.
A generator of volume objects.
openstack.block_storage.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_backup
(**attrs)¶Create a new Backup from attributes with native API
delete_backup
(backup, ignore_missing=True)¶Delete a CloudBackup
backup – The value can be the ID of a backup or a
Backup
instance
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when
the zone does not exist.
When set to True
, no exception will be set when attempting to
delete a nonexistent zone.
None
get_backup
(backup)¶Get a backup
backups
(details=True, **query)¶Retrieve a generator of backups
details (bool) – When set to False
no additional details will
be returned. The default, True
, will cause objects with
additional attributes to be returned.
query (dict) –
Optional query parameters to be sent to limit the resources being returned:
offset: pagination marker
limit: pagination limit
name, status, container_format, disk_format, size, id, created_at, or updated_at. Default is created_at. The API uses the natural sorting direction of the sort_key attribute value.
direction combinations. If you omit the sort direction in a set, default is desc.
A generator of backup objects.
restore_backup
(backup, volume_id, name)¶Restore a Backup to volume
openstack.block_storage.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_type
(**attrs)¶Create a new type from attributes
attrs (dict) – Keyword arguments which will be used to create
a Type
,
comprised of the properties on the Type class.
The results of type creation
Type
delete_type
(type, ignore_missing=True)¶Delete a type
type – The value can be either the ID of a type or a
Type
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the type does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent type.
None
get_type
(type)¶Get a single type
type – The value can be the ID of a type or a
Type
instance.
One Type
ResourceNotFound
when no resource can be found.
types
(**query)¶Retrieve a generator of volume types
A generator of volume type objects.
openstack.block_storage.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_snapshot
(**attrs)¶Create a new snapshot from attributes
attrs (dict) – Keyword arguments which will be used to create
a Snapshot
,
comprised of the properties on the Snapshot class.
The results of snapshot creation
Snapshot
delete_snapshot
(snapshot, ignore_missing=True)¶Delete a snapshot
snapshot – The value can be either the ID of a snapshot or a
Snapshot
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the snapshot does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent snapshot.
None
get_snapshot
(snapshot)¶Get a single snapshot
snapshot – The value can be the ID of a snapshot or a
Snapshot
instance.
One Snapshot
ResourceNotFound
when no resource can be found.
snapshots
(details=True, **query)¶Retrieve a generator of snapshots
details (bool) – When set to False
Snapshot
objects will be returned. The default, True
, will cause
SnapshotDetail
objects to be returned.
query (kwargs) –
Optional query parameters to be sent to limit the snapshots being returned. Available parameters include:
name: Name of the snapshot as a string.
all_projects: Whether return the snapshots in all projects.
volume_id: volume id of a snapshot.
filter on “available” for example.
A generator of snapshot objects.
openstack.block_storage.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)backend_pools
()¶Returns a generator of cinder Back-end storage pools
:returns A generator of cinder Back-end storage pools objects
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.