Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-ClusterResource

Last Updated: 3/8/2017

SYNOPSIS

Removes a clustered resource from the failover cluster.

SYNTAX

Remove-ClusterResource [[-Name] <StringCollection>] [-Force] [-InputObject <PSObject>] [-Cluster <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-ClusterResource cmdlet removes a clustered resource from the failover cluster. Before removing a resource, be sure to review whether any other resource is dependent on that resource.

EXAMPLES

Example 1

PS C:\> Remove-ClusterResource -Name "Cluster Disk 4"

This example prompts the user for confirmation and then deletes the cluster named Cluster Disk 4 from the local cluster.

Example 2

PS C:\> Remove-ClusterResource -Name "Cluster Disk 5" -Force

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

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
Parameter Sets: (All)
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: 

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

-InputObject

Specifies the cluster resource to remove.

Type: PSObject
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the cluster resource to remove.

Type: StringCollection
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.FailoverClusters.PowerShell.ClusterResource

OUTPUTS

None

NOTES

Add-ClusterResource

Get-ClusterResource

Move-ClusterResource

Resume-ClusterResource

Start-ClusterResource

Stop-ClusterResource

Suspend-ClusterResource

© 2017 Microsoft