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 (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

Link to this function

assert_can_be_recovered(xen_session, vm_appliance_ref, session_to)

View Source

Assert whether all SRs required to recover this VM appliance are available.

Link to this function

assert_can_be_recovered!(xen_session, vm_appliance_ref, session_to)

View Source

Assert whether all SRs required to recover this VM appliance are available. (Raise error on XMLRPC failure)

Link to this function

clean_shutdown(xen_session, vm_appliance_ref)

View Source

Perform a clean shutdown of all the VMs in the appliance

Link to this function

clean_shutdown!(xen_session, vm_appliance_ref)

View Source

Perform a clean shutdown of all the VMs in the appliance (Raise error on XMLRPC failure)

Link to this function

create(xen_session, args)

View Source

Create a new VM_appliance instance, and return its handle. The constructor args are: name_label, name_description (* = non-optional).

Link to this function

create!(xen_session, args)

View Source

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)

Link to this function

destroy(xen_session, vm_appliance_ref)

View Source

Destroy the specified VM_appliance instance.

Link to this function

destroy!(xen_session, vm_appliance_ref)

View Source

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)

Link to this function

get_all_records(xen_session)

View Source

Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system. (Raise error on XMLRPC failure)

Link to this function

get_allowed_operations(xen_session, vm_appliance_ref)

View Source

Get the allowed_operations field of the given VM_appliance.

Link to this function

get_allowed_operations!(xen_session, vm_appliance_ref)

View Source

Get the allowed_operations field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the VM_appliance instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the VM_appliance instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

Get a reference to the VM_appliance instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the VM_appliance instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_current_operations(xen_session, vm_appliance_ref)

View Source

Get the current_operations field of the given VM_appliance.

Link to this function

get_current_operations!(xen_session, vm_appliance_ref)

View Source

Get the current_operations field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, vm_appliance_ref)

View Source

Get the name/description field of the given VM_appliance.

Link to this function

get_name_description!(xen_session, vm_appliance_ref)

View Source

Get the name/description field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, vm_appliance_ref)

View Source

Get the name/label field of the given VM_appliance.

Link to this function

get_name_label!(xen_session, vm_appliance_ref)

View Source

Get the name/label field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, vm_appliance_ref)

View Source

Get a record containing the current state of the given VM_appliance. Returns XenAPI.VMAppliance struct.

Link to this function

get_record!(xen_session, vm_appliance_ref)

View Source

Get a record containing the current state of the given VM_appliance. Returns XenAPI.VMAppliance struct. (Raise error on XMLRPC failure)

Link to this function

get_SRs_required_for_recovery(xen_session, vm_appliance_ref, session_to)

View Source

Get the list of SRs required by the VM appliance to recover.

Link to this function

get_SRs_required_for_recovery!(xen_session, vm_appliance_ref, session_to)

View Source

Get the list of SRs required by the VM appliance to recover. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, vm_appliance_ref)

View Source

Get the uuid field of the given VM_appliance.

Link to this function

get_uuid!(xen_session, vm_appliance_ref)

View Source

Get the uuid field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

get_VMs(xen_session, vm_appliance_ref)

View Source

Get the VMs field of the given VM_appliance.

Link to this function

get_VMs!(xen_session, vm_appliance_ref)

View Source

Get the VMs field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

hard_shutdown(xen_session, vm_appliance_ref)

View Source

Perform a hard shutdown of all the VMs in the appliance

Link to this function

hard_shutdown!(xen_session, vm_appliance_ref)

View Source

Perform a hard shutdown of all the VMs in the appliance (Raise error on XMLRPC failure)

Link to this function

recover(xen_session, vm_appliance_ref, session_to, force)

View Source

Recover the VM appliance

Link to this function

recover!(xen_session, vm_appliance_ref, session_to, force)

View Source

Recover the VM appliance (Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, vm_appliance_ref, value)

View Source

Set the name/description field of the given VM_appliance.

Link to this function

set_name_description!(xen_session, vm_appliance_ref, value)

View Source

Set the name/description field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, vm_appliance_ref, value)

View Source

Set the name/label field of the given VM_appliance.

Link to this function

set_name_label!(xen_session, vm_appliance_ref, value)

View Source

Set the name/label field of the given VM_appliance. (Raise error on XMLRPC failure)

Link to this function

shutdown(xen_session, vm_appliance_ref)

View Source

For each VM in the appliance, try to shut it down cleanly. If this fails, perform a hard shutdown of the VM.

Link to this function

shutdown!(xen_session, vm_appliance_ref)

View Source

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)

Link to this function

start(xen_session, vm_appliance_ref, paused)

View Source

Start all VMs in the appliance

Link to this function

start!(xen_session, vm_appliance_ref, paused)

View Source

Start all VMs in the appliance (Raise error on XMLRPC failure)