com.xensource.xenapi
Class VM.Record

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

All Implemented Interfaces:

Types.Record

Enclosing class:

VM

public static class VM.Record
extends Object
implements Types.Record

Represents all the fields in a VM

Field Summary

com.xensource.xenapi.Types.OnCrashBehaviour	actionsAfterCrash action to take if the guest crashes
com.xensource.xenapi.Types.OnNormalExit	actionsAfterReboot action to take after the guest has rebooted itself
com.xensource.xenapi.Types.OnNormalExit	actionsAfterShutdown action to take after the guest has shutdown itself
Boolean	autoPowerOn true if this VM should be started automatically after host boot
Set<Console>	consoles virtual console devices
Set<Crashdump>	crashDumps crash dumps associated with this VM
Long	domid domain ID (if available, -1 otherwise)
VMGuestMetrics	guestMetrics metrics associated with the running guest
Map<String,String>	HVMBootParams HVM boot params
String	HVMBootPolicy HVM boot policy
Boolean	isATemplate true if this is a template.
Boolean	isControlDomain true if this is a control domain (domain 0 or a driver domain)
Long	memoryDynamicMax Dynamic maximum (bytes)
Long	memoryDynamicMin Dynamic minimum (bytes)
Long	memoryStaticMax Statically-set (i.e.
Long	memoryStaticMin Statically-set (i.e.
VMMetrics	metrics metrics associated with this VM
String	nameDescription a notes field containg human-readable description
String	nameLabel a human-readable name
Map<String,String>	otherConfig additional configuration
String	PCIBus PCI bus path for pass-through devices
Map<String,String>	platform platform-specific configuration
com.xensource.xenapi.Types.VmPowerState	powerState Current power state of the machine
String	PVArgs kernel command-line arguments
String	PVBootloader name of or path to bootloader
String	PVBootloaderArgs miscellaneous arguments for the bootloader
String	PVKernel path to the kernel
String	PVRamdisk path to the initrd
Host	residentOn the host the VM is currently resident on
VDI	suspendVDI The VDI that a suspend image is stored on.
Long	userVersion a user version number for this machine
String	uuid unique identifier/object reference
Set<VBD>	VBDs virtual block devices
Long	VCPUsAtStartup Boot number of VCPUs
Long	VCPUsMax Max number of VCPUs
Map<String,String>	VCPUsParams configuration parameters for the selected VCPU policy
Set<VIF>	VIFs virtual network interfaces
Set<VTPM>	VTPMs virtual TPMs

Constructor Summary

VM.Record()

Method Summary

Map<String,Object>	toMap() Convert a VM.Record to a Map
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

uuid

public String uuid

unique identifier/object reference

powerState

public com.xensource.xenapi.Types.VmPowerState powerState

Current power state of the machine

nameLabel

public String nameLabel

a human-readable name

nameDescription

public String nameDescription

a notes field containg human-readable description

userVersion

public Long userVersion

a user version number for this machine

isATemplate

public Boolean isATemplate

true if this is a template. Template VMs can never be started, they are used only for cloning other VMs

autoPowerOn

public Boolean autoPowerOn

true if this VM should be started automatically after host boot

suspendVDI

public VDI suspendVDI

The VDI that a suspend image is stored on. (Only has meaning if VM is currently suspended)

residentOn

public Host residentOn

the host the VM is currently resident on

memoryStaticMax

public Long memoryStaticMax

Statically-set (i.e. absolute) maximum (bytes)

memoryDynamicMax

public Long memoryDynamicMax

Dynamic maximum (bytes)

memoryDynamicMin

public Long memoryDynamicMin

Dynamic minimum (bytes)

memoryStaticMin

public Long memoryStaticMin

Statically-set (i.e. absolute) mininum (bytes)

VCPUsParams

public Map<String,String> VCPUsParams

configuration parameters for the selected VCPU policy

VCPUsMax

public Long VCPUsMax

Max number of VCPUs

VCPUsAtStartup

public Long VCPUsAtStartup

Boot number of VCPUs

actionsAfterShutdown

public com.xensource.xenapi.Types.OnNormalExit actionsAfterShutdown

action to take after the guest has shutdown itself

actionsAfterReboot

public com.xensource.xenapi.Types.OnNormalExit actionsAfterReboot

action to take after the guest has rebooted itself

actionsAfterCrash

public com.xensource.xenapi.Types.OnCrashBehaviour actionsAfterCrash

action to take if the guest crashes

consoles

public Set<Console> consoles

virtual console devices

VIFs

public Set<VIF> VIFs

virtual network interfaces

VBDs

public Set<VBD> VBDs

virtual block devices

crashDumps

public Set<Crashdump> crashDumps

crash dumps associated with this VM

VTPMs

public Set<VTPM> VTPMs

virtual TPMs

PVBootloader

public String PVBootloader

name of or path to bootloader

PVKernel

public String PVKernel

path to the kernel

PVRamdisk

public String PVRamdisk

path to the initrd

PVArgs

public String PVArgs

kernel command-line arguments

PVBootloaderArgs

public String PVBootloaderArgs

miscellaneous arguments for the bootloader

HVMBootPolicy

public String HVMBootPolicy

HVM boot policy

HVMBootParams

public Map<String,String> HVMBootParams

HVM boot params

platform

public Map<String,String> platform

platform-specific configuration

PCIBus

public String PCIBus

PCI bus path for pass-through devices

otherConfig

public Map<String,String> otherConfig

additional configuration

domid

public Long domid

domain ID (if available, -1 otherwise)

isControlDomain

public Boolean isControlDomain

true if this is a control domain (domain 0 or a driver domain)

metrics

public VMMetrics metrics

metrics associated with this VM

guestMetrics

public VMGuestMetrics guestMetrics

metrics associated with the running guest

Constructor Detail

VM.Record

public VM.Record()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

toMap

public Map<String,Object> toMap()

Convert a VM.Record to a Map

Specified by:

toMap in interface Types.Record