|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcSnapshot
NAME
Remove-NcSnapshot
SYNOPSIS
Delete a snapshot on a specified volume.
SYNTAX
Remove-NcSnapshot [-Volume] <String> [-Snapshot] <String> [-Uuid <String>] [
-IgnoreOwners] [-VserverContext <String>] [-Controller <NcController[]>] [<C
ommonParameters>]
Remove-NcSnapshot [-Volume] <String> [-Snapshot] <String> [-Uuid <String>] [
-IgnoreOwners] -InfiniteVolume [-VserverContext <String>] [-Controller <NcCo
ntroller[]>] [<CommonParameters>]
DESCRIPTION
Delete a snapshot on a specified volume.
When run with the InfiniteVolume switch, the cmdlet runs asynchronously. A
job is returned. The status of the job can be tracked using the Job cmdlets
.
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
-Snapshot <String>
Name of snapshot to be deleted on the specified volume.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Uuid <String>
The 128 bit unique snapshot identifier expressed in the form of UUID. T
his field is optional and can appear together with 'snapshot' to uniquel
y identify a snapshot for deletion. An example of an actual UUID is: 73
a010ec-3d28-11df-84e8-123478563412
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IgnoreOwners
If specified, snapshot will be deleted even if some other processes are
accessing it.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-InfiniteVolume
Specify the InfiniteVolume parameter to indicate the volume is an Infini
te Volume.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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
Family: vserver
-------------- Example 1 --------------
C:\PS>Remove-NcSnapshot vol2 snap1
Remove snapshot 'snap1' from volume 'vol2'.
-------------- Example 2 --------------
C:\PS>Get-NcSnapshot vol2 snap* | Remove-NcSnapshot
Remove all snapshots with names starting with 'snap' from volume 'vol2'.
RELATED LINKS
New-NcSnapshot
Get-NcSnapshot
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|