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-Cluster

Stop-Cluster

microsoft.failoverclusters.powershell.dll

Synopsis

Stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.

Syntax

Stop-Cluster [-Cluster] [-Force] [-InputObject] [<CommonParameters>]

Stop-Cluster [-Name] [-Cluster] [-Force] [<CommonParameters>]

Detailed Description

The Stop-Cluster cmdlet stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster. A node can only function as part of the cluster when the Cluster service is running on that node.

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

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the cluster 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 cluster to stop.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster

Return Type

None

Notes

None

Examples

EXAMPLE 1

This example stops the Cluster service on all nodes in the local cluster, which will stop all services and applications configured in the cluster.

PS C:\>Stop-Cluster

EXAMPLE 2

This example stops the Cluster service on all nodes in the cluster named cluster1, which will stop all services and applications configured in the cluster.

PS C:\>Stop-Cluster cluster1

Online Version
Get-Cluster
New-Cluster
Remove-Cluster
Start-Cluster
Test-Cluster