Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Stop-ClusterGroup

Stop-ClusterGroup

microsoft.failoverclusters.powershell.dll

Synopsis

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

Syntax

Stop-ClusterGroup [-Name] [-Cluster] [-IgnoreLocked] [-InputObject] [-Wait] [<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

Accept pipeline input?

false

Accept wildcard characters?

false

-IgnoreLocked <SwitchParameter>

Specifies that locked groups are ignored when running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the clustered role to stop.

Aliases

None

Required?

false

Position

named

Default value

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

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

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Notes

None

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 

Online Version
Add-ClusterGroup
Get-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup