Get-XenHostProperty

Last published : Nov 12, 2026
Gets a property of a Host object.
Related information
Host cmdlets

Syntax

Get-XenHostProperty [-XenHost] <Host>
    -XenProperty {Uuid | NameLabel | NameDescription | MemoryOverhead | AllowedOperations | CurrentOperations | APIVersionMajor | APIVersionMinor | APIVersionVendor | APIVersionVendorImplementation | Enabled | SoftwareVersion | OtherConfig | Capabilities | CpuConfiguration | SchedPolicy | SupportedBootloaders | ResidentVMs | Logging | PIFs | SuspendImageSr | CrashDumpSr | Crashdumps | Patches | Updates | PBDs | HostCPUs | CpuInfo | Hostname | Address | Metrics | LicenseParams | HaStatefiles | HaNetworkPeers | Blobs | Tags | ExternalAuthType | ExternalAuthServiceName | ExternalAuthConfiguration | Edition | LicenseServer | BiosStrings | PowerOnMode | PowerOnConfig | LocalCacheSr | ChipsetInfo | PCIs | PGPUs | PUSBs | SslLegacy | GuestVCPUsParams | Display | VirtualHardwarePlatformVersions | ControlDomain | UpdatesRequiringReboot | Features | IscsiIqn | Multipathing | UefiCertificates | Certificates | Editions | PendingGuidances | TlsVerificationEnabled | LastSoftwareUpdate | HttpsOnly | LatestSyncedUpdatesApplied | NumaAffinityPolicy | PendingGuidancesRecommended | PendingGuidancesFull | LastUpdateHash | SshEnabled | SshEnabledTimeout | SshExpiry | ConsoleIdleTimeout | SshAutoMode | MaxCstate | SecureBoot | NtpMode | NtpCustomServers | Timezone | Log | DataSources | VmsWhichPreventEvacuation | UncooperativeResidentVMs | ManagementInterface | SystemStatusCapabilities | Servertime | ServerLocaltime | ServerCertificate | SchedGran | TrackedUserAgents | NtpServersStatus | NtpSynchronized}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenHostProperty [-Ref] <XenRef[Host]>
    -XenProperty {Uuid | NameLabel | NameDescription | MemoryOverhead | AllowedOperations | CurrentOperations | APIVersionMajor | APIVersionMinor | APIVersionVendor | APIVersionVendorImplementation | Enabled | SoftwareVersion | OtherConfig | Capabilities | CpuConfiguration | SchedPolicy | SupportedBootloaders | ResidentVMs | Logging | PIFs | SuspendImageSr | CrashDumpSr | Crashdumps | Patches | Updates | PBDs | HostCPUs | CpuInfo | Hostname | Address | Metrics | LicenseParams | HaStatefiles | HaNetworkPeers | Blobs | Tags | ExternalAuthType | ExternalAuthServiceName | ExternalAuthConfiguration | Edition | LicenseServer | BiosStrings | PowerOnMode | PowerOnConfig | LocalCacheSr | ChipsetInfo | PCIs | PGPUs | PUSBs | SslLegacy | GuestVCPUsParams | Display | VirtualHardwarePlatformVersions | ControlDomain | UpdatesRequiringReboot | Features | IscsiIqn | Multipathing | UefiCertificates | Certificates | Editions | PendingGuidances | TlsVerificationEnabled | LastSoftwareUpdate | HttpsOnly | LatestSyncedUpdatesApplied | NumaAffinityPolicy | PendingGuidancesRecommended | PendingGuidancesFull | LastUpdateHash | SshEnabled | SshEnabledTimeout | SshExpiry | ConsoleIdleTimeout | SshAutoMode | MaxCstate | SecureBoot | NtpMode | NtpCustomServers | Timezone | Log | DataSources | VmsWhichPreventEvacuation | UncooperativeResidentVMs | ManagementInterface | SystemStatusCapabilities | Servertime | ServerLocaltime | ServerCertificate | SchedGran | TrackedUserAgents | NtpServersStatus | NtpSynchronized}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]

Description

Gets a specified property of a Host object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given host.
NameLabel: Get the name/label field of the given host.
NameDescription: Get the name/description field of the given host.
MemoryOverhead: Get the memory/overhead field of the given host.
AllowedOperations: Get the allowed\_operations field of the given host.
CurrentOperations: Get the current\_operations field of the given host.
APIVersionMajor: Get the API\_version/major field of the given host.
APIVersionMinor: Get the API\_version/minor field of the given host.
APIVersionVendor: Get the API\_version/vendor field of the given host.
APIVersionVendorImplementation: Get the API\_version/vendor\_implementation field of the given host.
Enabled: Get the enabled field of the given host.
SoftwareVersion: Get the software\_version field of the given host.
OtherConfig: Get the other\_config field of the given host.
Capabilities: Get the capabilities field of the given host.
CpuConfiguration: Get the cpu\_configuration field of the given host.
SchedPolicy: Get the sched\_policy field of the given host.
SupportedBootloaders: Get the supported\_bootloaders field of the given host.
ResidentVMs: Get the resident\_VMs field of the given host.
Logging: Get the logging field of the given host.
PIFs: Get the PIFs field of the given host.
SuspendImageSr: Get the suspend\_image\_sr field of the given host.
CrashDumpSr: Get the crash\_dump\_sr field of the given host.
Crashdumps: Get the crashdumps field of the given host.
Patches: Get the patches field of the given host. (Deprecated.)
Updates: Get the updates field of the given host.
PBDs: Get the PBDs field of the given host.
HostCPUs: Get the host\_CPUs field of the given host.
CpuInfo: Get the cpu\_info field of the given host.
Hostname: Get the hostname field of the given host.
Address: Get the address field of the given host.
Metrics: Get the metrics field of the given host.
LicenseParams: Get the license\_params field of the given host.
HaStatefiles: Get the ha\_statefiles field of the given host.
HaNetworkPeers: Get the ha\_network\_peers field of the given host.
Blobs: Get the blobs field of the given host.
Tags: Get the tags field of the given host.
ExternalAuthType: Get the external\_auth\_type field of the given host.
ExternalAuthServiceName: Get the external\_auth\_service\_name field of the given host.
ExternalAuthConfiguration: Get the external\_auth\_configuration field of the given host.
Edition: Get the edition field of the given host.
LicenseServer: Get the license\_server field of the given host.
BiosStrings: Get the bios\_strings field of the given host.
PowerOnMode: Get the power\_on\_mode field of the given host.
PowerOnConfig: Get the power\_on\_config field of the given host.
LocalCacheSr: Get the local\_cache\_sr field of the given host.
ChipsetInfo: Get the chipset\_info field of the given host.
PCIs: Get the PCIs field of the given host.
PGPUs: Get the PGPUs field of the given host.
PUSBs: Get the PUSBs field of the given host.
SslLegacy: Get the ssl\_legacy field of the given host. (Deprecated.)
GuestVCPUsParams: Get the guest\_VCPUs\_params field of the given host.
Display: Get the display field of the given host.
VirtualHardwarePlatformVersions: Get the virtual\_hardware\_platform\_versions field of the given host.
ControlDomain: Get the control\_domain field of the given host.
UpdatesRequiringReboot: Get the updates\_requiring\_reboot field of the given host.
Features: Get the features field of the given host.
IscsiIqn: Get the iscsi\_iqn field of the given host.
Multipathing: Get the multipathing field of the given host.
UefiCertificates: Get the uefi\_certificates field of the given host. (Deprecated.)
Certificates: Get the certificates field of the given host.
Editions: Get the editions field of the given host.
PendingGuidances: Get the pending\_guidances field of the given host.
TlsVerificationEnabled: Get the tls\_verification\_enabled field of the given host.
LastSoftwareUpdate: Get the last\_software\_update field of the given host.
HttpsOnly: Get the https\_only field of the given host.
LatestSyncedUpdatesApplied: Get the latest\_synced\_updates\_applied field of the given host.
NumaAffinityPolicy: Get the numa\_affinity\_policy field of the given host.
PendingGuidancesRecommended: Get the pending\_guidances\_recommended field of the given host.
PendingGuidancesFull: Get the pending\_guidances\_full field of the given host.
LastUpdateHash: Get the last\_update\_hash field of the given host.
SshEnabled: Get the ssh\_enabled field of the given host.
SshEnabledTimeout: Get the ssh\_enabled\_timeout field of the given host.
SshExpiry: Get the ssh\_expiry field of the given host.
ConsoleIdleTimeout: Get the console\_idle\_timeout field of the given host.
SshAutoMode: Get the ssh\_auto\_mode field of the given host.
MaxCstate: Get the max\_cstate field of the given host.
SecureBoot: Get the secure\_boot field of the given host.
NtpMode: Get the ntp\_mode field of the given host.
NtpCustomServers: Get the ntp\_custom\_servers field of the given host.
Timezone: Get the timezone field of the given host.
Log: Get the host's log file.
DataSources
VmsWhichPreventEvacuation: Return a set of VMs which prevent the host being evacuated, with per-VM error codes.
UncooperativeResidentVMs: Return a set of VMs which are not co-operating with the host's memory control system. (Deprecated.)
ManagementInterface: Returns the management interface for the specified host.
SystemStatusCapabilities
Servertime: This call queries the host's clock for the current time.
ServerLocaltime: This call queries the host's clock for the current time in the host's local timezone.
ServerCertificate: Get the installed server public TLS certificate.
SchedGran: Gets xen's sched-gran on a host.
TrackedUserAgents: Get the (name, version) list of tracked user agents on this host. If different versions of the same name are seen, keep the last-seen version. The oldest entry will be removed if reach the max num. Note that the list is cleared after host/XAPI restart.
NtpServersStatus: Get the NTP servers status on the host.
NtpSynchronized: Returns true if the system clock on the host is synchronized with the NTP servers.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Ref

The Host object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Host]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-XenHost

The Host object to operate on.
Attribute Value
Type Host
Required True
Position 0
Accepts pipeline input True (ByValue)

-XenProperty

Selects which property to use.
Attribute Value
Type XenHostProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, MemoryOverhead, AllowedOperations, CurrentOperations, APIVersionMajor, APIVersionMinor, APIVersionVendor, APIVersionVendorImplementation, Enabled, SoftwareVersion, OtherConfig, Capabilities, CpuConfiguration, SchedPolicy, SupportedBootloaders, ResidentVMs, Logging, PIFs, SuspendImageSr, CrashDumpSr, Crashdumps, Patches, Updates, PBDs, HostCPUs, CpuInfo, Hostname, Address, Metrics, LicenseParams, HaStatefiles, HaNetworkPeers, Blobs, Tags, ExternalAuthType, ExternalAuthServiceName, ExternalAuthConfiguration, Edition, LicenseServer, BiosStrings, PowerOnMode, PowerOnConfig, LocalCacheSr, ChipsetInfo, PCIs, PGPUs, PUSBs, SslLegacy, GuestVCPUsParams, Display, VirtualHardwarePlatformVersions, ControlDomain, UpdatesRequiringReboot, Features, IscsiIqn, Multipathing, UefiCertificates, Certificates, Editions, PendingGuidances, TlsVerificationEnabled, LastSoftwareUpdate, HttpsOnly, LatestSyncedUpdatesApplied, NumaAffinityPolicy, PendingGuidancesRecommended, PendingGuidancesFull, LastUpdateHash, SshEnabled, SshEnabledTimeout, SshExpiry, ConsoleIdleTimeout, SshAutoMode, MaxCstate, SecureBoot, NtpMode, NtpCustomServers, Timezone, Log, DataSources, VmsWhichPreventEvacuation, UncooperativeResidentVMs, ManagementInterface, SystemStatusCapabilities, Servertime, ServerLocaltime, ServerCertificate, SchedGran, TrackedUserAgents, NtpServersStatus, NtpSynchronized

Inputs

  • Host
  • XenRef[Host]

Outputs

  • System.Object

Examples

Example 1: Get the MemoryOverhead property

PS> Get-XenHost -Name "Demo Host" | Get-XenHostProperty -XenProperty MemoryOverhead
Gets the MemoryOverhead property of a Host.

Example 2: Get the AllowedOperations property

PS> Get-XenHost -Name "Demo Host" | Get-XenHostProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a Host.

Example 3: Get the CurrentOperations property

PS> Get-XenHost -Name "Demo Host" | Get-XenHostProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a Host.
  • Host cmdlets
  • Class: Host
  • Using the XenServer PowerShell module