Get-ClusterGroup
Gets information about one or more clustered roles (resource groups) in a failover cluster.
Syntax
Default (Default)
Get-ClusterGroup
[[-Name] <StringCollection>]
[-VMId <Guid>]
[-InputObject <PSObject>]
[-Cluster <String>]
[<CommonParameters>]
Description
The Get-ClusterGroup cmdlet gets information about one or more clustered roles (resource groups) in a failover cluster.
A resource group is the unit of failover. During failover, all resources in the resource group move together.
Examples
Example 1
PS C:\> Get-ClusterGroup
Name OwnerNode State
---- --------- -----
Available Storage node1 Online
Cluster Group node2 Online
cluster1FS node1 Online
cluster1FS-Other node1 Online
This example lists the state and owner node of each clustered role, or resource group, in the local cluster.
Example 2
PS C:\> Get-ClusterGroup -Name "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
This example lists the resources in Cluster Group on the local cluster.
Example 3
PS C:\> Get-ClusterNode -Name node1 | Get-ClusterGroup
Name OwnerNode State
---- --------- -----
Cluster Group node1 Online
This example lists the clustered services and applications, or resource groups, that are currently owned by node1 in the local cluster.
Example 4
PS C:\> Get-ClusterGroup -Name FileServer1 | Format-List -Property *
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
This example displays the properties of a clustered file server, or resource group, called FileServer1, in the form of a list.
Parameters
-Cluster
Specifies the name of the cluster on which to run this cmdlet.
If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the cluster or cluster node on which to enumerate the clustered roles.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the clustered role to get.
Parameter properties
| Type: | StringCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMId
Specifies the virtual machine identifier (ID).
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.