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
Get-ClusterGroup
This example lists the state and owner node of each clustered role, or resource group, in the local cluster.
Example 2
Get-ClusterGroup -Name "Cluster Group" | Get-ClusterResource
This example lists the resources in Cluster Group on the local cluster.
Example 3
Get-ClusterNode -Name node1 | Get-ClusterGroup
This example lists the clustered services and applications, or resource groups, that are currently
owned by node1 in the local cluster.
Example 4
Get-ClusterGroup -Name FileServer1 | Format-List -Property *
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.