VM

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.xensource.xenapi
Class VM

java.lang.Object
  com.xensource.xenapi.VM

public class VM extends Object
extends Object

A virtual machine (or 'guest').

Nested Class Summary
`static class`	`VM.Record` Represents all the fields in a VM

Field Summary
`protected String`	`ref` The XenAPI reference to this object.

Method Summary
`void`	`addToHVMBootParams(String key, String value)` Add the given key-value pair to the HVM/boot_params field of the given VM.
`void`	`addToOtherConfig(String key, String value)` Add the given key-value pair to the other_config field of the given VM.
`void`	`addToPlatform(String key, String value)` Add the given key-value pair to the platform field of the given VM.
`void`	`addToVCPUsParams(String key, String value)` Add the given key-value pair to the VCPUs/params field of the given VM.
`void`	`addToVCPUsParamsLive(String key, String value)` Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM
`void`	`cleanReboot()` Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g.
`void`	`cleanShutdown()` Attempt to cleanly shutdown the specified VM.
`VM`	`clone(String newName)` Clones the specified VM, making a new VM.
`static VM`	`create(VM.Record record)` Create a new VM instance, and return its handle.
`void`	`destroy()` Destroy the specified VM.
`com.xensource.xenapi.Types.OnCrashBehaviour`	`getActionsAfterCrash()` Get the actions/after_crash field of the given VM.
`com.xensource.xenapi.Types.OnNormalExit`	`getActionsAfterReboot()` Get the actions/after_reboot field of the given VM.
`com.xensource.xenapi.Types.OnNormalExit`	`getActionsAfterShutdown()` Get the actions/after_shutdown field of the given VM.
`static Set<VM>`	`getAll()` Return a list of all the VMs known to the system.
`Set<String>`	`getAllowedVBDDevices()` Returns a list of the allowed values that a VBD device field can take
`Set<String>`	`getAllowedVIFDevices()` Returns a list of the allowed values that a VIF device field can take
`static Map<VM,VM.Record>`	`getAllRecords()` Get all the VM Records at once, in a single XML RPC call
`Boolean`	`getAutoPowerOn()` Get the auto_power_on field of the given VM.
`static Set<VM>`	`getByNameLabel(String label)` Get all the VM instances with the given label.
`static VM`	`getByUuid(String uuid)` Get a reference to the VM instance with the specified UUID.
`Set<Console>`	`getConsoles()` Get the consoles field of the given VM.
`Set<Crashdump>`	`getCrashDumps()` Get the crash_dumps field of the given VM.
`Long`	`getDomid()` Get the domid field of the given VM.
`VMGuestMetrics`	`getGuestMetrics()` Get the guest_metrics field of the given VM.
`Map<String,String>`	`getHVMBootParams()` Get the HVM/boot_params field of the given VM.
`String`	`getHVMBootPolicy()` Get the HVM/boot_policy field of the given VM.
`protected static VM`	`getInstFromRef(String ref)`
`Boolean`	`getIsATemplate()` Get the is_a_template field of the given VM.
`Boolean`	`getIsControlDomain()` Get the is_control_domain field of the given VM.
`Long`	`getMemoryDynamicMax()` Get the memory/dynamic_max field of the given VM.
`Long`	`getMemoryDynamicMin()` Get the memory/dynamic_min field of the given VM.
`Long`	`getMemoryStaticMax()` Get the memory/static_max field of the given VM.
`Long`	`getMemoryStaticMin()` Get the memory/static_min field of the given VM.
`VMMetrics`	`getMetrics()` Get the metrics field of the given VM.
`String`	`getNameDescription()` Get the name/description field of the given VM.
`String`	`getNameLabel()` Get the name/label field of the given VM.
`Map<String,String>`	`getOtherConfig()` Get the other_config field of the given VM.
`String`	`getPCIBus()` Get the PCI_bus field of the given VM.
`Map<String,String>`	`getPlatform()` Get the platform field of the given VM.
`com.xensource.xenapi.Types.VmPowerState`	`getPowerState()` Get the power_state field of the given VM.
`String`	`getPVArgs()` Get the PV/args field of the given VM.
`String`	`getPVBootloader()` Get the PV/bootloader field of the given VM.
`String`	`getPVBootloaderArgs()` Get the PV/bootloader_args field of the given VM.
`String`	`getPVKernel()` Get the PV/kernel field of the given VM.
`String`	`getPVRamdisk()` Get the PV/ramdisk field of the given VM.
`VM.Record`	`getRecord()` Get a record containing the current state of the given VM.
`Host`	`getResidentOn()` Get the resident_on field of the given VM.
`VDI`	`getSuspendVDI()` Get the suspend_VDI field of the given VM.
`Long`	`getUserVersion()` Get the user_version field of the given VM.
`String`	`getUuid()` Get the uuid field of the given VM.
`Set<VBD>`	`getVBDs()` Get the VBDs field of the given VM.
`Long`	`getVCPUsAtStartup()` Get the VCPUs/at_startup field of the given VM.
`Long`	`getVCPUsMax()` Get the VCPUs/max field of the given VM.
`Map<String,String>`	`getVCPUsParams()` Get the VCPUs/params field of the given VM.
`Set<VIF>`	`getVIFs()` Get the VIFs field of the given VM.
`Set<VTPM>`	`getVTPMs()` Get the VTPMs field of the given VM.
`void`	`hardReboot()` Stop executing the specified VM without attempting a clean shutdown.
`void`	`hardShutdown()` Stop executing the specified VM without attempting a clean shutdown.
`void`	`migrate(String dest, Boolean live, Map<String,String> options)` Migrate the VM to another host.
`void`	`pause()` Pause the specified VM.
`void`	`removeFromHVMBootParams(String key)` Remove the given key and its corresponding value from the HVM/boot_params field of the given VM.
`void`	`removeFromOtherConfig(String key)` Remove the given key and its corresponding value from the other_config field of the given VM.
`void`	`removeFromPlatform(String key)` Remove the given key and its corresponding value from the platform field of the given VM.
`void`	`removeFromVCPUsParams(String key)` Remove the given key and its corresponding value from the VCPUs/params field of the given VM.
`void`	`resume(Boolean startPaused, Boolean force)` Awaken the specified VM and resume it.
`void`	`sendSysrq(String key)` Send the given key as a sysrq to this VM.
`void`	`sendTrigger(String trigger)` Send the named trigger to this VM.
`void`	`setActionsAfterCrash(com.xensource.xenapi.Types.OnCrashBehaviour afterCrash)` Set the actions/after_crash field of the given VM.
`void`	`setActionsAfterReboot(com.xensource.xenapi.Types.OnNormalExit afterReboot)` Set the actions/after_reboot field of the given VM.
`void`	`setActionsAfterShutdown(com.xensource.xenapi.Types.OnNormalExit afterShutdown)` Set the actions/after_shutdown field of the given VM.
`void`	`setAutoPowerOn(Boolean autoPowerOn)` Set the auto_power_on field of the given VM.
`void`	`setHVMBootParams(Map<String,String> bootParams)` Set the HVM/boot_params field of the given VM.
`void`	`setHVMBootPolicy(String bootPolicy)` Set the HVM/boot_policy field of the given VM.
`void`	`setIsATemplate(Boolean isATemplate)` Set the is_a_template field of the given VM.
`void`	`setMemoryDynamicMax(Long dynamicMax)` Set the memory/dynamic_max field of the given VM.
`void`	`setMemoryDynamicMaxLive(Long max)` Set memory_dynamic_max in database and on running VM
`void`	`setMemoryDynamicMin(Long dynamicMin)` Set the memory/dynamic_min field of the given VM.
`void`	`setMemoryDynamicMinLive(Long min)` Set memory_dynamic_min in database and on running VM
`void`	`setMemoryStaticMax(Long staticMax)` Set the memory/static_max field of the given VM.
`void`	`setMemoryStaticMin(Long staticMin)` Set the memory/static_min field of the given VM.
`void`	`setNameDescription(String description)` Set the name/description field of the given VM.
`void`	`setNameLabel(String label)` Set the name/label field of the given VM.
`void`	`setOtherConfig(Map<String,String> otherConfig)` Set the other_config field of the given VM.
`void`	`setPCIBus(String PCIBus)` Set the PCI_bus field of the given VM.
`void`	`setPlatform(Map<String,String> platform)` Set the platform field of the given VM.
`void`	`setPVArgs(String args)` Set the PV/args field of the given VM.
`void`	`setPVBootloader(String bootloader)` Set the PV/bootloader field of the given VM.
`void`	`setPVBootloaderArgs(String bootloaderArgs)` Set the PV/bootloader_args field of the given VM.
`void`	`setPVKernel(String kernel)` Set the PV/kernel field of the given VM.
`void`	`setPVRamdisk(String ramdisk)` Set the PV/ramdisk field of the given VM.
`void`	`setUserVersion(Long userVersion)` Set the user_version field of the given VM.
`void`	`setVCPUsAtStartup(Long atStartup)` Set the VCPUs/at_startup field of the given VM.
`void`	`setVCPUsMax(Long max)` Set the VCPUs/max field of the given VM.
`void`	`setVCPUsNumberLive(Long nvcpu)` Set this VM's VCPUs/at_startup value, and set the same value on the VM, if running
`void`	`setVCPUsParams(Map<String,String> params)` Set the VCPUs/params field of the given VM.
`void`	`start(Boolean startPaused)` Start the specified VM.
`void`	`suspend()` Suspend the specified VM to disk.
`void`	`unpause()` Resume the specified VM.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ref

protected final String ref

The XenAPI reference to this object.

Method Detail

getInstFromRef

protected static VM getInstFromRef(String ref)

getRecord

public VM.Record getRecord()
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Get a record containing the current state of the given VM.

Returns:: all fields from the object
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getByUuid

public static VM getByUuid(String uuid)
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

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

Parameters:: uuid - UUID of object to return
Returns:: reference to the object
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

create

public static VM create(VM.Record record)
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Create a new VM instance, and return its handle.

Parameters:: record - All constructor arguments
Returns:: reference to the newly created object
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

destroy

public void destroy()
             throws Types.BadServerResponse,
                    ConnectionHelper.NoConnectionOnThisThreadException,
                    XmlRpcException

Destroy the specified VM. The VM is completely removed from the system. This function can only be called when the VM is in the Halted State.

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getByNameLabel

public static Set<VM> getByNameLabel(String label)
                              throws Types.BadServerResponse,
                                     ConnectionHelper.NoConnectionOnThisThreadException,
                                     XmlRpcException

Get all the VM instances with the given label.

Parameters:: label - label of object to return
Returns:: references to objects with matching names
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getUuid

public String getUuid()
               throws Types.BadServerResponse,
                      ConnectionHelper.NoConnectionOnThisThreadException,
                      XmlRpcException

Get the uuid field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPowerState

public com.xensource.xenapi.Types.VmPowerState getPowerState()
                                                      throws Types.BadServerResponse,
                                                             ConnectionHelper.NoConnectionOnThisThreadException,
                                                             XmlRpcException

Get the power_state field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getNameLabel

public String getNameLabel()
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Get the name/label field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getNameDescription

public String getNameDescription()
                          throws Types.BadServerResponse,
                                 ConnectionHelper.NoConnectionOnThisThreadException,
                                 XmlRpcException

Get the name/description field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getUserVersion

public Long getUserVersion()
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Get the user_version field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getIsATemplate

public Boolean getIsATemplate()
                       throws Types.BadServerResponse,
                              ConnectionHelper.NoConnectionOnThisThreadException,
                              XmlRpcException

Get the is_a_template field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getAutoPowerOn

public Boolean getAutoPowerOn()
                       throws Types.BadServerResponse,
                              ConnectionHelper.NoConnectionOnThisThreadException,
                              XmlRpcException

Get the auto_power_on field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getSuspendVDI

public VDI getSuspendVDI()
                  throws Types.BadServerResponse,
                         ConnectionHelper.NoConnectionOnThisThreadException,
                         XmlRpcException

Get the suspend_VDI field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getResidentOn

public Host getResidentOn()
                   throws Types.BadServerResponse,
                          ConnectionHelper.NoConnectionOnThisThreadException,
                          XmlRpcException

Get the resident_on field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getMemoryStaticMax

public Long getMemoryStaticMax()
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Get the memory/static_max field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getMemoryDynamicMax

public Long getMemoryDynamicMax()
                         throws Types.BadServerResponse,
                                ConnectionHelper.NoConnectionOnThisThreadException,
                                XmlRpcException

Get the memory/dynamic_max field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getMemoryDynamicMin

public Long getMemoryDynamicMin()
                         throws Types.BadServerResponse,
                                ConnectionHelper.NoConnectionOnThisThreadException,
                                XmlRpcException

Get the memory/dynamic_min field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getMemoryStaticMin

public Long getMemoryStaticMin()
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Get the memory/static_min field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getVCPUsParams

public Map<String,String> getVCPUsParams()
                                  throws Types.BadServerResponse,
                                         ConnectionHelper.NoConnectionOnThisThreadException,
                                         XmlRpcException

Get the VCPUs/params field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getVCPUsMax

public Long getVCPUsMax()
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Get the VCPUs/max field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getVCPUsAtStartup

public Long getVCPUsAtStartup()
                       throws Types.BadServerResponse,
                              ConnectionHelper.NoConnectionOnThisThreadException,
                              XmlRpcException

Get the VCPUs/at_startup field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getActionsAfterShutdown

public com.xensource.xenapi.Types.OnNormalExit getActionsAfterShutdown()
                                                                throws Types.BadServerResponse,
                                                                       ConnectionHelper.NoConnectionOnThisThreadException,
                                                                       XmlRpcException

Get the actions/after_shutdown field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getActionsAfterReboot

public com.xensource.xenapi.Types.OnNormalExit getActionsAfterReboot()
                                                              throws Types.BadServerResponse,
                                                                     ConnectionHelper.NoConnectionOnThisThreadException,
                                                                     XmlRpcException

Get the actions/after_reboot field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getActionsAfterCrash

public com.xensource.xenapi.Types.OnCrashBehaviour getActionsAfterCrash()
                                                                 throws Types.BadServerResponse,
                                                                        ConnectionHelper.NoConnectionOnThisThreadException,
                                                                        XmlRpcException

Get the actions/after_crash field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getConsoles

public Set<Console> getConsoles()
                         throws Types.BadServerResponse,
                                ConnectionHelper.NoConnectionOnThisThreadException,
                                XmlRpcException

Get the consoles field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getVIFs

public Set<VIF> getVIFs()
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Get the VIFs field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getVBDs

public Set<VBD> getVBDs()
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Get the VBDs field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getCrashDumps

public Set<Crashdump> getCrashDumps()
                             throws Types.BadServerResponse,
                                    ConnectionHelper.NoConnectionOnThisThreadException,
                                    XmlRpcException

Get the crash_dumps field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getVTPMs

public Set<VTPM> getVTPMs()
                   throws Types.BadServerResponse,
                          ConnectionHelper.NoConnectionOnThisThreadException,
                          XmlRpcException

Get the VTPMs field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPVBootloader

public String getPVBootloader()
                       throws Types.BadServerResponse,
                              ConnectionHelper.NoConnectionOnThisThreadException,
                              XmlRpcException

Get the PV/bootloader field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPVKernel

public String getPVKernel()
                   throws Types.BadServerResponse,
                          ConnectionHelper.NoConnectionOnThisThreadException,
                          XmlRpcException

Get the PV/kernel field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPVRamdisk

public String getPVRamdisk()
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Get the PV/ramdisk field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPVArgs

public String getPVArgs()
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Get the PV/args field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPVBootloaderArgs

public String getPVBootloaderArgs()
                           throws Types.BadServerResponse,
                                  ConnectionHelper.NoConnectionOnThisThreadException,
                                  XmlRpcException

Get the PV/bootloader_args field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getHVMBootPolicy

public String getHVMBootPolicy()
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Get the HVM/boot_policy field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getHVMBootParams

public Map<String,String> getHVMBootParams()
                                    throws Types.BadServerResponse,
                                           ConnectionHelper.NoConnectionOnThisThreadException,
                                           XmlRpcException

Get the HVM/boot_params field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPlatform

public Map<String,String> getPlatform()
                               throws Types.BadServerResponse,
                                      ConnectionHelper.NoConnectionOnThisThreadException,
                                      XmlRpcException

Get the platform field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getPCIBus

public String getPCIBus()
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Get the PCI_bus field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getOtherConfig

public Map<String,String> getOtherConfig()
                                  throws Types.BadServerResponse,
                                         ConnectionHelper.NoConnectionOnThisThreadException,
                                         XmlRpcException

Get the other_config field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getDomid

public Long getDomid()
              throws Types.BadServerResponse,
                     ConnectionHelper.NoConnectionOnThisThreadException,
                     XmlRpcException

Get the domid field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getIsControlDomain

public Boolean getIsControlDomain()
                           throws Types.BadServerResponse,
                                  ConnectionHelper.NoConnectionOnThisThreadException,
                                  XmlRpcException

Get the is_control_domain field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getMetrics

public VMMetrics getMetrics()
                     throws Types.BadServerResponse,
                            ConnectionHelper.NoConnectionOnThisThreadException,
                            XmlRpcException

Get the metrics field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getGuestMetrics

public VMGuestMetrics getGuestMetrics()
                               throws Types.BadServerResponse,
                                      ConnectionHelper.NoConnectionOnThisThreadException,
                                      XmlRpcException

Get the guest_metrics field of the given VM.

Returns:: value of the field
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setNameLabel

public void setNameLabel(String label)
                  throws Types.BadServerResponse,
                         ConnectionHelper.NoConnectionOnThisThreadException,
                         XmlRpcException

Set the name/label field of the given VM.

Parameters:: label - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setNameDescription

public void setNameDescription(String description)
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Set the name/description field of the given VM.

Parameters:: description - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setUserVersion

public void setUserVersion(Long userVersion)
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Set the user_version field of the given VM.

Parameters:: userVersion - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setIsATemplate

public void setIsATemplate(Boolean isATemplate)
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Set the is_a_template field of the given VM.

Parameters:: isATemplate - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setAutoPowerOn

public void setAutoPowerOn(Boolean autoPowerOn)
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Set the auto_power_on field of the given VM.

Parameters:: autoPowerOn - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setMemoryStaticMax

public void setMemoryStaticMax(Long staticMax)
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Set the memory/static_max field of the given VM.

Parameters:: staticMax - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setMemoryDynamicMax

public void setMemoryDynamicMax(Long dynamicMax)
                         throws Types.BadServerResponse,
                                ConnectionHelper.NoConnectionOnThisThreadException,
                                XmlRpcException

Set the memory/dynamic_max field of the given VM.

Parameters:: dynamicMax - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setMemoryDynamicMin

public void setMemoryDynamicMin(Long dynamicMin)
                         throws Types.BadServerResponse,
                                ConnectionHelper.NoConnectionOnThisThreadException,
                                XmlRpcException

Set the memory/dynamic_min field of the given VM.

Parameters:: dynamicMin - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setMemoryStaticMin

public void setMemoryStaticMin(Long staticMin)
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Set the memory/static_min field of the given VM.

Parameters:: staticMin - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setVCPUsParams

public void setVCPUsParams(Map<String,String> params)
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Set the VCPUs/params field of the given VM.

Parameters:: params - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

addToVCPUsParams

public void addToVCPUsParams(String key,
                             String value)
                      throws Types.BadServerResponse,
                             ConnectionHelper.NoConnectionOnThisThreadException,
                             XmlRpcException

Add the given key-value pair to the VCPUs/params field of the given VM.

Parameters:: key - Key to add; value - Value to add
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

removeFromVCPUsParams

public void removeFromVCPUsParams(String key)
                           throws Types.BadServerResponse,
                                  ConnectionHelper.NoConnectionOnThisThreadException,
                                  XmlRpcException

Remove the given key and its corresponding value from the VCPUs/params field of the given VM. If the key is not in that Map, then do nothing.

Parameters:: key - Key to remove
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setVCPUsMax

public void setVCPUsMax(Long max)
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Set the VCPUs/max field of the given VM.

Parameters:: max - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setVCPUsAtStartup

public void setVCPUsAtStartup(Long atStartup)
                       throws Types.BadServerResponse,
                              ConnectionHelper.NoConnectionOnThisThreadException,
                              XmlRpcException

Set the VCPUs/at_startup field of the given VM.

Parameters:: atStartup - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setActionsAfterShutdown

public void setActionsAfterShutdown(com.xensource.xenapi.Types.OnNormalExit afterShutdown)
                             throws Types.BadServerResponse,
                                    ConnectionHelper.NoConnectionOnThisThreadException,
                                    XmlRpcException

Set the actions/after_shutdown field of the given VM.

Parameters:: afterShutdown - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setActionsAfterReboot

public void setActionsAfterReboot(com.xensource.xenapi.Types.OnNormalExit afterReboot)
                           throws Types.BadServerResponse,
                                  ConnectionHelper.NoConnectionOnThisThreadException,
                                  XmlRpcException

Set the actions/after_reboot field of the given VM.

Parameters:: afterReboot - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setActionsAfterCrash

public void setActionsAfterCrash(com.xensource.xenapi.Types.OnCrashBehaviour afterCrash)
                          throws Types.BadServerResponse,
                                 ConnectionHelper.NoConnectionOnThisThreadException,
                                 XmlRpcException

Set the actions/after_crash field of the given VM.

Parameters:: afterCrash - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setPVBootloader

public void setPVBootloader(String bootloader)
                     throws Types.BadServerResponse,
                            ConnectionHelper.NoConnectionOnThisThreadException,
                            XmlRpcException

Set the PV/bootloader field of the given VM.

Parameters:: bootloader - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setPVKernel

public void setPVKernel(String kernel)
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Set the PV/kernel field of the given VM.

Parameters:: kernel - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setPVRamdisk

public void setPVRamdisk(String ramdisk)
                  throws Types.BadServerResponse,
                         ConnectionHelper.NoConnectionOnThisThreadException,
                         XmlRpcException

Set the PV/ramdisk field of the given VM.

Parameters:: ramdisk - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setPVArgs

public void setPVArgs(String args)
               throws Types.BadServerResponse,
                      ConnectionHelper.NoConnectionOnThisThreadException,
                      XmlRpcException

Set the PV/args field of the given VM.

Parameters:: args - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setPVBootloaderArgs

public void setPVBootloaderArgs(String bootloaderArgs)
                         throws Types.BadServerResponse,
                                ConnectionHelper.NoConnectionOnThisThreadException,
                                XmlRpcException

Set the PV/bootloader_args field of the given VM.

Parameters:: bootloaderArgs - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setHVMBootPolicy

public void setHVMBootPolicy(String bootPolicy)
                      throws Types.BadServerResponse,
                             ConnectionHelper.NoConnectionOnThisThreadException,
                             XmlRpcException

Set the HVM/boot_policy field of the given VM.

Parameters:: bootPolicy - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setHVMBootParams

public void setHVMBootParams(Map<String,String> bootParams)
                      throws Types.BadServerResponse,
                             ConnectionHelper.NoConnectionOnThisThreadException,
                             XmlRpcException

Set the HVM/boot_params field of the given VM.

Parameters:: bootParams - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

addToHVMBootParams

public void addToHVMBootParams(String key,
                               String value)
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Add the given key-value pair to the HVM/boot_params field of the given VM.

Parameters:: key - Key to add; value - Value to add
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

removeFromHVMBootParams

public void removeFromHVMBootParams(String key)
                             throws Types.BadServerResponse,
                                    ConnectionHelper.NoConnectionOnThisThreadException,
                                    XmlRpcException

Remove the given key and its corresponding value from the HVM/boot_params field of the given VM. If the key is not in that Map, then do nothing.

Parameters:: key - Key to remove
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setPlatform

public void setPlatform(Map<String,String> platform)
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException

Set the platform field of the given VM.

Parameters:: platform - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

addToPlatform

public void addToPlatform(String key,
                          String value)
                   throws Types.BadServerResponse,
                          ConnectionHelper.NoConnectionOnThisThreadException,
                          XmlRpcException

Add the given key-value pair to the platform field of the given VM.

Parameters:: key - Key to add; value - Value to add
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

removeFromPlatform

public void removeFromPlatform(String key)
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Remove the given key and its corresponding value from the platform field of the given VM. If the key is not in that Map, then do nothing.

Parameters:: key - Key to remove
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setPCIBus

public void setPCIBus(String PCIBus)
               throws Types.BadServerResponse,
                      ConnectionHelper.NoConnectionOnThisThreadException,
                      XmlRpcException

Set the PCI_bus field of the given VM.

Parameters:: PCIBus - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setOtherConfig

public void setOtherConfig(Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Set the other_config field of the given VM.

Parameters:: otherConfig - New value to set
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

addToOtherConfig

public void addToOtherConfig(String key,
                             String value)
                      throws Types.BadServerResponse,
                             ConnectionHelper.NoConnectionOnThisThreadException,
                             XmlRpcException

Add the given key-value pair to the other_config field of the given VM.

Parameters:: key - Key to add; value - Value to add
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(String key)
                           throws Types.BadServerResponse,
                                  ConnectionHelper.NoConnectionOnThisThreadException,
                                  XmlRpcException

Remove the given key and its corresponding value from the other_config field of the given VM. If the key is not in that Map, then do nothing.

Parameters:: key - Key to remove
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

clone

public VM clone(String newName)
         throws Types.BadServerResponse,
                ConnectionHelper.NoConnectionOnThisThreadException,
                XmlRpcException,
                Types.VmBadPowerState,
                Types.SrFull,
                Types.OperationNotAllowed

Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State.

Parameters:: newName - The name of the cloned VM
Returns:: The ID of the newly created VM.
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.SrFull; Types.OperationNotAllowed

start

public void start(Boolean startPaused)
           throws Types.BadServerResponse,
                  ConnectionHelper.NoConnectionOnThisThreadException,
                  XmlRpcException,
                  Types.VmBadPowerState,
                  Types.VmHvmRequired,
                  Types.VmIsTemplate,
                  Types.VmOtherOperationInProgress,
                  Types.OperationNotAllowed

Start the specified VM. This function can only be called with the VM is in the Halted State.

Parameters:: startPaused - Instantiate VM in paused state if set to true.
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.VmHvmRequired; Types.VmIsTemplate; Types.VmOtherOperationInProgress; Types.OperationNotAllowed

pause

public void pause()
           throws Types.BadServerResponse,
                  ConnectionHelper.NoConnectionOnThisThreadException,
                  XmlRpcException,
                  Types.VmBadPowerState,
                  Types.VmOtherOperationInProgress,
                  Types.OperationNotAllowed,
                  Types.VmIsTemplate

Pause the specified VM. This can only be called when the specified VM is in the Running state.

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.VmOtherOperationInProgress; Types.OperationNotAllowed; Types.VmIsTemplate

unpause

public void unpause()
             throws Types.BadServerResponse,
                    ConnectionHelper.NoConnectionOnThisThreadException,
                    XmlRpcException,
                    Types.VmBadPowerState,
                    Types.OperationNotAllowed,
                    Types.VmIsTemplate

Resume the specified VM. This can only be called when the specified VM is in the Paused state.

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.OperationNotAllowed; Types.VmIsTemplate

cleanShutdown

public void cleanShutdown()
                   throws Types.BadServerResponse,
                          ConnectionHelper.NoConnectionOnThisThreadException,
                          XmlRpcException,
                          Types.VmBadPowerState,
                          Types.VmOtherOperationInProgress,
                          Types.OperationNotAllowed,
                          Types.VmIsTemplate

Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). Once shutdown has been completed perform poweroff action specified in guest configuration. This can only be called when the specified VM is in the Running state.

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.VmOtherOperationInProgress; Types.OperationNotAllowed; Types.VmIsTemplate

cleanReboot

public void cleanReboot()
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException,
                        Types.VmBadPowerState,
                        Types.VmOtherOperationInProgress,
                        Types.OperationNotAllowed,
                        Types.VmIsTemplate

Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). Once shutdown has been completed perform reboot action specified in guest configuration. This can only be called when the specified VM is in the Running state.

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.VmOtherOperationInProgress; Types.OperationNotAllowed; Types.VmIsTemplate

hardShutdown

public void hardShutdown()
                  throws Types.BadServerResponse,
                         ConnectionHelper.NoConnectionOnThisThreadException,
                         XmlRpcException,
                         Types.VmBadPowerState,
                         Types.VmOtherOperationInProgress,
                         Types.OperationNotAllowed,
                         Types.VmIsTemplate

Stop executing the specified VM without attempting a clean shutdown. Then perform poweroff action specified in VM configuration.

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.VmOtherOperationInProgress; Types.OperationNotAllowed; Types.VmIsTemplate

hardReboot

public void hardReboot()
                throws Types.BadServerResponse,
                       ConnectionHelper.NoConnectionOnThisThreadException,
                       XmlRpcException,
                       Types.VmBadPowerState,
                       Types.VmOtherOperationInProgress,
                       Types.OperationNotAllowed,
                       Types.VmIsTemplate

Stop executing the specified VM without attempting a clean shutdown. Then perform reboot action specified in VM configuration

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.VmOtherOperationInProgress; Types.OperationNotAllowed; Types.VmIsTemplate

suspend

public void suspend()
             throws Types.BadServerResponse,
                    ConnectionHelper.NoConnectionOnThisThreadException,
                    XmlRpcException,
                    Types.VmBadPowerState,
                    Types.VmOtherOperationInProgress,
                    Types.OperationNotAllowed,
                    Types.VmIsTemplate

Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state.

Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.VmOtherOperationInProgress; Types.OperationNotAllowed; Types.VmIsTemplate

resume

public void resume(Boolean startPaused,
                   Boolean force)
            throws Types.BadServerResponse,
                   ConnectionHelper.NoConnectionOnThisThreadException,
                   XmlRpcException,
                   Types.VmBadPowerState,
                   Types.OperationNotAllowed,
                   Types.VmIsTemplate

Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state.

Parameters:: startPaused - Resume VM in paused state if set to true.; force - Attempt to force the VM to resume. If this flag is false then the VM may fail pre-resume safety checks (e.g. if the CPU the VM was running on looks substantially different to the current one)
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState; Types.OperationNotAllowed; Types.VmIsTemplate

setVCPUsNumberLive

public void setVCPUsNumberLive(Long nvcpu)
                        throws Types.BadServerResponse,
                               ConnectionHelper.NoConnectionOnThisThreadException,
                               XmlRpcException

Set this VM's VCPUs/at_startup value, and set the same value on the VM, if running

Parameters:: nvcpu - The number of VCPUs
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

addToVCPUsParamsLive

public void addToVCPUsParamsLive(String key,
                                 String value)
                          throws Types.BadServerResponse,
                                 ConnectionHelper.NoConnectionOnThisThreadException,
                                 XmlRpcException

Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM

Parameters:: key - The key; value - The value
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setMemoryDynamicMaxLive

public void setMemoryDynamicMaxLive(Long max)
                             throws Types.BadServerResponse,
                                    ConnectionHelper.NoConnectionOnThisThreadException,
                                    XmlRpcException

Set memory_dynamic_max in database and on running VM

Parameters:: max - The memory_dynamic_max value
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

setMemoryDynamicMinLive

public void setMemoryDynamicMinLive(Long min)
                             throws Types.BadServerResponse,
                                    ConnectionHelper.NoConnectionOnThisThreadException,
                                    XmlRpcException

Set memory_dynamic_min in database and on running VM

Parameters:: min - The memory_dynamic_min value
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

sendSysrq

public void sendSysrq(String key)
               throws Types.BadServerResponse,
                      ConnectionHelper.NoConnectionOnThisThreadException,
                      XmlRpcException,
                      Types.VmBadPowerState

Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state.

Parameters:: key - The key to send
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState

sendTrigger

public void sendTrigger(String trigger)
                 throws Types.BadServerResponse,
                        ConnectionHelper.NoConnectionOnThisThreadException,
                        XmlRpcException,
                        Types.VmBadPowerState

Send the named trigger to this VM. This can only be called when the specified VM is in the Running state.

Parameters:: trigger - The trigger to send
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState

migrate

public void migrate(String dest,
                    Boolean live,
                    Map<String,String> options)
             throws Types.BadServerResponse,
                    ConnectionHelper.NoConnectionOnThisThreadException,
                    XmlRpcException,
                    Types.VmBadPowerState

Migrate the VM to another host. This can only be called when the specified VM is in the Running state.

Parameters:: dest - The destination host; live - Live migration; options - Other parameters
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException; Types.VmBadPowerState

getAllowedVBDDevices

public Set<String> getAllowedVBDDevices()
                                 throws Types.BadServerResponse,
                                        ConnectionHelper.NoConnectionOnThisThreadException,
                                        XmlRpcException

Returns a list of the allowed values that a VBD device field can take

Returns:: The allowed values
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getAllowedVIFDevices

public Set<String> getAllowedVIFDevices()
                                 throws Types.BadServerResponse,
                                        ConnectionHelper.NoConnectionOnThisThreadException,
                                        XmlRpcException

Returns a list of the allowed values that a VIF device field can take

Returns:: The allowed values
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getAll

public static Set<VM> getAll()
                      throws Types.BadServerResponse,
                             ConnectionHelper.NoConnectionOnThisThreadException,
                             XmlRpcException

Return a list of all the VMs known to the system.

Returns:: references to all objects
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException

getAllRecords

public static Map<VM,VM.Record> getAllRecords()
                                       throws Types.BadServerResponse,
                                              ConnectionHelper.NoConnectionOnThisThreadException,
                                              XmlRpcException

Get all the VM Records at once, in a single XML RPC call

Returns:: A map from VM to VM.Record
Throws:: Types.BadServerResponse; ConnectionHelper.NoConnectionOnThisThreadException; XmlRpcException