|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NaSnapshot
NAME
Remove-NaSnapshot
SYNOPSIS
Delete a snapshot on a specified volume or aggregate.
SYNTAX
Remove-NaSnapshot [-TargetName] <String> [-SnapName] <String> [-TargetType <
String>] [-Controller <NaController>] [<CommonParameters>]
DESCRIPTION
Delete a snapshot on a specified volume or aggregate.
EBUSY is returned when the snapshot is in use.
EROFS is returned when the volume is read-only.
EAGAIN is returned when splitting a blockmap or reverting.
PARAMETERS
-TargetName <String>
Name of the volume or aggregate on which the snapshot is to be deleted.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SnapName <String>
Name of snapshot to be deleted.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-TargetType <String>
Specify the type of snapshot target, either "volume" or "aggregate".
Required? false
Position? named
Default value volume
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".
INPUTS
OUTPUTS
NOTES
Category: snapshot
API: snapshot-delete, system-cli
Privilege: security-priv-admin, cli-snap-delete
-------------- Example 1 --------------
C:\PS>Remove-NaSnapshot vol2 vol2snap
Delete snapshot 'vol2snap' from volume 'vol2'.
-------------- Example 2 --------------
C:\PS>Get-NaSnapshot vol2 snap* | Remove-NaSnapshot
Remove all snapshots from volume 'vol2' with names like 'snap*'.
RELATED LINKS
New-NaSnapshot
Get-NaSnapshot
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|