|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NaSnapvaultPriSnapshotSchedule
NAME
Set-NaSnapvaultPriSnapshotSchedule
SYNOPSIS
Request the primary system to configure the specified snapshot schedule.
SYNTAX
Set-NaSnapvaultPriSnapshotSchedule [-VolumeName] <String> [-ScheduleName] <S
tring> [-RetentionCount] <Int32> [-MaxTries <Int32>] [-DaysOfWeek <String>]
[-HoursOfDay <String>] [-Controller <NaController>] [<CommonParameters>]
DESCRIPTION
Request the primary system to configure the specified snapshot schedule. It
can also update existing snapshot schedules. If the optional input schedul
e is skipped, the days-of-week is set to "mon-sun" and hours-of-day set to 0
, i.e. midnight.
PARAMETERS
-VolumeName <String>
The primary 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 this schedule within a primary volume. The schedule
name will be used as a prefix in the name of each snapshot created by t
his schedule.
Required? true
Position? 2
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? 3
Default value
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 -1
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-primary-set-snapshot-schedule
-------------- Example 1 --------------
C:\PS>Set-NaSnapvaultPriSnapshotSchedule vol0 vol0_sv_sched 5 -DaysOfWeek "M
on-Fri" -HoursOfDay "0,12"
Set a SnapVault primary schedule for volume 'vol0'.
RELATED LINKS
Get-NaSnapvaultPriSnapshotSchedule
Get-NaSnapvaultPriSnapshotScheduleStatus
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|