The cinder.volume.rpcapi Module

Client side of the volume RPC API.

class VolumeAPI(topic=None)

Bases: cinder.openstack.common.rpc.proxy.RpcProxy

Client side of the volume rpc API.

API version history:

1.0 - Initial version. 1.1 - Adds clone volume option to create_volume. 1.2 - Add publish_service_capabilities() method. 1.3 - Pass all image metadata (not just ID) in copy_volume_to_image. 1.4 - Add request_spec, filter_properties and

allow_reschedule arguments to create_volume().

1.5 - Add accept_transfer. 1.6 - Add extend_volume. 1.7 - Adds host_name parameter to attach_volume()

to allow attaching to host rather than instance.

1.8 - Add migrate_volume, rename_volume. 1.9 - Add new_user and new_project to accept_transfer. 1.10 - Add migrate_volume_completion, remove rename_volume. 1.11 - Adds mode parameter to attach_volume()

to support volume read-only attaching.
BASE_RPC_API_VERSION = '1.0'
accept_transfer(ctxt, volume, new_user, new_project)
attach_volume(ctxt, volume, instance_uuid, host_name, mountpoint, mode)
copy_volume_to_image(ctxt, volume, image_meta)
create_snapshot(ctxt, volume, snapshot)
create_volume(ctxt, volume, host, request_spec, filter_properties, allow_reschedule=True, snapshot_id=None, image_id=None, source_volid=None)
delete_snapshot(ctxt, snapshot, host)
delete_volume(ctxt, volume)
detach_volume(ctxt, volume)
extend_volume(ctxt, volume, new_size)
initialize_connection(ctxt, volume, connector)
migrate_volume(ctxt, volume, dest_host, force_host_copy)
migrate_volume_completion(ctxt, volume, new_volume, error)
publish_service_capabilities(ctxt)
terminate_connection(ctxt, volume, connector, force=False)

Previous topic

The cinder.volume.qos_specs Module

Next topic

The cinder.volume.utils Module

This Page