The nova.compute.rpcapi Module

Client side of the compute RPC API.

class ComputeAPI

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

Client side of the compute rpc API.

API version history:

1.0 - Initial version. 1.1 - Adds get_host_uptime() 1.2 - Adds check_can_live_migrate_[destination|source] 1.3 - Adds change_instance_metadata() 1.4 - Remove instance_uuid, add instance argument to reboot_instance() 1.5 - Remove instance_uuid, add instance argument to pause_instance(),

unpause_instance()

1.6 - Remove instance_uuid, add instance argument to suspend_instance() 1.7 - Remove instance_uuid, add instance argument to

get_console_output()

1.8 - Remove instance_uuid, add instance argument to

add_fixed_ip_to_instance()

1.9 - Remove instance_uuid, add instance argument to attach_volume() 1.10 - Remove instance_id, add instance argument to

check_can_live_migrate_destination()

1.11 - Remove instance_id, add instance argument to

check_can_live_migrate_source()

1.12 - Remove instance_uuid, add instance argument to confirm_resize() 1.13 - Remove instance_uuid, add instance argument to detach_volume() 1.14 - Remove instance_uuid, add instance argument to finish_resize() 1.15 - Remove instance_uuid, add instance argument to

finish_revert_resize()

1.16 - Remove instance_uuid, add instance argument to get_diagnostics() 1.17 - Remove instance_uuid, add instance argument to get_vnc_console() 1.18 - Remove instance_uuid, add instance argument to inject_file() 1.19 - Remove instance_uuid, add instance argument to

inject_network_info()

1.20 - Remove instance_id, add instance argument to

post_live_migration_at_destination()

1.21 - Remove instance_uuid, add instance argument to

power_off_instance() and stop_instance()

1.22 - Remove instance_uuid, add instance argument to

power_on_instance() and start_instance()

1.23 - Remove instance_id, add instance argument to

pre_live_migration()

1.24 - Remove instance_uuid, add instance argument to

rebuild_instance()

1.25 - Remove instance_uuid, add instance argument to

remove_fixed_ip_from_instance()

1.26 - Remove instance_id, add instance argument to

remove_volume_connection()

1.27 - Remove instance_uuid, add instance argument to

rescue_instance()

1.28 - Remove instance_uuid, add instance argument to reset_network() 1.29 - Remove instance_uuid, add instance argument to resize_instance() 1.30 - Remove instance_uuid, add instance argument to resume_instance() 1.31 - Remove instance_uuid, add instance argument to revert_resize() 1.32 - Remove instance_id, add instance argument to

rollback_live_migration_at_destination()

1.33 - Remove instance_uuid, add instance argument to

set_admin_password()

1.34 - Remove instance_uuid, add instance argument to

snapshot_instance()

1.35 - Remove instance_uuid, add instance argument to

unrescue_instance()

1.36 - Remove instance_uuid, add instance argument to

change_instance_metadata()

1.37 - Remove instance_uuid, add instance argument to

terminate_instance()

1.38 - Changes to prep_resize():

• remove instance_uuid, add instance
• remove instance_type_id, add instance_type
• remove topic, it was unused

1.39 - Remove instance_uuid, add instance argument to run_instance() 1.40 - Remove instance_id, add instance argument to live_migration() 1.41 - Adds refresh_instance_security_rules() 1.42 - Add reservations arg to prep_resize(), resize_instance(),

finish_resize(), confirm_resize(), revert_resize() and finish_revert_resize()

1.43 - Add migrate_data to live_migration() 1.44 - Adds reserve_block_device_name()

2.0 - Remove 1.x backwards compat 2.1 - Adds orig_sys_metadata to rebuild_instance() 2.2 - Adds slave_info parameter to add_aggregate_host() and

remove_aggregate_host()

2.3 - Adds volume_id to reserve_block_device_name() 2.4 - Add bdms to terminate_instance 2.5 - Add block device and network info to reboot_instance 2.6 - Remove migration_id, add migration to resize_instance 2.7 - Remove migration_id, add migration to confirm_resize 2.8 - Remove migration_id, add migration to finish_resize 2.9 - Add publish_service_capabilities() 2.10 - Adds filter_properties and request_spec to prep_resize() 2.11 - Adds soft_delete_instance() and restore_instance() 2.12 - Remove migration_id, add migration to revert_resize 2.13 - Remove migration_id, add migration to finish_revert_resize 2.14 - Remove aggregate_id, add aggregate to add_aggregate_host 2.15 - Remove aggregate_id, add aggregate to remove_aggregate_host 2.16 - Add instance_type to resize_instance 2.17 - Add get_backdoor_port() 2.18 - Add bdms to rebuild_instance 2.19 - Add node to run_instance 2.20 - Add node to prep_resize 2.21 - Add migrate_data dict param to pre_live_migration() 2.22 - Add recreate, on_shared_storage and host arguments to

rebuild_instance()

2.23 - Remove network_info from reboot_instance 2.24 - Added get_spice_console method 2.25 - Add attach_interface() and detach_interface() 2.26 - Add validate_console_port to ensure the service connects to

vnc on the correct port

2.27 - Adds ‘reservations’ to terminate_instance() and

soft_delete_instance()

BASE_RPC_API_VERSION = '2.0'

add_aggregate_host(ctxt, aggregate, host_param, host, slave_info=None)

Add aggregate host.

Parameters:

• ctxt – request context
• aggregate_id –
• host_param – This value is placed in the message to be the ‘host’ parameter for the remote method.
• host – This is the host to send the message to.

add_fixed_ip_to_instance(ctxt, instance, network_id)

attach_interface(ctxt, instance, network_id, port_id, requested_ip)

attach_volume(ctxt, instance, volume_id, mountpoint)

change_instance_metadata(ctxt, instance, diff)

check_can_live_migrate_destination(ctxt, instance, destination, block_migration, disk_over_commit)

check_can_live_migrate_source(ctxt, instance, dest_check_data)

confirm_resize(ctxt, instance, migration, host, reservations=None, cast=True)

detach_interface(ctxt, instance, port_id)

detach_volume(ctxt, instance, volume_id)

finish_resize(ctxt, instance, migration, image, disk_info, host, reservations=None)

finish_revert_resize(ctxt, instance, migration, host, reservations=None)

get_backdoor_port(ctxt, host)

get_console_output(ctxt, instance, tail_length)

get_console_pool_info(ctxt, console_type, host)

get_console_topic(ctxt, host)

get_diagnostics(ctxt, instance)

get_host_uptime(ctxt, host)

get_spice_console(ctxt, instance, console_type)

get_vnc_console(ctxt, instance, console_type)

host_maintenance_mode(ctxt, host_param, mode, host)

Set host maintenance mode

Parameters:

• ctxt – request context
• host_param – This value is placed in the message to be the ‘host’ parameter for the remote method.
• mode –
• host – This is the host to send the message to.

host_power_action(ctxt, action, host)

inject_file(ctxt, instance, path, file_contents)

inject_network_info(ctxt, instance)

live_migration(ctxt, instance, dest, block_migration, host, migrate_data=None)

pause_instance(ctxt, instance)

post_live_migration_at_destination(ctxt, instance, block_migration, host)

power_off_instance(ctxt, instance)

power_on_instance(ctxt, instance)

pre_live_migration(ctxt, instance, block_migration, disk, host, migrate_data=None)

prep_resize(ctxt, image, instance, instance_type, host, reservations=None, request_spec=None, filter_properties=None, node=None)

publish_service_capabilities(ctxt)

reboot_instance(ctxt, instance, block_device_info, reboot_type)

rebuild_instance(ctxt, instance, new_pass, injected_files, image_ref, orig_image_ref, orig_sys_metadata, bdms, recreate=False, on_shared_storage=False, host=None)

refresh_provider_fw_rules(ctxt, host)

remove_aggregate_host(ctxt, aggregate, host_param, host, slave_info=None)

Remove aggregate host.

Parameters:

• ctxt – request context
• aggregate_id –
• host_param – This value is placed in the message to be the ‘host’ parameter for the remote method.
• host – This is the host to send the message to.

remove_fixed_ip_from_instance(ctxt, instance, address)

remove_volume_connection(ctxt, instance, volume_id, host)

rescue_instance(ctxt, instance, rescue_password)

reserve_block_device_name(ctxt, instance, device, volume_id)

reset_network(ctxt, instance)

resize_instance(ctxt, instance, migration, image, instance_type, reservations=None)

restore_instance(ctxt, instance)

resume_instance(ctxt, instance)

revert_resize(ctxt, instance, migration, host, reservations=None)

rollback_live_migration_at_destination(ctxt, instance, host)

run_instance(ctxt, instance, host, request_spec, filter_properties, requested_networks, injected_files, admin_password, is_first_time, node=None)

set_admin_password(ctxt, instance, new_pass)

set_host_enabled(ctxt, enabled, host)

snapshot_instance(ctxt, instance, image_id, image_type, backup_type=None, rotation=None)

soft_delete_instance(ctxt, instance, reservations=None)

start_instance(ctxt, instance)

stop_instance(ctxt, instance, cast=True)

suspend_instance(ctxt, instance)

terminate_instance(ctxt, instance, bdms, reservations=None)

unpause_instance(ctxt, instance)

unrescue_instance(ctxt, instance)

validate_console_port(ctxt, instance, port, console_type)

class SecurityGroupAPI

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

Client side of the security group rpc API.

API version history:

1.0 - Initial version. 1.41 - Adds refresh_instance_security_rules()

2.0 - Remove 1.x backwards compat

BASE_RPC_API_VERSION = '2.0'

refresh_instance_security_rules(ctxt, host, instance)

refresh_security_group_members(ctxt, security_group_id, host)

refresh_security_group_rules(ctxt, security_group_id, host)