Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Add-NaSnapvaultSoftlock


NAME
Add-NaSnapvaultSoftlock

SYNOPSIS
Request the system to add softlock for the specified snapshot.

SYNTAX
Add-NaSnapvaultSoftlock [-Volume] <String> [-Snapshot] <String> [[-SoftlockN
ame] <String>] [-Controller <NaController>] [-WhatIf] [-Confirm] [<CommonPar
ameters>]


DESCRIPTION
Request the system to add softlock for the specified snapshot. Softlocks can
be added to preserve the snapshots which the user wants to retain down the
cascade.


PARAMETERS
-Volume <String>
Name of the volume where the snapshot exists.

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

-Snapshot <String>
Name of the snapshot to be softlocked.

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

-SoftlockName <String>
Name of softlock which uniquely identifies the softlock for the snapshot
. When not specified, softlock will be added with default name. Name o
f softlock can contain letters, numbers, and underscore character (_), a
nd can be up to 64 characters long.

Required? false
Position? 3
Default value
Accept pipeline input? true (ByValue, 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

-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
NetApp.Ontapi.Filer.Snapvault73.SnapvaultSoftlockInfo


NOTES


Category: snapvault
API: snapvault-add-softlock

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

C:\PS>Add-NaSnapvaultSoftlock vol0 vol0_sv_sched.1 lock1


Lock snapshot 'vol0_sv_sched.1' in volume 'vol0'.


SoftlockName Type
------------ ----
lock1 api



RELATED LINKS
Remove-NaSnapvaultSoftlock
Get-NaSnapvaultSoftlock







 Data ONTAP® PowerShell Toolkit