Remove-ClusterResource
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 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | 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 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the cluster resource to remove.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of the cluster resource to remove.
Type: | StringCollection |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.FailoverClusters.PowerShell.ClusterResource
Outputs
None