Stop-ClusterGroup

Stop-ClusterGroup

Take one or more clustered services and applications (also known as resource groups) offline on a failover cluster.

Syntax

Stop-ClusterGroup [-InputObject <psobject>] [[-Name] <string>] [-Cluster <string>] [-Wait <int>] [<CommonParameters>]
  • InputObject

  • Name

  • Cluster

  • Wait

Detailed Description

If you need to perform maintenance on a clustered service or application, you can take it offline in an orderly fashion by using this cmdlet.

Parameters

Cluster

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

InputObject

Specifies the cluster group to offline.

Default Value: **

Data Type: psobject

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

Specifies the name of the cluster group to stop.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Wait

Specifies the time in seconds to wait for the operation. If this parameter is not specified the operation waits for completion. If "-Wait 0" is specified the call is initiated and the cmdlet returns right away.

Default Value: **

Data Type: int

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Input Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Stop-ClusterGroup FileServer1 
 
Name                       OwnerNode                            State 
----                       ---------                            ----- 
FileServer1                 node1                              Offline

Description

-----------

This command takes the clustered file server (resource group) called FileServer1 offline on the local cluster.

See Also

Reference

Add-ClusterGroup
Get-ClusterGroup
Move-ClusterGroup
Remove-ClusterGroup
Start-ClusterGroup

Other Resources

Online version: