Export (0) Print
Expand All
Expand Minimize

Get-ClusterGroup

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-ClusterGroup

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

Syntax

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




Detailed 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.

Parameters

-Cluster<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<PSObject>

Specifies the cluster or cluster node on which to enumerate the clustered roles.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<StringCollection>

Specifies the name of the clustered role to get.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-VMId<Guid>

Specifies the virtual machine identifier (ID).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.FailoverClusters.PowerShell.Cluster
  • Microsoft.FailoverClusters.PowerShell.ClusterNode

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.FailoverClusters.PowerShell.ClusterGroup

Examples

EXAMPLE 1

This example lists the state and owner node of each clustered role, or resource group, in the local cluster.


PS C:\> Get-ClusterGroup
Name                       OwnerNode                                      State 
----                       ---------                                      ----- 
Available Storage          node1                                         Online 
Cluster Group              node2                                         Online 
cluster1FS                 node1                                         Online 
cluster1FS-Other           node1                                         Online 

EXAMPLE 2

This example lists the resources in Cluster Group on the local cluster.


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 

EXAMPLE 3

This example lists the clustered services and applications, or resource groups, that are currently owned by node1 in the local cluster.


PS C:\> Get-ClusterNode –Name node1 | Get-ClusterGroup
Name                       OwnerNode                                      State 
----                       ---------                                      ----- 
Cluster Group              node1                                         Online 

EXAMPLE 4

This example displays the properties of a clustered file server, or resource group, called FileServer1, in the form of a list.


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 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft