Data ONTAP® PowerShell Toolkit

Cmdlet: Remove-NaSnapshot


NAME
Remove-NaSnapshot

SYNOPSIS
Delete a snapshot on a specified volume.

SYNTAX
Remove-NaSnapshot [-Volume] <String> [-SnapName] <String> [-Controller <NaCo
ntroller>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [
-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Delete a snapshot on a specified volume.

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
-Volume <String>
Name of the volume 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 on the specified volume.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Controller <NaController>
The DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningAction <ActionPreference>


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningVariable <String>


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


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

-------------- Example 1 --------------

C:\PS>Remove-NaSnapshot vol2 vol2snap


Delete snapshot 'vol2snap' from volume 'vol2'.






RELATED LINKS
New-NaSnapshot
Get-NaSnapshot







 Data ONTAP® PowerShell Toolkit