Partager via


Remove-Cluster

Remove-Cluster

Destroys an existing failover cluster.

Syntax

Parameter Set: InputObject
Remove-Cluster [[-Cluster] <String> ] [-CleanupAD] [-Force] [-InputObject <PSObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-Cluster cmdlet destroys an existing failover cluster. The affected servers will no longer function together as a cluster.

This cmdlet deletes all copies of the cluster configuration database on all cluster nodes.

Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer.

Parameters

-CleanupAD

Specifies that when the cluster is destroyed, the objects in Active Directory that are associated with the cluster are removed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

1

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 destroy.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

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 prompts the user for confirmation, then destroys the local failover cluster and removes cluster configuration information from the cluster nodes.

PS C:\> Remove-Cluster

Example 2

This example destroys the local failover cluster and removes cluster configuration information from the cluster nodes. The cmdlet does not prompt for confirmation.

PS C:\> Remove-Cluster -Force

Example 3

This example destroys the cluster named Cluster1, removes cluster configuration information from the cluster nodes, and deletes the cluster objects in Active Directory. The cmdlet does not prompt for confirmation.

PS C:\> Get-Cluster –Name Cluster1 | Remove-Cluster -Force -CleanupAD

Get-Cluster

New-Cluster

Start-Cluster

Stop-Cluster

Test-Cluster