Remove-VolumeSnapshot
SYNOPSIS
Remove one or more volume snapshots.
SYNTAX
ByNameVolumeName (Default)
Remove-VolumeSnapshot [-Cluster] <Cluster> [-Name] <String[]> -VolumeName <String> [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
ByNameVolumeId
Remove-VolumeSnapshot [-Cluster] <Cluster> [-Name] <String[]> -VolumeId <String> [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
ById
Remove-VolumeSnapshot [-Cluster] <Cluster> -Id <String[]> [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
Removes volume snapshots by name or its unique Id. When specifying the snapshot by name the source volume name is required as snapshot names are not unique. If the -PassThru option is specified then the output stream will contain the snapshot objects that were removed.
EXAMPLES
Example 1
PS C:\> Remove-VolumeSnapshot -Cluster $cluster -VolumeName volume1 -Name snapshot1,snapshot2,snapshot3
Where $cluster is a PowerStore cluster instance. Remove the snapshots with names snapshot1, snapshot2, and snapshot3 of source volume volume1.
Example 2
PS C:\> Remove-VolumeSnapshot -Cluster $cluster -VolumeId uuid1 -Name snapshot1
Where $cluster is a PowerStore cluster instance. Remove the snapshot named snapshot1 of volume with unique Id uuid1.
Example 3
PS C:\> Remove-VolumeSnapshot -Cluster $cluster -Id uuid1,uuid2
Where $cluster is a PowerStore cluster instance. Remove the snapshots with unique Ids uuid1 and uuid2.
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
Snapshot name.
Type: String[]
Parameter Sets: ByNameVolumeName, ByNameVolumeId
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Id
Snapshot Id.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-VolumeName
Source volume name.
Type: String
Parameter Sets: ByNameVolumeName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeId
Source volume Id.
Type: String
Parameter Sets: ByNameVolumeId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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 snapshot.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Return instances of removed snapshots.
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.