PowerShell Logo Small

Get-ClusterGroup



This is the built-in help made by Microsoft for the command 'Get-ClusterGroup', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Gets information about one or more clustered roles (resource groups) in a failover cluster.

SYNTAX


Get-ClusterGroup [[-Name] <StringCollection>] [-Cluster <String>] [-InputObject <PSObject>] [-VMId <Guid>] [<CommonParameters>]



Search powershellhelp.space

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.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=321029
Format-List
Add-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup

REMARKS

<

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 –Process *
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.