|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NaSnapvaultSecSnapshotSchedule
NAME
Set-NaSnapvaultSecSnapshotSchedule
SYNOPSIS
Request the secondary system to configure the specified snapshot schedule.
SYNTAX
Set-NaSnapvaultSecSnapshotSchedule [-VolumeName] <String> [-ScheduleName] <S
tring> [-AutoUpdate] [<Boolean>] [-RetentionCount] <Int32> [-PreserveSnapsho
ts <String>] [-WarnAtCount <Int32>] [-MaxTries <Int32>] [-RetentionPeriod <S
tring>] [-DaysOfWeek <String>] [-HoursOfDay <String>] [-Controller <NaContro
ller>] [<CommonParameters>]
DESCRIPTION
Request the secondary system to configure the specified snapshot schedule.
If this request is made for an existing snapshot schedule, then that snapsho
t schedule is updated with any new values specified. If the optional input
schedule is skipped, the days-of-week is set to "mon-sun" and hours-of-day s
et to 0, i.e. midnight.
PARAMETERS
-VolumeName <String>
The secondary volume for which this schedule is being configured.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ScheduleName <String>
Uniquely identifies the schedule within a secondary volume. The schedul
e name is used as a prefix in the name of each snapshot created by this
schedule.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AutoUpdate [<Boolean>]
Schedules that have is-auto-update set to 'true' will initiate update tr
ansfers for all relationships in that volume before creating a new snaps
hot.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-RetentionCount <Int32>
Denotes the maximum number of most recent snapshots that will be retaine
d by this schedule. Range:[0..254]
Required? true
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PreserveSnapshots <String>
Allowed values are on/off/default. It prevents SnapVault from auto-dele
ting older snapshots from this SnapVault snapshot schedule to create new
snapshots when set to on. When unspecified, value is set to default.
When set to default, the behaviour of preserving snapshots is guided by
the global snapvault.preservesnap option. This setting is honored only
for the secondary schedules. It is ignored for the SnapVault primary sc
hedules.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-WarnAtCount <Int32>
On SnapVault secondary, when preserve-snapshots is set, SnapVault sends
a warning message when the number of remaining snapshots for this backup
schedule is less than this input. Setting this to zero turns off the s
ame warning. Default value is 0. Range:[0..retention-count - 1]
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-MaxTries <Int32>
Number of times SnapVault should try creating each scheduled snapshot be
fore giving up. If the snapshot creation fails due to transient errors
such as the volume being out of space, SnapVault will keep trying to cre
ate the snapshot every minute until the request is fulfilled. The allow
ed range is from 0 to 120. The default value is unlimited. If MaxTries
is not used, then the value will remain unchanged and the already confi
gured value will be used. The default value for this option is -1. Ran
ge:[-1..120]
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-RetentionPeriod <String>
Available only on the secondary. This option is used to specify a reten
tion period for snapshots which are created by this schedule for SnapLoc
k volumes. The retention period is specified as a count followed by a s
uffix. The valid suffixes are d (for days), m (for months), and y (fo
r years). For example a value of 6m represents a retention period of 6
months. The maximum valid retention period is 30 years, or the maximum
retention period set for the volume, whichever is shorter. The minimum
valid retention period is 0 days, or the minimum retention period set fo
r the volume, whichever is longer. If the option value is default or th
e retention-period option is not specified, the snapshots will be create
d with retention period equal to the default retention period of the sec
ondary SnapLock volume, or 30 years, whichever is shorter.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DaysOfWeek <String>
Days of the week for which this schedule has been set. This is a comma s
eparated list of days, where a day is specified by the first three lette
rs of the day. Day ranges are also allowed.
Here are the possible formats:
- := matches no day of the week
mon := matches Monday
tue,thu := matches Tuesday and Thursday
mon-fri := matches mon,tue,wed,thu,fri
Default value is mon-sun, i.e. every day.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-HoursOfDay <String>
Hours of the day for which this schedule has been set. This is a comma
separated list of the hours during the day where hours are specified as
integers from 0 to 23. Hour ranges are also allowed. Step values are a
llowed in conjunction with ranges.
Here are the possible formats:
4 := matches 4 am.
0,13 := matches midnight and 1pm.
0-23 := matches all hours
0-8/2 := matches 'every 2 hours' starting from midnight until 8am.
Default value is 0, i.e. midnight.
Required? false
Position? named
Default value
Accept pipeline input? true (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
<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: snapvault
API: snapvault-secondary-set-snapshot-schedule
-------------- Example 1 --------------
C:\PS>Set-NaSnapvaultSecSnapshotSchedule vol0 vol0_sv_sched -AutoUpdate $tru
e -RetentionCount 25 -DaysOfWeek "Mon-Fri" -HoursOfDay "0,12" -PreserveSnaps
hots on -WarnAtCount 20 -MaxTries 5
Set a SnapVault secondary schedule for volume 'vol0'.
RELATED LINKS
Get-NaSnapvaultSecSnapshotSchedule
Get-NaSnapvaultSecSnapshotScheduleStatus
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|