View Source XenAPI.VMAppliance (XenAPI v0.3.1)
VM appliance
Link to this section Summary
Functions
Assert whether all SRs required to recover this VM appliance are available.
Assert whether all SRs required to recover this VM appliance are available. (Raise error on XMLRPC failure)
Perform a clean shutdown of all the VMs in the appliance
Perform a clean shutdown of all the VMs in the appliance (Raise error on XMLRPC failure)
Create a new VM_appliance instance, and return its handle. The constructor args are: name_label, name_description (* = non-optional).
Create a new VM_appliance instance, and return its handle. The constructor args are: name_label, name_description (* = non-optional). (Raise error on XMLRPC failure)
Destroy the specified VM_appliance instance.
Destroy the specified VM_appliance instance. (Raise error on XMLRPC failure)
Return a list of all the VM_appliances known to the system.
Return a list of all the VM_appliances known to the system. (Raise error on XMLRPC failure)
Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system.
Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given VM_appliance.
Get the allowed_operations field of the given VM_appliance. (Raise error on XMLRPC failure)
Get all the VM_appliance instances with the given label.
Get all the VM_appliance instances with the given label. (Raise error on XMLRPC failure)
Get a reference to the VM_appliance instance with the specified UUID.
Get a reference to the VM_appliance instance with the specified UUID. (Raise error on XMLRPC failure)
Get the current_operations field of the given VM_appliance.
Get the current_operations field of the given VM_appliance. (Raise error on XMLRPC failure)
Get the name/description field of the given VM_appliance.
Get the name/description field of the given VM_appliance. (Raise error on XMLRPC failure)
Get the name/label field of the given VM_appliance.
Get the name/label field of the given VM_appliance. (Raise error on XMLRPC failure)
Get a record containing the current state of the given VM_appliance. Returns XenAPI.VMAppliance
struct.
Get a record containing the current state of the given VM_appliance. Returns XenAPI.VMAppliance
struct. (Raise error on XMLRPC failure)
Get the list of SRs required by the VM appliance to recover.
Get the list of SRs required by the VM appliance to recover. (Raise error on XMLRPC failure)
Get the uuid field of the given VM_appliance.
Get the uuid field of the given VM_appliance. (Raise error on XMLRPC failure)
Get the VMs field of the given VM_appliance.
Get the VMs field of the given VM_appliance. (Raise error on XMLRPC failure)
Perform a hard shutdown of all the VMs in the appliance
Perform a hard shutdown of all the VMs in the appliance (Raise error on XMLRPC failure)
Recover the VM appliance
Recover the VM appliance (Raise error on XMLRPC failure)
Set the name/description field of the given VM_appliance.
Set the name/description field of the given VM_appliance. (Raise error on XMLRPC failure)
Set the name/label field of the given VM_appliance.
Set the name/label field of the given VM_appliance. (Raise error on XMLRPC failure)
For each VM in the appliance, try to shut it down cleanly. If this fails, perform a hard shutdown of the VM.
For each VM in the appliance, try to shut it down cleanly. If this fails, perform a hard shutdown of the VM. (Raise error on XMLRPC failure)
Start all VMs in the appliance
Start all VMs in the appliance (Raise error on XMLRPC failure)
Link to this section Functions
assert_can_be_recovered(xen_session, vm_appliance_ref, session_to)
View SourceAssert whether all SRs required to recover this VM appliance are available.
assert_can_be_recovered!(xen_session, vm_appliance_ref, session_to)
View SourceAssert whether all SRs required to recover this VM appliance are available. (Raise error on XMLRPC failure)
Perform a clean shutdown of all the VMs in the appliance
Perform a clean shutdown of all the VMs in the appliance (Raise error on XMLRPC failure)
Create a new VM_appliance instance, and return its handle. The constructor args are: name_label, name_description (* = non-optional).
Create a new VM_appliance instance, and return its handle. The constructor args are: name_label, name_description (* = non-optional). (Raise error on XMLRPC failure)
Destroy the specified VM_appliance instance.
Destroy the specified VM_appliance instance. (Raise error on XMLRPC failure)
Return a list of all the VM_appliances known to the system.
Return a list of all the VM_appliances known to the system. (Raise error on XMLRPC failure)
Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system.
Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given VM_appliance.
Get the allowed_operations field of the given VM_appliance. (Raise error on XMLRPC failure)
Get all the VM_appliance instances with the given label.
Get all the VM_appliance instances with the given label. (Raise error on XMLRPC failure)
Get a reference to the VM_appliance instance with the specified UUID.
Get a reference to the VM_appliance instance with the specified UUID. (Raise error on XMLRPC failure)
Get the current_operations field of the given VM_appliance.
Get the current_operations field of the given VM_appliance. (Raise error on XMLRPC failure)
Get the name/description field of the given VM_appliance.
Get the name/description field of the given VM_appliance. (Raise error on XMLRPC failure)
Get the name/label field of the given VM_appliance.
Get the name/label field of the given VM_appliance. (Raise error on XMLRPC failure)
Get a record containing the current state of the given VM_appliance. Returns XenAPI.VMAppliance
struct.
Get a record containing the current state of the given VM_appliance. Returns XenAPI.VMAppliance
struct. (Raise error on XMLRPC failure)
get_SRs_required_for_recovery(xen_session, vm_appliance_ref, session_to)
View SourceGet the list of SRs required by the VM appliance to recover.
get_SRs_required_for_recovery!(xen_session, vm_appliance_ref, session_to)
View SourceGet the list of SRs required by the VM appliance to recover. (Raise error on XMLRPC failure)
Get the uuid field of the given VM_appliance.
Get the uuid field of the given VM_appliance. (Raise error on XMLRPC failure)
Get the VMs field of the given VM_appliance.
Get the VMs field of the given VM_appliance. (Raise error on XMLRPC failure)
Perform a hard shutdown of all the VMs in the appliance
Perform a hard shutdown of all the VMs in the appliance (Raise error on XMLRPC failure)
Recover the VM appliance
Recover the VM appliance (Raise error on XMLRPC failure)
Set the name/description field of the given VM_appliance.
Set the name/description field of the given VM_appliance. (Raise error on XMLRPC failure)
Set the name/label field of the given VM_appliance.
Set the name/label field of the given VM_appliance. (Raise error on XMLRPC failure)
For each VM in the appliance, try to shut it down cleanly. If this fails, perform a hard shutdown of the VM.
For each VM in the appliance, try to shut it down cleanly. If this fails, perform a hard shutdown of the VM. (Raise error on XMLRPC failure)
Start all VMs in the appliance
Start all VMs in the appliance (Raise error on XMLRPC failure)