Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcSnapshot


NAME
Set-NcSnapshot

SYNOPSIS
Modify the attributes of a snapshot.

SYNTAX
Set-NcSnapshot [-Snapshot] <String> [-Volume] <String> [-Vserver] <String> [
-SnapmirrorLabel] <String> [-Controller <NcController[]>] [<CommonParameters
>]


DESCRIPTION
Modify the attributes of a snapshot.


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

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

-Volume <String>
Volume name.

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

-Vserver <String>
Name of the vserver to which this volume belongs.

Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-SnapmirrorLabel <String>
A human readable SnapMirror Label attached with the snapshot.

Required? true
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
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

<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
DataONTAP.C.Types.Snapshot.SnapshotInfo


NOTES


Category: snapshot
API: snapshot-modify-iter
Family: cluster,vserver

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

C:\PS>set-ncsnapshot -Vserver beam01 -Volume luns -Snapshot backup.0 -Snapmi
rrorLabel monthly


Set the snapmirror label for the snapshot.


Name Volume Vserver Cre
ated Total Cumulative Dependency
---- ------ ------- ---
---- ----- ---------- ----------
backup.0 luns beam01 2/20/
2013 56.0 KB 56.0 KB



RELATED LINKS
Get-NcSnapshot
Update-NcSnapshot







 Data ONTAP® PowerShell Toolkit