Stop-Cluster

Article
11/23/2015

Stop-Cluster

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

Syntax

Parameter Set: InputObject
Stop-Cluster [-Cluster <String> ] [-Force] [-InputObject <PSObject> ] [ <CommonParameters>]

Parameter Set: Name
Stop-Cluster [[-Name] <String> ] [-Cluster <String> ] [-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	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

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	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InputObject<PSObject>

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

Aliases	none
Required?	false
Position?	1
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

Microsoft.FailoverClusters.PowerShell.Cluster

Outputs

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

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.