Get-XenClusterProperty
Gets a property of a Cluster object.
Syntax
Get-XenClusterProperty [-Cluster] <Cluster>
-XenProperty {Uuid | ClusterHosts | PendingForget | ClusterToken | ClusterStack | ClusterStackVersion | IsQuorate | Quorum | LiveHosts | ExpectedHosts | AllowedOperations | CurrentOperations | PoolAutoJoin | TokenTimeout | TokenTimeoutCoefficient | ClusterConfig | OtherConfig | Network}
[-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenClusterProperty [-Ref] <XenRef[Cluster]>
-XenProperty {Uuid | ClusterHosts | PendingForget | ClusterToken | ClusterStack | ClusterStackVersion | IsQuorate | Quorum | LiveHosts | ExpectedHosts | AllowedOperations | CurrentOperations | PoolAutoJoin | TokenTimeout | TokenTimeoutCoefficient | ClusterConfig | OtherConfig | Network}
[-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Description
Gets a specified property of a Cluster object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Cluster.
ClusterHosts: Get the cluster\_hosts field of the given Cluster.
PendingForget: Get the pending\_forget field of the given Cluster.
ClusterToken: Get the cluster\_token field of the given Cluster.
ClusterStack: Get the cluster\_stack field of the given Cluster.
ClusterStackVersion: Get the cluster\_stack\_version field of the given Cluster.
IsQuorate: Get the is\_quorate field of the given Cluster.
Quorum: Get the quorum field of the given Cluster.
LiveHosts: Get the live\_hosts field of the given Cluster.
ExpectedHosts: Get the expected\_hosts field of the given Cluster.
AllowedOperations: Get the allowed\_operations field of the given Cluster.
CurrentOperations: Get the current\_operations field of the given Cluster.
PoolAutoJoin: Get the pool\_auto\_join field of the given Cluster.
TokenTimeout: Get the token\_timeout field of the given Cluster.
TokenTimeoutCoefficient: Get the token\_timeout\_coefficient field of the given Cluster.
ClusterConfig: Get the cluster\_config field of the given Cluster.
OtherConfig: Get the other\_config field of the given Cluster.
Network: Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs.
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 |
-Cluster
The Cluster object to operate on.
| Attribute | Value |
|---|---|
| Type | Cluster |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-Ref
The Cluster object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Cluster] |
| 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 | XenClusterProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, ClusterHosts, PendingForget, ClusterToken, ClusterStack, ClusterStackVersion, IsQuorate, Quorum, LiveHosts, ExpectedHosts, AllowedOperations, CurrentOperations, PoolAutoJoin, TokenTimeout, TokenTimeoutCoefficient, ClusterConfig, OtherConfig, Network |
Inputs
-
Cluster -
XenRef[Cluster]
Outputs
-
System.Object
Examples
Example 1: Get the ClusterHosts property
PS> Get-XenCluster -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenClusterProperty -XenProperty ClusterHosts
Gets the ClusterHosts property of a Cluster.
Example 2: Get the PendingForget property
PS> Get-XenCluster -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenClusterProperty -XenProperty PendingForget
Gets the PendingForget property of a Cluster.
Example 3: Get the ClusterToken property
PS> Get-XenCluster -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenClusterProperty -XenProperty ClusterToken
Gets the ClusterToken property of a Cluster.
Related links
-
Class: Cluster
-
Using the XenServer PowerShell module