Export (0) Print
Expand All
Expand Minimize

Stop-ClusterGroup

Updated: August 15, 2012

Applies To: Windows Server 2012

Stop-ClusterGroup

Stops one or more clustered roles, also known as resource groups, on a failover cluster.

Syntax

Parameter Set: InputObject
Stop-ClusterGroup [[-Name] <String> ] [-Cluster <String> ] [-IgnoreLocked] [-InputObject <PSObject> ] [-Wait <Int32> ] [ <CommonParameters>]




Detailed Description

The Stop-ClusterGroup cmdlet stops one or more clustered roles, also known as resource groups, on a failover cluster.

If maintenance on a clustered role is needed, the clustered role can be stopped in an orderly fashion by using this cmdlet.

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

-IgnoreLocked

Specifies that locked groups are ignored when running the cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<PSObject>

Specifies the clustered role to stop.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the clustered role to stop.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Wait<Int32>

Specifies the time in seconds to wait for the cmdlet. If the Wait parameter is not specified, then the cmdlet waits for completion. If -Wait 0 is specified, then the call is initiated and the cmdlet returns without waiting.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

Outputs

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

  • Microsoft.FailoverClusters.PowerShell.ClusterGroup

Examples

Example 1

This example stops the clustered role, or resource group, called FileServer1 on the local cluster.


PS C:\> Stop-ClusterGroup FileServer1
Name                       OwnerNode                            State 
----                       ---------                            ----- 
FileServer1                 node1                              Offline 

Related topics

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