Get-XenCluster

Last published : Nov 12, 2026
Gets the Cluster objects in the pool.
Related information
Cluster cmdlets

Syntax

Get-XenCluster [[-Ref] <XenRef[Cluster]>] [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]
Get-XenCluster [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]

Description

Retrieves the Cluster objects in the pool. With no parameters the cmdlet returns the whole collection; use -Uuid or -Ref to select one.
Cluster: Cluster-wide Cluster metadata.

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

-Ref

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

-Uuid

The UUID of the Cluster to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

Inputs

  • XenRef[Cluster]
  • guid

Outputs

  • Cluster[]

Examples

Example 1: List every Cluster

PS> Get-XenCluster
Retrieves every Cluster object in the pool. With no parameters the cmdlet fetches the whole collection.

Example 2: Retrieve one Cluster by uuid

PS> Get-XenCluster -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single Cluster. -Uuid is the way to be sure of exactly one object.

Example 3: Retrieve one Cluster by reference

PS> Get-XenCluster -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Retrieves a single Cluster. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.