Remove-Cluster
Remove-Cluster
Destroy an existing failover cluster. The affected servers will no longer function together as a cluster.
Syntax
Remove-Cluster [-InputObject <psobject>] [-CleanupAD] [-Cluster <string>] [-Force] [<CommonParameters>]
InputObject
CleanupAD
Cluster
Force
Detailed Description
This action deletes all copies of the cluster configuration database on all cluster nodes.
Parameters
CleanupAD
Causes the cluster destroy operation to remove the objects in Active Directory associated with this cluster.
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 |
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 destroy.
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 |
Input Type
Microsoft.FailoverClusters.PowerShell.Cluster
Return Type
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Remove-Cluster
Description
-----------
After prompting for confirmation, this command destroys the local failover cluster and removes cluster configuration information from the cluster nodes.
-------------------------- EXAMPLE 2 --------------------------
Command Prompt: C:\PS>
Remove-Cluster -Force
Description
-----------
This command destroys the local failover cluster and removes cluster configuration information from the cluster nodes. The command does not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Command Prompt: C:\PS>
Get-Cluster Cluster1 | Remove-Cluster -Force -CleanupAD
Description
-----------
This command destroys Cluster1, removes cluster configuration information from the cluster nodes, and deletes the cluster objects in Active Directory. The command does not prompt for confirmation.
See Also
Reference
Get-Cluster
New-Cluster
Start-Cluster
Stop-Cluster
Test-Cluster