Get-ClusterGroup
Get-ClusterGroup
Get information about one or more clustered services or applications (resource groups) in a failover cluster.
Syntax
Get-ClusterGroup [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [<CommonParameters>]
InputObject
Name
Cluster
Detailed Description
A resource group (a clustered service or application) is the unit of failover. During failover, all resources in the resource group move together.
Parameters
Cluster
Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
InputObject
Specifies the cluster or cluster node to enumerate cluster groups on.
Default Value: **
Data Type: psobject
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Name
Specifies the name of the cluster group to get.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
true |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.FailoverClusters.PowerShell.Cluster, Microsoft.FailoverClusters.PowerShell.ClusterNode
Return Type
Microsoft.FailoverClusters.PowerShell.ClusterGroup
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Get-ClusterGroup
Name OwnerNode State
---- --------- -----
Available Storage node1 Online
Cluster Group node2 Online
cluster1FS node1 Online
cluster1FS-Other node1 Online
Description
-----------
This command lists the state and owner node of each clustered service or application (resource group) in the local cluster.
-------------------------- EXAMPLE 2 --------------------------
Command Prompt: C:\PS>
Get-ClusterGroup "Cluster Group" | Get-ClusterResource
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 1 Online Cluster Group Physical Disk
Cluster IP Address Online Cluster Group IP Address
Cluster IP Addre... Online Cluster Group IPv6 Address
Cluster Name Online Cluster Group Network Name
Description
-----------
This command lists the resources in "Cluster Group" on the local cluster.
-------------------------- EXAMPLE 3 --------------------------
Command Prompt: C:\PS>
Get-ClusterNode node1 | Get-ClusterGroup
Name OwnerNode State
---- --------- -----
Cluster Group node1 Online
Description
-----------
This command lists the clustered services and applications (resource groups) that are currently owned by node1 in the local cluster.
-------------------------- EXAMPLE 4 --------------------------
Command Prompt: C:\PS>
Get-ClusterGroup FileServer1 | fl *
Cluster : Cluster1
IsCoreGroup : False
OwnerNode : node1
State : Online
Name : FileServer1
Description :
PersistentState : 0
FailoverThreshold : 4294967295
FailoverPeriod : 6
AutoFailbackType : 0
FailbackWindowStart : 4294967295
FailbackWindowEnd : 4294967295
AntiAffinityClassNames : {}
Id : 189ec8ad-1831-4f57-9bb0-3ffb9cbb9227
Description
-----------
This command displays the properties of a clustered file server (resource group) called FileServer1, in the form of a list.
See Also
Reference
Add-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup