The cinder.scheduler.rpcapi Module

Client side of the scheduler manager RPC API.

class SchedulerAPI

Bases: cinder.rpc.RPCAPI

Client side of the scheduler rpc API.

API version history:

1.0 - Initial version. 1.1 - Add create_volume() method 1.2 - Add request_spec, filter_properties arguments

to create_volume()

1.3 - Add migrate_volume_to_host() method 1.4 - Add retype method 1.5 - Add manage_existing method 1.6 - Add create_consistencygroup method 1.7 - Add get_active_pools method 1.8 - Add sending object over RPC in create_consistencygroup method 1.9 - Adds support for sending objects over RPC in create_volume() 1.10 - Adds support for sending objects over RPC in retype() 1.11 - Adds support for sending objects over RPC in

migrate_volume_to_host()

... Mitaka supports messaging 1.11. Any changes to existing methods in 1.x after this point should be done so that they can handle version cap set to 1.11.

2.0 - Remove 1.x compatibility

BINARY = 'cinder-scheduler'

RPC_API_VERSION = '2.0'

TOPIC = 'cinder-scheduler'

create_consistencygroup(ctxt, topic, group, request_spec_list=None, filter_properties_list=None)

create_volume(ctxt, topic, volume_id, snapshot_id=None, image_id=None, request_spec=None, filter_properties=None, volume=None)

get_pools(ctxt, filters=None)

manage_existing(ctxt, topic, volume_id, request_spec=None, filter_properties=None)

migrate_volume_to_host(ctxt, topic, volume_id, host, force_host_copy=False, request_spec=None, filter_properties=None, volume=None)

retype(ctxt, topic, volume_id, request_spec=None, filter_properties=None, volume=None)

update_service_capabilities(ctxt, service_name, host, capabilities)