1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
|
Block Storage API
=================
For details on how to use block_storage, see :doc:`/user/guides/block_storage`
.. automodule:: openstack.block_storage.v3._proxy
The BlockStorage Class
----------------------
The block_storage high-level interface is available through the
``block_storage`` member of a :class:`~openstack.connection.Connection` object.
The ``block_storage`` member will only be added if the service is detected.
Volume Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: create_volume, delete_volume, get_volume, find_volume,
volumes, get_volume_metadata, set_volume_metadata,
delete_volume_metadata, extend_volume, set_volume_readonly,
retype_volume, set_volume_bootable_status, reset_volume_status,
revert_volume_to_snapshot, attach_volume, detach_volume,
unmanage_volume, migrate_volume, complete_volume_migration,
upload_volume_to_image, reserve_volume, unreserve_volume,
begin_volume_detaching, abort_volume_detaching,
init_volume_attachment, terminate_volume_attachment,
Backend Pools Operations
^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: backend_pools
Backup Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: create_backup, delete_backup, get_backup, find_backup, backups,
restore_backup, reset_backup,
Availability Zone Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: availability_zones
Limits Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: get_limits
Capabilities Operations
^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: get_capabilities
Group Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: create_group, create_group_from_source, delete_group, update_group,
get_group, find_group, groups, reset_group_state
Group Type Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: create_group_type, delete_group_type, update_group_type,
get_group_type, find_group_type, group_types,
fetch_group_type_group_specs, create_group_type_group_specs,
get_group_type_group_specs_property,
update_group_type_group_specs_property,
delete_group_type_group_specs_property
Type Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: create_type, delete_type, update_type, get_type, find_type, types,
update_type_extra_specs, delete_type_extra_specs, get_type_access,
add_type_access, remove_type_access, get_type_encryption,
create_type_encryption, delete_type_encryption,
update_type_encryption
Snapshot Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: create_snapshot, delete_snapshot, update_snapshot, get_snapshot,
find_snapshot, snapshots, get_snapshot_metadata,
set_snapshot_metadata, delete_snapshot_metadata, reset_snapshot,
set_snapshot_status
Stats Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: backend_pools
QuotaSet Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: get_quota_set, get_quota_set_defaults,
revert_quota_set, update_quota_set
Helpers
^^^^^^^
.. autoclass:: openstack.block_storage.v3._proxy.Proxy
:noindex:
:members: wait_for_status, wait_for_delete
|