Get-Cluster
Get-Cluster
Gets information about one or more failover clusters in a given domain.
Syntax
Parameter Set: Name
Get-Cluster [[-Name] <String> ] [-Domain <String> ] [ <CommonParameters>]
Detailed Description
The Get-Cluster cmdlet gets information about one or more failover clusters in a given domain.
This cmdlet can obtain a variety of configuration and state information about a failover cluster, including the following items:
-- State information about whether a backup is in progress.
-- State information about whether the cluster is in a forced quorum state.
-- Cross-network settings that are especially relevant for multi-site clusters.
To set a common property for the cluster, use this cmdlet to get the cluster object and then set the appropriate property on that cluster object directly.
Parameters
-Domain<String>
Specifies the name of the domain in which to enumerate clusters.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the cluster to get.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.Cluster
Examples
EXAMPLE 1
This example displays state and property information for the local cluster in the form of a list.
PS C:\> Get-Cluster | Format-List –Property *
EXAMPLE 2
This example gets information about a cluster named cluster1.
PS C:\> Get-Cluster –Name cluster1
EXAMPLE 3
This example gets information about each of the clusters in the contoso.com domain.
PS C:\> Get-Cluster -Domain contoso.com
EXAMPLE 4
This example sets the common property called CrossSubnetDelay for the local cluster to 1500.
PS C:\> Get-Cluster | ForEach-Object –Process {$_.CrossSubnetDelay = 1500}
EXAMPLE 5
This example enables the Dynamic Quorum feature for the cluster.
PS C:\> (Get-Cluster).DynamicQuorum = 1