Stop-Cluster
Stop-Cluster
Stop the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.
Syntax
Stop-Cluster [-InputObject <psobject>] [-Cluster <string>] [-Force] [<CommonParameters>]
InputObject
Cluster
Force
Stop-Cluster [[-Name] ] [-Cluster ] [-Force] []
Name
Cluster
Force
Detailed Description
A node can only function as part of the cluster when the Cluster service is running on that node.
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 |
Force
Performs the operation without prompting for confirmation. By default this operation will ask for confirmation from the user before proceeding.
Default Value: **
Data Type: SwitchParameter
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? |
false |
required |
Variable Length? |
false |
variableLength |
InputObject
Specifies the cluster to stop.
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 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 |
Input Type
Microsoft.FailoverClusters.PowerShell.Cluster
Return Type
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Stop-Cluster
Description
-----------
This command stops the Cluster service on all nodes in the local cluster, which will stop all services and applications configured in the cluster.
-------------------------- EXAMPLE 2 --------------------------
Command Prompt: C:\PS>
Stop-Cluster cluster1
Description
-----------
This command stops the Cluster service on all nodes in cluster1, which will stop all services and applications configured in the cluster.
See Also
Reference
Get-Cluster
New-Cluster
Remove-Cluster
Start-Cluster
Test-Cluster