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 Details

    • uuid

      public String uuid
      Unique identifier/object reference
    • allowedOperations

      public Set<Types.VmOperations> 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

      public Map<String,Types.VmOperations> 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

      public String nameLabel
      a human-readable name
    • nameDescription

      public String nameDescription
      a notes field containing human-readable description
    • powerState

      public Types.VmPowerState powerState
      Current power state of the machine
    • userVersion

      public Long userVersion
      Creators of VMs and templates may store version information here.
    • isATemplate

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

      public Boolean 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

      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
    • scheduledToBeResidentOn

      public Host scheduledToBeResidentOn
      the host on which the VM is due to be started/resumed/migrated. This acts as a memory reservation indicator
    • affinity

      public Host 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

      public Long memoryOverhead
      Virtualization memory overhead (bytes).
    • memoryTarget

      public Long memoryTarget
      Dynamically-set memory target (bytes). The value of this field indicates the current target for memory available to this VM.
    • memoryStaticMax

      public Long 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

      public Long memoryDynamicMax
      Dynamic maximum (bytes)
    • memoryDynamicMin

      public Long memoryDynamicMin
      Dynamic minimum (bytes)
    • memoryStaticMin

      public Long 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

      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
    • actionsAfterSoftreboot

      public Types.OnSoftrebootBehavior actionsAfterSoftreboot
      action to take after soft reboot Experimental. First published in 23.1.0.
    • actionsAfterShutdown

      public Types.OnNormalExit actionsAfterShutdown
      action to take after the guest has shutdown itself
    • actionsAfterReboot

      public Types.OnNormalExit actionsAfterReboot
      action to take after the guest has rebooted itself
    • actionsAfterCrash

      public 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
    • VUSBs

      public Set<VUSB> VUSBs
      vitual usb 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
    • PVLegacyArgs

      public String PVLegacyArgs
      to make Zurich guests boot
    • HVMBootPolicy

      public String HVMBootPolicy
      HVM boot policy
    • HVMBootParams

      public Map<String,String> HVMBootParams
      HVM boot params
    • HVMShadowMultiplier

      public Double HVMShadowMultiplier
      multiplier applied to the amount of shadow that will be made available to the guest First published in XenServer 4.1.
    • 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)
    • domarch

      public String domarch
      Domain architecture (if available, null string otherwise)
    • lastBootCPUFlags

      public Map<String,String> lastBootCPUFlags
      describes the CPU flags on which the VM was last booted
    • 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
    • lastBootedRecord

      public String lastBootedRecord
      marshalled value containing VM record at time of last boot First published in XenServer 4.1.
    • recommendations

      public String recommendations
      An XML specification of recommended values and ranges for properties of this VM
    • xenstoreData

      public Map<String,String> 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

      public Boolean haAlwaysRun
      if true then the system will attempt to keep the VM running as much as possible. First published in XenServer 5.0.
    • haRestartPriority

      public String 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

      public Boolean 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

      public VM snapshotOf
      Ref pointing to the VM this snapshot is of. First published in XenServer 5.0.
    • snapshots

      public Set<VM> snapshots
      List pointing to all the VM snapshots. First published in XenServer 5.0.
    • snapshotTime

      public Date snapshotTime
      Date/time when this snapshot was created. First published in XenServer 5.0.
    • transportableSnapshotId

      public String transportableSnapshotId
      Transportable ID of the snapshot VM First published in XenServer 5.0.
    • blobs

      public Map<String,Blob> blobs
      Binary blobs associated with this VM First published in XenServer 5.0.
    • tags

      public Set<String> tags
      user-specified tags for categorization purposes First published in XenServer 5.0.
    • blockedOperations

      public Map<Types.VmOperations,String> blockedOperations
      List of operations which have been explicitly blocked and an error code First published in XenServer 5.0.
    • snapshotInfo

      public Map<String,String> snapshotInfo
      Human-readable information concerning this snapshot First published in XenServer 5.6.
    • snapshotMetadata

      public String snapshotMetadata
      Encoded information about the VM's metadata this is a snapshot of First published in XenServer 5.6.
    • parent

      public VM parent
      Ref pointing to the parent of this VM First published in XenServer 5.6.
    • children

      public Set<VM> children
      List pointing to all the children of this VM First published in XenServer 5.6.
    • biosStrings

      public Map<String,String> biosStrings
      BIOS strings First published in XenServer 5.6.
    • protectionPolicy

      public VMPP protectionPolicy
      Ref pointing to a protection policy for this VM First published in XenServer 5.6 FP1.
    • isSnapshotFromVmpp

      public Boolean isSnapshotFromVmpp
      true if this snapshot was created by the protection policy First published in XenServer 5.6 FP1.
    • snapshotSchedule

      public VMSS snapshotSchedule
      Ref pointing to a snapshot schedule for this VM First published in XenServer 7.2.
    • isVmssSnapshot

      public Boolean isVmssSnapshot
      true if this snapshot was created by the snapshot schedule First published in XenServer 7.2.
    • appliance

      public VMAppliance appliance
      the appliance to which this VM belongs
    • startDelay

      public Long startDelay
      The delay to wait before proceeding to the next order in the startup sequence (seconds) First published in XenServer 6.0.
    • shutdownDelay

      public Long shutdownDelay
      The delay to wait before proceeding to the next order in the shutdown sequence (seconds) First published in XenServer 6.0.
    • order

      public Long order
      The point in the startup or shutdown sequence at which this VM will be started First published in XenServer 6.0.
    • VGPUs

      public Set<VGPU> VGPUs
      Virtual GPUs First published in XenServer 6.0.
    • attachedPCIs

      public Set<PCI> attachedPCIs
      Currently passed-through PCI devices First published in XenServer 6.0.
    • suspendSR

      public SR suspendSR
      The SR on which a suspend image is stored First published in XenServer 6.0.
    • version

      public Long version
      The number of times this VM has been recovered First published in XenServer 6.0.
    • generationId

      public String generationId
      Generation ID of the VM First published in XenServer 6.2.
    • hardwarePlatformVersion

      public Long hardwarePlatformVersion
      The host virtual hardware platform version the VM can run on First published in XenServer 6.5 SP1.
    • hasVendorDevice

      public Boolean 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

      public Boolean 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

      public String 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

      public Types.DomainType domainType
      The type of domain that will be created when the VM is started First published in XenServer 7.5.
    • NVRAM

      public Map<String,String> 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

      public Set<Types.UpdateGuidances> pendingGuidances
      The set of pending guidances after applying updates First published in 1.303.0.
  • Constructor Details

    • Record

      public Record()
  • Method Details