Remove-ClusterSharedVolume
Remove-ClusterSharedVolume
Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster.
Syntax
Parameter Set: InputObject
Remove-ClusterSharedVolume [[-Name] <StringCollection> ] [-Cluster <String> ] [-InputObject <PSObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-ClusterSharedVolume cmdlet removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. After placing a volume in Available Storage, you can use the volume when you configure a new clustered role.
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 |
-InputObject<PSObject>
Specifies the Cluster Shared Volume 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 Shared Volume to remove.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
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.ClusterSharedVolume
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterResource
Examples
Example 1
This example removes the CSV named Cluster Disk 3 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage.
PS C:\> Remove-ClusterSharedVolume –Name "Cluster Disk 3"
Example 2
This example removes the CSV named Cluster Disk 4 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage.
PS C:\> Get-ClusterSharedVolume –Name "Cluster Disk 4" | Remove-ClusterSharedVolume