
2.9.
CLASS: VM
CHAPTER 2.
API REFERENCE
RPC name: pause
Overview:
Pause the specified VM. This can only be called when the specified VM is in the Running state.
Signature:
void pause (session_id s, VM ref vm)
Arguments:
type
name
description
VM ref
vm
The VM to pause
Return Type:
void
Possible Error Codes:
VM BAD POWER STATE
,
OTHER OPERATION IN PROGRESS
,
OPERATION NOT ALLOWED
,
VM IS TEMPLATE
RPC name: unpause
Overview:
Resume the specified VM. This can only be called when the specified VM is in the Paused state.
Signature:
void unpause (session_id s, VM ref vm)
Arguments:
type
name
description
VM ref
vm
The VM to unpause
Return Type:
void
Possible Error Codes:
VM BAD POWER STATE
,
OPERATION NOT ALLOWED
,
VM IS TEMPLATE
RPC name: clean shutdown
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_shutdown (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
59