Remove-ClusterResource
Remove-ClusterResource
Removes a clustered resource from the failover cluster.
Syntax
Parameter Set: InputObject
Remove-ClusterResource [[-Name] <StringCollection> ] [-Cluster <String> ] [-Force] [-InputObject <PSObject> ] [ <CommonParameters>]
Detailed 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.
Parameters
-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? |
named |
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 resource to remove.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<StringCollection>
Specifies the name of the cluster resource to remove.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
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.ClusterResource
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 and then deletes the cluster named Cluster Disk 4 from the local cluster.
PS C:\> Remove-ClusterResource –Name "Cluster Disk 4"
EXAMPLE 2
This example deletes the cluster named Cluster Disk 5 from the local cluster without prompting for confirmation.
PS C:\> Remove-ClusterResource –Name "Cluster Disk 5" -Force