Stop-Cluster

  • Reference
Module:
FailoverClusters

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] <String>]
    [-Force]
    [-Wait <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-Cluster
    [-Force]
    [-Wait <Int32>]
    [-InputObject <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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.

Examples

Example 1: Stop Cluster service on all nodes of the local cluster

PS C:\> Stop-Cluster

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

Example 2: Stop Cluster service on all nodes of a cluster

PS C:\> Stop-Cluster -Name cluster1

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.

Parameters

-Cluster

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.

Type:String
Aliases:Name
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster to stop.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Wait

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Outputs

None