Remove-VolumeGroupSnapshot
SYNOPSIS
Removes snapshots of a volume group.
SYNTAX
ByNameVolumeGroupName (Default)
Remove-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String[]> -VolumeGroupName <String> [-Confirm] [-Force] [-PassThru]
[-WhatIf] [<CommonParameters>]
ByNameVolumeGroupId
Remove-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String[]> -VolumeGroupId <String> [-Confirm] [-Force] [-PassThru]
[-WhatIf] [<CommonParameters>]
ById
Remove-VolumeGroupSnapshot [-Cluster] <Cluster> -Id <String[]> [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
Removes one or more snapshots of a volume group.
EXAMPLES
Example 1
PS C:\> Remove-VolumeGroupSnapshot -Cluster $cluster -Name snap1 -VolumeGroupName vg1
Where $cluster is a PowerStore cluster instance. Removes the snapshot snap1 of volume group vg1.
Example 2
PS C:\> Remove-VolumeGroupSnapshot -Cluster $cluster -Name snap1,snap2,snap3 -VolumeGroupName vg1
Where $cluster is a PowerStore cluster instance. Removes the snapshots snap1,snap2 and snap3 of volume group vg1.
Example 3
PS C:\> Remove-VolumeGroupSnapshot -Cluster $cluster -Name snap1 -VolumeGroupId uuid1
Where $cluster is a PowerStore cluster instance. Removes volume group snapshot snap1 of a volume group with Id uuid1.
Example 4
PS C:\> Remove-VolumeGroupSnapshot -Cluster $cluster -Id uuid1
Where $cluster is a PowerStore cluster instance. Removes a volume group snapshot with Id uuid1.
PARAMETERS
-Cluster
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: ByNameVolumeGroupName, ByNameVolumeGroupId
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
-VolumeGroupName
Volume group name.
Type: String
Parameter Sets: ByNameVolumeGroupName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeGroupId
Volume group Id.
Type: String
Parameter Sets: ByNameVolumeGroupId
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: False
Accept pipeline input: False
Accept wildcard characters: False
-Force
Suppress confirmation prompt before removing the volume group.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns the volume group instances that were removed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
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.