
2.9.
CLASS: VM
CHAPTER 2.
API REFERENCE
RPC name: clean reboot
Overview:
Attempt to cleanly shutdown the specified VM (Note: this may not be supported—e.g. if a guest
agent is not installed). This can only be called when the specified VM is in the Running state.
Signature:
void clean_reboot (session_id s, VM ref vm)
Arguments:
type
name
description
VM ref
vm
The VM to shutdown
Return Type:
void
Possible Error Codes:
VM BAD POWER STATE
,
OTHER OPERATION IN PROGRESS
,
OPERATION NOT ALLOWED
,
VM IS TEMPLATE
RPC name: hard shutdown
Overview:
Stop executing the specified VM without attempting a clean shutdown.
Signature:
void hard_shutdown (session_id s, VM ref vm)
Arguments:
type
name
description
VM ref
vm
The VM to destroy
Return Type:
void
Possible Error Codes:
VM BAD POWER STATE
,
OTHER OPERATION IN PROGRESS
,
OPERATION NOT ALLOWED
,
VM IS TEMPLATE
RPC name: power state reset
Overview:
Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures
in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This
is a potentially dangerous operation; use with care.
Signature:
void power_state_reset (session_id s, VM ref vm)
Arguments:
type
name
description
VM ref
vm
The VM to reset
Return Type:
void
60