Previous topic

The nova.compute.power_state Module

Next topic

The nova.compute.task_states Module

This Page

Psst... hey. You're reading the latest content, but it might be out of sync with code. You can read Nova 2011.2 docs or all OpenStack docs too.

The nova.compute.rpcapi Module

Client side of the compute RPC API.

class ComputeAPI

Bases: nova.rpc.proxy.RpcProxy, nova.db.base.Base

Client side of the compute rpc API.

API version history:

1.0 - Initial version.
RPC_API_VERSION = '1.0'
add_aggregate_host(ctxt, aggregate_id, host_param, host)

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_volume(ctxt, instance, volume_id, mountpoint)
confirm_resize(ctxt, instance, migration_id, host, cast=True)
detach_volume(ctxt, instance, volume_id)
get_console_output(ctxt, instance, tail_length)
get_diagnostics(ctxt, instance)
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)
lock_instance(ctxt, instance)
pause_instance(ctxt, instance)
power_off_instance(ctxt, instance)
power_on_instance(ctxt, instance)
reboot_instance(ctxt, instance, reboot_type)
rebuild_instance(ctxt, instance, new_pass, injected_files, image_ref, orig_image_ref)
refresh_security_group_members(ctxt, security_group_id, host)
refresh_security_group_rules(ctxt, security_group_id, host)
remove_aggregate_host(ctxt, aggregate_id, host_param, host)

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)
rescue_instance(ctxt, instance, rescue_password)
reset_network(ctxt, instance)
resume_instance(ctxt, instance)
revert_resize(ctxt, instance, migration_id, host)
set_admin_password(ctxt, instance, new_pass)
set_host_enabled(ctxt, enabled, host)
snapshot_instance(ctxt, instance, image_id, image_type, backup_type, rotation)
start_instance(ctxt, instance)
stop_instance(ctxt, instance, cast=True)
suspend_instance(ctxt, instance)
terminate_instance(ctxt, instance)
unlock_instance(ctxt, instance)
unpause_instance(ctxt, instance)
unrescue_instance(ctxt, instance)