Class Pool.Record

java.lang.Object
com.xensource.xenapi.Pool.Record
All Implemented Interfaces:
Types.Record
Enclosing class:
Pool

public static class Pool.Record extends Object implements Types.Record
Represents all the fields in a Pool
  • Field Details

    • uuid

      public String uuid
      Unique identifier/object reference
    • nameLabel

      public String nameLabel
      Short name
    • nameDescription

      public String nameDescription
      Description
    • master

      public Host master
      The host that is pool master
    • defaultSR

      public SR defaultSR
      Default SR for VDIs
    • 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
    • otherConfig

      public Map<String,String> otherConfig
      additional configuration
    • haEnabled

      public Boolean haEnabled
      true if HA is enabled on the pool, false otherwise First published in XenServer 5.0.
    • haConfiguration

      public Map<String,String> haConfiguration
      The current HA configuration First published in XenServer 5.0.
    • haStatefiles

      public Set<String> haStatefiles
      HA statefile VDIs in use First published in XenServer 5.0.
    • haHostFailuresToTolerate

      public Long haHostFailuresToTolerate
      Number of host failures to tolerate before the Pool is declared to be overcommitted First published in XenServer 5.0.
    • haPlanExistsFor

      public Long haPlanExistsFor
      Number of future host failures we have managed to find a plan for. Once this reaches zero any future host failures will cause the failure of protected VMs. First published in XenServer 5.0.
    • haAllowOvercommit

      public Boolean haAllowOvercommit
      If set to false then operations which would cause the Pool to become overcommitted will be blocked. First published in XenServer 5.0.
    • haOvercommitted

      public Boolean haOvercommitted
      True if the Pool is considered to be overcommitted i.e. if there exist insufficient physical resources to tolerate the configured number of host failures First published in XenServer 5.0.
    • blobs

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

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

      public Map<String,String> guiConfig
      gui-specific configuration for pool First published in XenServer 5.0.
    • healthCheckConfig

      public Map<String,String> healthCheckConfig
      Configuration for the automatic health check feature First published in XenServer 7.0.
    • wlbUrl

      public String wlbUrl
      Url for the configured workload balancing host First published in XenServer 5.5.
    • wlbUsername

      public String wlbUsername
      Username for accessing the workload balancing host First published in XenServer 5.5.
    • wlbEnabled

      public Boolean wlbEnabled
      true if workload balancing is enabled on the pool, false otherwise First published in XenServer 5.5.
    • wlbVerifyCert

      public Boolean wlbVerifyCert
      true if communication with the WLB server should enforce TLS certificate verification. First published in XenServer 5.5.
    • redoLogEnabled

      public Boolean redoLogEnabled
      true a redo-log is to be used other than when HA is enabled, false otherwise First published in XenServer 5.6.
    • redoLogVdi

      public VDI redoLogVdi
      indicates the VDI to use for the redo-log other than when HA is enabled First published in XenServer 5.6.
    • vswitchController

      public String vswitchController
      address of the vswitch controller First published in XenServer 5.6.
    • restrictions

      public Map<String,String> restrictions
      Pool-wide restrictions currently in effect First published in XenServer 5.6.
    • metadataVDIs

      public Set<VDI> metadataVDIs
      The set of currently known metadata VDIs for this pool First published in XenServer 6.0.
    • haClusterStack

      public String haClusterStack
      The HA cluster stack that is currently in use. Only valid when HA is enabled. First published in XenServer 7.0.
    • allowedOperations

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

      public Map<String,String> guestAgentConfig
      Pool-wide guest agent configuration information First published in XenServer 7.0.
    • cpuInfo

      public Map<String,String> cpuInfo
      Details about the physical CPUs on the pool First published in XenServer 7.0.
    • policyNoVendorDevice

      public Boolean policyNoVendorDevice
      The pool-wide policy for clients on whether to use the vendor device or not on newly created VMs. This field will also be consulted if the 'has_vendor_device' field is not specified in the VM.create call. First published in XenServer 7.0.
    • livePatchingDisabled

      public Boolean livePatchingDisabled
      The pool-wide flag to show if the live patching feauture is disabled or not. First published in XenServer 7.1.
    • igmpSnoopingEnabled

      public Boolean igmpSnoopingEnabled
      true if IGMP snooping is enabled in the pool, false otherwise. First published in XenServer 7.3.
    • uefiCertificates

      public String uefiCertificates
      The UEFI certificates allowing Secure Boot First published in Citrix Hypervisor 8.1.
    • customUefiCertificates

      public String customUefiCertificates
      Custom UEFI certificates allowing Secure Boot Experimental. First published in 24.1.0.
    • isPsrPending

      public Boolean isPsrPending
      True if either a PSR is running or we are waiting for a PSR to be re-run First published in Citrix Hypervisor 8.2 Hotfix 2.
    • tlsVerificationEnabled

      public Boolean tlsVerificationEnabled
      True iff TLS certificate verification is enabled First published in 1.290.0.
    • repositories

      public Set<Repository> repositories
      The set of currently enabled repositories First published in 1.301.0.
    • clientCertificateAuthEnabled

      public Boolean clientCertificateAuthEnabled
      True if authentication by TLS client certificates is enabled First published in 1.318.0.
    • clientCertificateAuthName

      public String clientCertificateAuthName
      The name (CN/SAN) that an incoming client certificate must have to allow authentication First published in 1.318.0.
    • repositoryProxyUrl

      public String repositoryProxyUrl
      Url of the proxy used in syncing with the enabled repositories First published in 21.3.0.
    • repositoryProxyUsername

      public String repositoryProxyUsername
      Username for the authentication of the proxy used in syncing with the enabled repositories First published in 21.3.0.
    • repositoryProxyPassword

      public Secret repositoryProxyPassword
      Password for the authentication of the proxy used in syncing with the enabled repositories First published in 21.3.0.
    • migrationCompression

      public Boolean migrationCompression
      Default behaviour during migration, True if stream compression should be used Experimental. First published in 22.33.0.
    • coordinatorBias

      public Boolean coordinatorBias
      true if bias against pool master when scheduling vms is enabled, false otherwise
    • localAuthMaxThreads

      public Long localAuthMaxThreads
      Maximum number of threads to use for PAM authentication Experimental. First published in 23.27.0.
    • extAuthMaxThreads

      public Long extAuthMaxThreads
      Maximum number of threads to use for external (AD) authentication Experimental. First published in 23.27.0.
    • telemetryUuid

      public Secret telemetryUuid
      The UUID of the pool for identification of telemetry data Experimental. First published in 23.9.0.
    • telemetryFrequency

      public Types.TelemetryFrequency telemetryFrequency
      How often the telemetry collection will be carried out Experimental. First published in 23.9.0.
    • telemetryNextCollection

      public Date telemetryNextCollection
      The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out Experimental. First published in 23.9.0.
    • lastUpdateSync

      public Date lastUpdateSync
      time of the last update sychronization Experimental. First published in 23.18.0.
    • updateSyncFrequency

      public Types.UpdateSyncFrequency updateSyncFrequency
      The frequency at which updates are synchronized from a remote CDN: daily or weekly. Experimental. First published in 23.18.0.
    • updateSyncDay

      public Long updateSyncDay
      The day of the week the update synchronizations will be scheduled, based on pool's local timezone. Ignored when update_sync_frequency is daily Experimental. First published in 23.18.0.
    • updateSyncEnabled

      public Boolean updateSyncEnabled
      Whether periodic update synchronization is enabled or not Experimental. First published in 23.18.0.
  • Constructor Details

    • Record

      public Record()
  • Method Details