|
|
Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NcSnapshotPolicySchedule
NAME
Set-NcSnapshotPolicySchedule
SYNOPSIS
Modify a snapshot policy.
SYNTAX
Set-NcSnapshotPolicySchedule [-Name] <String> [-Schedule] <String> [-Count]
<Int32> [-SnapmirrorLabel <String>] [-Controller <NcController[]>] [<CommonP
arameters>]
DESCRIPTION
Modify a snapshot policy.
PARAMETERS
-Name <String>
The snapshot scheduling policy to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Schedule <String>
The name of a schedule to be modified. Maximum length of this field can
be 255 characters. The schedule name may be any one of the reserved sc
hedules like 'hourly', 'weekly' or 'daily' or it may be a user created s
chedule.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Count <Int32>
The new retention count for the schedule.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapmirrorLabel <String>
The new SnapMirror Label for the schedule. This label will be used to de
fine vaulting policies at a vault destination. If an empty label is spec
ified, the existing label will be deleted. The maximum length of this fi
eld is 31 characters.
Required? false
Position? named
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.SnapshotPolicyInfo
NOTES
Category: snapshot
API: snapshot-policy-modify-schedule
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>Set-NcSnapshotPolicySchedule weeklyBackup weekly 52
Set the snapshot schedule policy 'weeklyBackup' to retain 52 weekly snapshot
s.
Policy Enabled SnapshotPolicySchedules
------ ------- -----------------------
weeklyBackup False {weekly (52)}
RELATED LINKS
Get-NcSnapshotPolicy
Add-NcSnapshotPolicySchedule
Remove-NcSnapshotPolicySchedule
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|