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
2.1 - Adds support for sending objects over RPC in manage_existing()
2.2 - Sends request_spec as object in create_volume()
2.3 - Add create_group method

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

3.0 - Remove 2.x compatibility
3.1 - Adds notify_service_capabilities()
3.2 - Adds extend_volume()
3.3 - Add cluster support to migrate_volume, and to
      update_service_capabilities and send the timestamp from the
      capabilities.
3.4 - Adds work_cleanup and do_cleanup methods.
3.5 - Make notify_service_capabilities support A/A

BINARY = 'cinder-scheduler'

RPC_API_VERSION = '3.5'

RPC_DEFAULT_VERSION = '3.0'

TOPIC = 'cinder-scheduler'

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

create_group(ctxt, group, group_spec=None, request_spec_list=None, group_filter_properties=None, filter_properties_list=None)

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

do_cleanup(*args, **kwargs)

Perform this scheduler’s resource cleanup as per cleanup_request.

extend_volume(*args, **kwargs)

get_pools(ctxt, filters=None)

manage_existing(ctxt, volume, request_spec=None, filter_properties=None)

migrate_volume(ctxt, volume, backend, force_copy=False, request_spec=None, filter_properties=None)

notify_service_capabilities(*args, **kwargs)

static prepare_timestamp(timestamp)

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

update_service_capabilities(ctxt, service_name, host, capabilities, cluster_name, timestamp=None)

work_cleanup(*args, **kwargs)

Generate individual service cleanup requests from user request.