Uses of Class
com.xensource.xenapi.VM

Uses of VM in com.xensource.xenapi

Fields in com.xensource.xenapi declared as VM

Modifier and Type	Field	Description
VM	VTPM.Record.backend	The domain where the backend is located (unused) First published in XenServer 4.0.
VM	Host.Record.controlDomain	The control domain (domain 0) First published in XenServer 7.1.
VM	VM.Record.parent	Ref pointing to the parent of this VM First published in XenServer 5.6.
VM	VM.Record.snapshotOf	Ref pointing to the VM this snapshot is of.
VM	Console.Record.VM	VM to which this console is attached
VM	Crashdump.Record.VM	the virtual machine
VM	VBD.Record.VM	the virtual machine
VM	VGPU.Record.VM	VM that owns the vGPU
VM	VIF.Record.VM	virtual machine to which this vif is connected
VM	VTPM.Record.VM	The virtual machine the TPM is attached to First published in XenServer 4.0.
VM	VUSB.Record.VM	VM that owns the VUSB

Fields in com.xensource.xenapi with type parameters of type VM

Modifier and Type	Field	Description
Set<VM>	VM.Record.children	List pointing to all the children of this VM First published in XenServer 5.6.
Set<VM>	Host.Record.residentVMs	list of VMs currently resident on host
Set<VM>	VM.Record.snapshots	List pointing to all the VM snapshots.
Set<VM>	VMAppliance.Record.VMs	all VMs in this appliance
Set<VM>	VMGroup.Record.VMs	The list of VMs associated with the group Experimental.
Set<VM>	VMPP.Record.VMs	all VMs attached to this protection policy
Set<VM>	VMSS.Record.VMs	all VMs attached to this snapshot schedule

Methods in com.xensource.xenapi that return VM

Modifier and Type	Method	Description
VM	VM.checkpoint(Connection c, String newName)	Checkpoints the specified VM, making a new VM.
VM	VM.copy(Connection c, String newName, SR sr)	Copied the specified VM, making a new VM.
static VM	VM.create(Connection c, VM.Record record)	NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations.
VM	VM.createClone(Connection c, String newName)	Clones the specified VM, making a new VM.
VM	VTPM.getBackend(Connection c)	Get the backend field of the given VTPM.
static VM	VM.getByUuid(Connection c, String uuid)	Get a reference to the VM instance with the specified UUID.
VM	Host.getControlDomain(Connection c)	Get the control_domain field of the given host.
VM	VM.getParent(Connection c)	Get the parent field of the given VM.
VM	VM.getSnapshotOf(Connection c)	Get the snapshot_of field of the given VM.
VM	Console.getVM(Connection c)	Get the VM field of the given console.
VM	Crashdump.getVM(Connection c)	Get the VM field of the given crashdump.
VM	VBD.getVM(Connection c)	Get the VM field of the given VBD.
VM	VGPU.getVM(Connection c)	Get the VM field of the given VGPU.
VM	VIF.getVM(Connection c)	Get the VM field of the given VIF.
VM	VTPM.getVM(Connection c)	Get the VM field of the given VTPM.
VM	VUSB.getVM(Connection c)	Get the VM field of the given VUSB.
VM	VM.migrateSend(Connection c, Map<String,String> dest, Boolean live, Map<VDI,SR> vdiMap, Map<VIF,Network> vifMap, Map<String,String> options)	Migrate the VM to another host.
VM	VM.migrateSend(Connection c, Map<String,String> dest, Boolean live, Map<VDI,SR> vdiMap, Map<VIF,Network> vifMap, Map<String,String> options, Map<VGPU,GPUGroup> vgpuMap)	Migrate the VM to another host.
VM	VM.snapshot(Connection c, String newName)	Snapshots the specified VM, making a new VM.
VM	VM.snapshot(Connection c, String newName, Set<VDI> ignoreVdis)	Snapshots the specified VM, making a new VM.
VM	VM.snapshotWithQuiesce(Connection c, String newName)	Deprecated. since Citrix Hypervisor 8.1
static VM	Types.toVM(Task task, Connection connection)	Attempt to convert the Task's result to a VM object.

Methods in com.xensource.xenapi that return types with arguments of type VM

Modifier and Type	Method	Description
static Set<VM>	VM.getAll(Connection c)	Return a list of all the VMs known to the system.
static Map<VM,VM.Record>	VM.getAllRecords(Connection c)	Return a map of VM references to VM records for all VMs known to the system.
static Set<VM>	VM.getByNameLabel(Connection c, String label)	Get all the VM instances with the given label.
Set<VM>	VM.getChildren(Connection c)	Get the children field of the given VM.
Set<VM>	Host.getResidentVMs(Connection c)	Get the resident_VMs field of the given host.
Set<VM>	VM.getSnapshots(Connection c)	Get the snapshots field of the given VM.
Set<VM>	Host.getUncooperativeResidentVMs(Connection c)	Deprecated. since XenServer 6.1
Set<VM>	VMAppliance.getVMs(Connection c)	Get the VMs field of the given VM_appliance.
Set<VM>	VMGroup.getVMs(Connection c)	Get the VMs field of the given VM_group.
Set<VM>	VMPP.getVMs(Connection c)	Deprecated. since XenServer 6.2
Set<VM>	VMSS.getVMs(Connection c)	Get the VMs field of the given VMSS.
Map<VM,Set<String>>	Host.getVmsWhichPreventEvacuation(Connection c)	Return a set of VMs which prevent the host being evacuated, with per-VM error codes Minimum allowed role: read-only First published in XenServer 5.0.
static Map<VM,Map<String,String>>	Pool.haComputeVmFailoverPlan(Connection c, Set<Host> failedHosts, Set<VM> failedVms)	Return a VM failover plan assuming a given subset of hosts fail Minimum allowed role: pool-operator First published in XenServer 5.0.
static Set<VM>	VM.import_(Connection c, String url, SR sr, Boolean fullRestore, Boolean force)	Import an XVA from a URI Minimum allowed role: pool-operator First published in XenServer 7.0.
Map<VM,Set<String>>	Host.retrieveWlbEvacuateRecommendations(Connection c)	Retrieves recommended host migrations to perform when evacuating the host from the wlb server.
static Map<VM,Set<String>>	Pool.retrieveWlbRecommendations(Connection c)	Retrieves vm migrate recommendations for the pool from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.

Methods in com.xensource.xenapi with parameters of type VM

Modifier and Type	Method	Description
static String	VMPP.archiveNow(Connection c, VM snapshot)	Deprecated. since XenServer 6.2
static VGPU	VGPU.create(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String,String> otherConfig)	Minimum allowed role: pool-operator First published in XenServer 6.0.
static VGPU	VGPU.create(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String,String> otherConfig, VGPUType type)	Minimum allowed role: pool-operator First published in XenServer 6.0.
static VTPM	VTPM.create(Connection c, VM vM, Boolean isUnique)	Create a new VTPM instance, and return its handle.
static VUSB	VUSB.create(Connection c, VM VM, USBGroup USBGroup, Map<String,String> otherConfig)	Create a new VUSB record in the database only Minimum allowed role: pool-admin First published in XenServer 7.3.
static Task	VGPU.createAsync(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String,String> otherConfig)	Minimum allowed role: pool-operator First published in XenServer 6.0.
static Task	VGPU.createAsync(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String,String> otherConfig, VGPUType type)	Minimum allowed role: pool-operator First published in XenServer 6.0.
static Task	VTPM.createAsync(Connection c, VM vM, Boolean isUnique)	Create a new VTPM instance, and return its handle.
static Task	VUSB.createAsync(Connection c, VM VM, USBGroup USBGroup, Map<String,String> otherConfig)	Create a new VUSB record in the database only Minimum allowed role: pool-admin First published in XenServer 7.3.

Method parameters in com.xensource.xenapi with type arguments of type VM

Modifier and Type	Method	Description
static Long	Pool.haComputeHypotheticalMaxHostFailuresToTolerate(Connection c, Map<VM,String> configuration)	Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs Minimum allowed role: read-only First published in XenServer 5.0.