Package com.xensource.xenapi

Class Host.Record

java.lang.Object
com.xensource.xenapi.Host.Record
All Implemented Interfaces:
Types.Record
Enclosing class:
Host
public static class Host.Record extends Object implements Types.Record
Represents all the fields in a Host

  • Field Details

    • uuid

      public String uuid
      Unique identifier/object reference

    • nameLabel

      public String nameLabel
      a human-readable name

    • nameDescription

      public String nameDescription
      a notes field containing human-readable description

    • memoryOverhead

      public Long memoryOverhead
      Virtualization memory overhead (bytes).

    • allowedOperations

      public Set<Types.HostAllowedOperations> 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.HostAllowedOperations> currentOperations
      links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

    • APIVersionMajor

      public Long APIVersionMajor
      major version number

    • APIVersionMinor

      public Long APIVersionMinor
      minor version number

    • APIVersionVendor

      public String APIVersionVendor
      identification of vendor

    • APIVersionVendorImplementation

      public Map<String,String> APIVersionVendorImplementation
      details of vendor implementation

    • enabled

      public Boolean enabled
      True if the host is currently enabled

    • softwareVersion

      public Map<String,String> softwareVersion
      version strings

    • otherConfig

      public Map<String,String> otherConfig
      additional configuration

    • capabilities

      public Set<String> capabilities
      Xen capabilities

    • cpuConfiguration

      public Map<String,String> cpuConfiguration
      The CPU configuration on this host. May contain keys such as "nr_nodes", "sockets_per_node", "cores_per_socket", or "threads_per_core"

    • schedPolicy

      public String schedPolicy
      Scheduler policy currently in force on this host

    • supportedBootloaders

      public Set<String> supportedBootloaders
      a list of the bootloaders installed on the machine

    • residentVMs

      public Set<VM> residentVMs
      list of VMs currently resident on host

    • logging

      public Map<String,String> logging
      logging configuration

    • PIFs

      public Set<PIF> PIFs
      physical network interfaces

    • suspendImageSr

      public SR suspendImageSr
      The SR in which VDIs for suspend images are created

    • crashDumpSr

      public SR crashDumpSr
      The SR in which VDIs for crash dumps are created

    • crashdumps

      public Set<HostCrashdump> crashdumps
      Set of host crash dumps

    • patches

      @Deprecated(since="XenServer 4.0") public Set<HostPatch> patches
      Deprecated.
      Set of host patches

    • updates

      public Set<PoolUpdate> updates
      Set of updates First published in XenServer 7.1.

    • PBDs

      public Set<PBD> PBDs
      physical blockdevices

    • hostCPUs

      public Set<HostCpu> hostCPUs
      The physical CPUs on this host

    • cpuInfo

      public Map<String,String> cpuInfo
      Details about the physical CPUs on this host First published in XenServer 5.6.

    • hostname

      public String hostname
      The hostname of this host

    • address

      public String address
      The address by which this host can be contacted from any other host in the pool

    • metrics

      public HostMetrics metrics
      metrics associated with this host

    • licenseParams

      public Map<String,String> licenseParams
      State of the current license

    • haStatefiles

      public Set<String> haStatefiles
      The set of statefiles accessible from this host First published in XenServer 5.0.

    • haNetworkPeers

      public Set<String> haNetworkPeers
      The set of hosts visible via the network from this host First published in XenServer 5.0.

    • blobs

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

    • tags

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

    • externalAuthType

      public String externalAuthType
      type of external authentication service configured; empty if none configured. First published in XenServer 5.5.

    • externalAuthServiceName

      public String externalAuthServiceName
      name of external authentication service configured; empty if none configured. First published in XenServer 5.5.

    • externalAuthConfiguration

      public Map<String,String> externalAuthConfiguration
      configuration specific to external authentication service First published in XenServer 5.5.

    • edition

      public String edition
      Product edition First published in XenServer 5.6.

    • licenseServer

      public Map<String,String> licenseServer
      Contact information of the license server First published in XenServer 5.6.

    • biosStrings

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

    • powerOnMode

      public String powerOnMode
      The power on mode First published in XenServer 5.6.

    • powerOnConfig

      public Map<String,String> powerOnConfig
      The power on config First published in XenServer 5.6.

    • localCacheSr

      public SR localCacheSr
      The SR that is used as a local cache First published in XenServer 5.6 FP1.

    • chipsetInfo

      public Map<String,String> chipsetInfo
      Information about chipset features First published in XenServer 6.0.

    • PCIs

      public Set<PCI> PCIs
      List of PCI devices in the host First published in XenServer 6.0.

    • PGPUs

      public Set<PGPU> PGPUs
      List of physical GPUs in the host First published in XenServer 6.0.

    • PUSBs

      public Set<PUSB> PUSBs
      List of physical USBs in the host First published in XenServer 7.3.

    • sslLegacy

      @Deprecated(since="XenServer 7.0") public Boolean sslLegacy
      Deprecated.
      Allow SSLv3 protocol and ciphersuites as used by older server versions. This controls both incoming and outgoing connections. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid. First published in XenServer 7.0.

    • guestVCPUsParams

      public Map<String,String> guestVCPUsParams
      VCPUs params to apply to all resident guests First published in XenServer 6.1.

    • display

      public Types.HostDisplay display
      indicates whether the host is configured to output its console to a physical display device First published in XenServer 6.5 SP1.

    • virtualHardwarePlatformVersions

      public Set<Long> virtualHardwarePlatformVersions
      The set of versions of the virtual hardware platform that the host can offer to its guests First published in XenServer 6.5 SP1.

    • controlDomain

      public VM controlDomain
      The control domain (domain 0) First published in XenServer 7.1.

    • updatesRequiringReboot

      public Set<PoolUpdate> updatesRequiringReboot
      List of updates which require reboot First published in XenServer 7.1.

    • features

      public Set<Feature> features
      List of features available on this host First published in XenServer 7.2.

    • iscsiIqn

      public String iscsiIqn
      The initiator IQN for the host First published in XenServer 7.5.

    • multipathing

      public Boolean multipathing
      Specifies whether multipathing is enabled First published in XenServer 7.5.

    • uefiCertificates

      @Deprecated(since="Citrix Hypervisor 8.1") public String uefiCertificates
      Deprecated.
      The UEFI certificates allowing Secure Boot First published in Citrix Hypervisor 8.1.

    • certificates

      public Set<Certificate> certificates
      List of certificates installed in the host First published in Citrix Hypervisor 8.2.

    • editions

      public Set<String> editions
      List of all available product editions First published in Citrix Hypervisor 8.2.

    • pendingGuidances

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

    • tlsVerificationEnabled

      public Boolean tlsVerificationEnabled
      True if this host has TLS verifcation enabled First published in 1.313.0.

    • lastSoftwareUpdate

      public Date lastSoftwareUpdate
      Date and time when the last software update was applied Experimental. First published in 22.20.0.

    • httpsOnly

      public Boolean httpsOnly
      Reflects whether port 80 is open (false) or not (true) Experimental. First published in 22.27.0.

    • latestSyncedUpdatesApplied

      public Types.LatestSyncedUpdatesAppliedState latestSyncedUpdatesApplied
      Default as 'unknown', 'yes' if the host is up to date with updates synced from remote CDN, otherwise 'no' Experimental. First published in 23.18.0.

    • numaAffinityPolicy

      public Types.HostNumaAffinityPolicy numaAffinityPolicy
      NUMA-aware VM memory and vCPU placement policy Experimental. First published in 24.0.0.

    • pendingGuidancesRecommended

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

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

    • lastUpdateHash

      public String lastUpdateHash
      The SHA256 checksum of updateinfo of the most recently applied update on the host Experimental. First published in 24.10.0.

    • sshEnabled

      public Boolean sshEnabled
      True if SSH access is enabled for the host Experimental. First published in 25.21.0.

    • sshEnabledTimeout

      public Long sshEnabledTimeout
      The timeout in seconds after which SSH access will be automatically disabled (0 means never), this setting will be applied every time the SSH is enabled by XAPI Experimental. First published in 25.21.0.

    • sshExpiry

      public Date sshExpiry
      The time in UTC after which the SSH access will be automatically disabled Experimental. First published in 25.21.0.

    • consoleIdleTimeout

      public Long consoleIdleTimeout
      The timeout in seconds after which idle console will be automatically terminated (0 means never) Experimental. First published in 25.21.0.

    • sshAutoMode

      public Boolean sshAutoMode
      Reflects whether SSH auto mode is enabled for the host Experimental. First published in 25.27.0.

  • Constructor Details

    • Record

      public Record()

  • Method Details