Remove-Volume
SYNOPSIS
Removes a PowerStore volume.
SYNTAX
ByName (Default)
Remove-Volume [-Cluster] <Cluster> [-Name] <String[]> [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
ById
Remove-Volume [-Cluster] <Cluster> -Id <String[]> [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
Removes a PowerStore volume and all of its snapshots. The following restrictions apply:
- A volume which is attached to a host or host group or is a member of a volume group cannot be deleted.
- A volume which has protection policies attached to it cannot be deleted.
- A volume which has snapshots that are part of a snapset cannot be deleted.
- Clones of a deleted production volume or a clone are not deleted.
- Snapshots of the volume are deleted along with the volume being deleted.
EXAMPLES
Example 1
PS C:\> Remove-Volume -cluster $cluster -Name volume01,volume02,volume03
Where $cluster is a PowerStore cluster instance. Removes the volumes volume01, volume02, volume03, and any of their snapshots if present.
Example 2
PS C:\> Remove-Volume -cluster $cluster -Id f83398fc-c869-485f-8f75-7221f639b746,741912de-85ac-4a87-8393-a81b2159722b
Where $cluster is a PowerStore cluster instance. Removes the volumes with Ids f83398fc-c869-485f-8f75-7221f639b746, 741912de-85ac-4a87-8393-a81b2159722b, and any of their snapshots if present.
PARAMETERS
-Cluster
A PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Volume name.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Id
Unique identifier of volume.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
Suppress confirmation prompt before removing volume.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Return the volume instances that were removed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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: None
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.