Remove-StorageGroupSnapshot
SYNOPSIS
Removes a storage group snapshot.
SYNTAX
Remove-StorageGroupSnapshot [-Unisphere] <UnisphereServer> [-ArrayId] <String> [-StorageGroupId] <String>
[-SnapshotId] <String> [-SnapId] <Int64> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Removes a storage group snapshot or terminates a restored snapshot session.
If the snapshot is restored, this cmdlet will terminate the restored session. If the snapshot is not restored (does not contain a restored session), then the snapshot itself will be removed. In the case of a restored session, users will need to invoke this command twice with the same parameters if they desire to remove the snapshot.
EXAMPLES
Example 1
PS C:\> Remove-StorageGroupSnapshot -Unisphere $unisphere -ArrayId 000123456789 -StorageGroupId sg1 -SnapshotId sg1snap -SnapId 41212187393
Where $unisphere is a Unisphere server instance. Removes the snapshot sg1snap with snap ID 41212187393.
PARAMETERS
-Unisphere
The Unisphere server object.
Type: UnisphereServer
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ArrayId
The PowerMax array ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-StorageGroupId
The storage group ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-SnapshotId
The snapshot ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-SnapId
The snap ID.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
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
Skips confirmation before removing the snapshot.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns the snapshot instance that was 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.