Package com.xensource.xenapi
Class VM.Record
java.lang.Object
com.xensource.xenapi.VM.Record
- All Implemented Interfaces:
Types.Record
- Enclosing class:
- VM
Represents all the fields in a VM
-
Field Summary
FieldsModifier and TypeFieldDescriptionaction to take if the guest crashesaction to take after the guest has rebooted itselfaction to take after the guest has shutdown itselfaction to take after soft reboot Experimental.A host which the VM has some affinity for (or NULL).list of the operations allowed in this state.the appliance to which this VM belongsCurrently passed-through PCI devices First published in XenServer 6.0.BIOS strings First published in XenServer 5.6.Binary blobs associated with this VM First published in XenServer 5.0.List of operations which have been explicitly blocked and an error code First published in XenServer 5.0.List pointing to all the children of this VM First published in XenServer 5.6.virtual console devicescrash dumps associated with this VMlinks each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.The type of domain that will be created when the VM is started First published in XenServer 7.5.Domain architecture (if available, null string otherwise)domain ID (if available, -1 otherwise)Generation ID of the VM First published in XenServer 6.2.VM groups associated with the VM Experimental.metrics associated with the running guestDeprecated.The host virtual hardware platform version the VM can run on First published in XenServer 6.5 SP1.has possible values: "best-effort" meaning "try to restart this VM if possible but don't consider the Pool to be overcommitted if this is not possible"; "restart" meaning "this VM should be restarted"; "" meaning "do not try to restart this VM" First published in XenServer 5.0.When an HVM guest starts, this controls the presence of the emulated C000 PCI device which triggers Windows Update to fetch or update PV drivers.HVM boot paramsDeprecated.multiplier applied to the amount of shadow that will be made available to the guest First published in XenServer 4.1.true if this is a snapshot.true if this is a template.true if this is a control domain (domain 0 or a driver domain)true if this is a default template.true if this snapshot was created by the protection policy First published in XenServer 5.6 FP1.true if this snapshot was created by the snapshot schedule First published in XenServer 7.2.describes the CPU flags on which the VM was last bootedmarshalled value containing VM record at time of last boot First published in XenServer 4.1.Dynamic maximum (bytes)Dynamic minimum (bytes)Virtualization memory overhead (bytes).Statically-set (i.e.Statically-set (i.e.Deprecated.metrics associated with this VMa notes field containing human-readable descriptiona human-readable nameinitial value for guest NVRAM (containing UEFI variables, etc).The point in the startup or shutdown sequence at which this VM will be started First published in XenServer 6.0.additional configurationRef pointing to the parent of this VM First published in XenServer 5.6.Deprecated.The set of pending mandatory guidances after applying updates, which must be applied, as otherwise there may be e.g.The set of pending full guidances after applying updates, which a user should follow to make some updates, e.g.The set of pending recommended guidances after applying updates, which most users should follow to make the updates effective, but if not followed, will not cause a failure Experimental.platform-specific configurationCurrent power state of the machineDeprecated.kernel command-line argumentsname of or path to bootloadermiscellaneous arguments for the bootloaderpath to the kernelto make Zurich guests bootpath to the initrdAn XML specification of recommended values and ranges for properties of this VMTextual reference to the template used to create a VM.Indicates whether a VM requires a reboot in order to update its configuration, e.g.the host the VM is currently resident onthe host on which the VM is due to be started/resumed/migrated.The delay to wait before proceeding to the next order in the shutdown sequence (seconds) First published in XenServer 6.0.Human-readable information concerning this snapshot First published in XenServer 5.6.Encoded information about the VM's metadata this is a snapshot of First published in XenServer 5.6.Ref pointing to the VM this snapshot is of.List pointing to all the VM snapshots.Ref pointing to a snapshot schedule for this VM First published in XenServer 7.2.Date/time when this snapshot was created.The delay to wait before proceeding to the next order in the startup sequence (seconds) First published in XenServer 6.0.The SR on which a suspend image is stored First published in XenServer 6.0.The VDI that a suspend image is stored on.user-specified tags for categorization purposes First published in XenServer 5.0.Transportable ID of the snapshot VM First published in XenServer 5.0.Creators of VMs and templates may store version information here.Unique identifier/object referencevirtual block devicesBoot number of VCPUsMax number of VCPUsconfiguration parameters for the selected VCPU policyThe number of times this VM has been recovered First published in XenServer 6.0.Virtual GPUs First published in XenServer 6.0.virtual network interfacesvirtual TPMsvirtual usb devicesdata to be inserted into the xenstore tree (/local/domain/<domid>/vm-data) after the VM is created. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
uuid
Unique identifier/object reference -
allowedOperations
list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. -
currentOperations
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task. -
nameLabel
a human-readable name -
nameDescription
a notes field containing human-readable description -
powerState
Current power state of the machine -
userVersion
Creators of VMs and templates may store version information here. -
isATemplate
true if this is a template. Template VMs can never be started, they are used only for cloning other VMs -
isDefaultTemplate
true if this is a default template. Default template VMs can never be started or migrated, they are used only for cloning other VMs First published in XenServer 7.2. -
suspendVDI
The VDI that a suspend image is stored on. (Only has meaning if VM is currently suspended) -
residentOn
the host the VM is currently resident on -
scheduledToBeResidentOn
the host on which the VM is due to be started/resumed/migrated. This acts as a memory reservation indicator -
affinity
A host which the VM has some affinity for (or NULL). This is used as a hint to the start call when it decides where to run the VM. Resource constraints may cause the VM to be started elsewhere. -
memoryOverhead
Virtualization memory overhead (bytes). -
memoryTarget
Deprecated.Dynamically-set memory target (bytes). The value of this field indicates the current target for memory available to this VM. -
memoryStaticMax
Statically-set (i.e. absolute) maximum (bytes). The value of this field at VM start time acts as a hard limit of the amount of memory a guest can use. New values only take effect on reboot. -
memoryDynamicMax
Dynamic maximum (bytes) -
memoryDynamicMin
Dynamic minimum (bytes) -
memoryStaticMin
Statically-set (i.e. absolute) mininum (bytes). The value of this field indicates the least amount of memory this VM can boot with without crashing. -
VCPUsParams
configuration parameters for the selected VCPU policy -
VCPUsMax
Max number of VCPUs -
VCPUsAtStartup
Boot number of VCPUs -
actionsAfterSoftreboot
action to take after soft reboot Experimental. First published in 23.1.0. -
actionsAfterShutdown
action to take after the guest has shutdown itself -
actionsAfterReboot
action to take after the guest has rebooted itself -
actionsAfterCrash
action to take if the guest crashes -
consoles
virtual console devices -
VIFs
virtual network interfaces -
VBDs
virtual block devices -
VUSBs
virtual usb devices -
crashDumps
crash dumps associated with this VM -
VTPMs
virtual TPMs -
PVBootloader
name of or path to bootloader -
PVKernel
path to the kernel -
PVRamdisk
path to the initrd -
PVArgs
kernel command-line arguments -
PVBootloaderArgs
miscellaneous arguments for the bootloader -
PVLegacyArgs
to make Zurich guests boot -
HVMBootPolicy
Deprecated.HVM boot policy -
HVMBootParams
HVM boot params -
HVMShadowMultiplier
multiplier applied to the amount of shadow that will be made available to the guest First published in XenServer 4.1. -
platform
platform-specific configuration -
PCIBus
Deprecated.PCI bus path for pass-through devices -
otherConfig
additional configuration -
domid
domain ID (if available, -1 otherwise) -
domarch
Domain architecture (if available, null string otherwise) -
lastBootCPUFlags
describes the CPU flags on which the VM was last booted -
isControlDomain
true if this is a control domain (domain 0 or a driver domain) -
metrics
metrics associated with this VM -
guestMetrics
metrics associated with the running guest -
lastBootedRecord
marshalled value containing VM record at time of last boot First published in XenServer 4.1. -
recommendations
An XML specification of recommended values and ranges for properties of this VM -
xenstoreData
data to be inserted into the xenstore tree (/local/domain/<domid>/vm-data) after the VM is created. First published in XenServer 4.1. -
haAlwaysRun
Deprecated.if true then the system will attempt to keep the VM running as much as possible. First published in XenServer 5.0. -
haRestartPriority
has possible values: "best-effort" meaning "try to restart this VM if possible but don't consider the Pool to be overcommitted if this is not possible"; "restart" meaning "this VM should be restarted"; "" meaning "do not try to restart this VM" First published in XenServer 5.0. -
isASnapshot
true if this is a snapshot. Snapshotted VMs can never be started, they are used only for cloning other VMs First published in XenServer 5.0. -
snapshotOf
Ref pointing to the VM this snapshot is of. First published in XenServer 5.0. -
snapshots
List pointing to all the VM snapshots. First published in XenServer 5.0. -
snapshotTime
Date/time when this snapshot was created. First published in XenServer 5.0. -
transportableSnapshotId
Transportable ID of the snapshot VM First published in XenServer 5.0. -
blobs
Binary blobs associated with this VM First published in XenServer 5.0. -
tags
user-specified tags for categorization purposes First published in XenServer 5.0. -
blockedOperations
List of operations which have been explicitly blocked and an error code First published in XenServer 5.0. -
snapshotInfo
Human-readable information concerning this snapshot First published in XenServer 5.6. -
snapshotMetadata
Encoded information about the VM's metadata this is a snapshot of First published in XenServer 5.6. -
parent
Ref pointing to the parent of this VM First published in XenServer 5.6. -
children
List pointing to all the children of this VM First published in XenServer 5.6. -
biosStrings
BIOS strings First published in XenServer 5.6. -
protectionPolicy
Deprecated.Ref pointing to a protection policy for this VM First published in XenServer 5.6 FP1. -
isSnapshotFromVmpp
true if this snapshot was created by the protection policy First published in XenServer 5.6 FP1. -
snapshotSchedule
Ref pointing to a snapshot schedule for this VM First published in XenServer 7.2. -
isVmssSnapshot
true if this snapshot was created by the snapshot schedule First published in XenServer 7.2. -
appliance
the appliance to which this VM belongs -
startDelay
The delay to wait before proceeding to the next order in the startup sequence (seconds) First published in XenServer 6.0. -
shutdownDelay
The delay to wait before proceeding to the next order in the shutdown sequence (seconds) First published in XenServer 6.0. -
order
The point in the startup or shutdown sequence at which this VM will be started First published in XenServer 6.0. -
VGPUs
Virtual GPUs First published in XenServer 6.0. -
attachedPCIs
Currently passed-through PCI devices First published in XenServer 6.0. -
suspendSR
The SR on which a suspend image is stored First published in XenServer 6.0. -
version
The number of times this VM has been recovered First published in XenServer 6.0. -
generationId
Generation ID of the VM First published in XenServer 6.2. -
hardwarePlatformVersion
The host virtual hardware platform version the VM can run on First published in XenServer 6.5 SP1. -
hasVendorDevice
When an HVM guest starts, this controls the presence of the emulated C000 PCI device which triggers Windows Update to fetch or update PV drivers. First published in XenServer 7.0. -
requiresReboot
Indicates whether a VM requires a reboot in order to update its configuration, e.g. its memory allocation. First published in XenServer 7.1. -
referenceLabel
Textual reference to the template used to create a VM. This can be used by clients in need of an immutable reference to the template since the latter's uuid and name_label may change, for example, after a package installation or upgrade. First published in XenServer 7.1. -
domainType
The type of domain that will be created when the VM is started First published in XenServer 7.5. -
NVRAM
initial value for guest NVRAM (containing UEFI variables, etc). Cannot be changed while the VM is running First published in Citrix Hypervisor 8.0. -
pendingGuidances
The set of pending mandatory guidances after applying updates, which must be applied, as otherwise there may be e.g. VM failures First published in 1.303.0. -
pendingGuidancesRecommended
The set of pending recommended guidances after applying updates, which most users should follow to make the updates effective, but if not followed, will not cause a failure Experimental. First published in 24.10.0. -
pendingGuidancesFull
The set of pending full guidances after applying updates, which a user should follow to make some updates, e.g. specific hardware drivers or CPU features, fully effective, but the 'average user' doesn't need to Experimental. First published in 24.10.0. -
groups
VM groups associated with the VM Experimental. First published in 24.19.1.
-
-
Constructor Details
-
Record
public Record()
-
-
Method Details
-
toString
-
toMap
Convert a VM.Record to a Map- Specified by:
toMap
in interfaceTypes.Record
-