Get-XenClusterHostProperty

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

Syntax

Get-XenClusterHostProperty [-ClusterHost] <Cluster_host>
    -XenProperty {Uuid | Cluster | Host | Enabled | PIF | Joined | Live | LastUpdateLive | AllowedOperations | CurrentOperations | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenClusterHostProperty [-Ref] <XenRef[Cluster_host]>
    -XenProperty {Uuid | Cluster | Host | Enabled | PIF | Joined | Live | LastUpdateLive | AllowedOperations | CurrentOperations | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a ClusterHost object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Cluster\_host.
Cluster: Get the cluster field of the given Cluster\_host.
Host: Get the host field of the given Cluster\_host.
Enabled: Get the enabled field of the given Cluster\_host.
PIF: Get the PIF field of the given Cluster\_host.
Joined: Get the joined field of the given Cluster\_host.
Live: Get the live field of the given Cluster\_host.
LastUpdateLive: Get the last\_update\_live field of the given Cluster\_host.
AllowedOperations: Get the allowed\_operations field of the given Cluster\_host.
CurrentOperations: Get the current\_operations field of the given Cluster\_host.
OtherConfig: Get the other\_config field of the given Cluster\_host.

Parameters

-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

-ClusterHost

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

-Ref

The ClusterHost object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Cluster_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

-XenProperty

Selects which property to use.
Attribute Value
Type XenClusterHostProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, Cluster, Host, Enabled, PIF, Joined, Live, LastUpdateLive, AllowedOperations, CurrentOperations, OtherConfig

Inputs

  • Cluster_host
  • XenRef[Cluster_host]

Outputs

  • System.Object

Examples

Example 1: Get the Cluster property

PS> Get-XenClusterHost -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenClusterHostProperty -XenProperty Cluster
Gets the Cluster property of a ClusterHost.

Example 2: Get the Host property

PS> Get-XenClusterHost -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenClusterHostProperty -XenProperty Host
Gets the Host property of a ClusterHost.

Example 3: Get the Enabled property

PS> Get-XenClusterHost -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenClusterHostProperty -XenProperty Enabled
Gets the Enabled property of a ClusterHost.