Remove-ClusterResource

Remove-ClusterResource

Remove a clustered resource from the failover cluster.

Syntax

Remove-ClusterResource [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [-Force] [<CommonParameters>]
  • InputObject

  • Name

  • Cluster

  • Force

Detailed Description

Before removing a resource, be sure to review whether any other resource is dependent on that resource.

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 resource to remove.

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 resource to remove.

Default Value: **

Data Type: StringCollection

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

Return Type

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Remove-ClusterResource "Cluster Disk 4"

Description

-----------

After prompting for confirmation, this command deletes Cluster Disk 4 from the local cluster.

 

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

 
Remove-ClusterResource "Cluster Disk 5" -force

Description

-----------

This command deletes Cluster Disk 5 from the local cluster without prompting for confirmation.

See Also

Reference

Add-ClusterResource
Get-ClusterResource
Move-ClusterResource
Resume-ClusterResource
Start-ClusterResource
Stop-ClusterResource
Suspend-ClusterResource

Other Resources

Online version: