Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Set-NaSnapmirrorSchedule


NAME
Set-NaSnapmirrorSchedule

SYNOPSIS
Sets the schedule for a given destination.

SYNTAX
Set-NaSnapmirrorSchedule [-Destination] <String> [-Source] <String> [-Minute
s] <String> [-Hours] <String> [-DaysOfMonth] <String> [-DaysOfWeek] <String>
[-MaxTransferRate <Int64>] [-Restart <String>] [-Controller <NaController>]
[-WhatIf] [-Confirm] [<CommonParameters>]

Set-NaSnapmirrorSchedule [-Destination] <String> [-Source] <String> [-Contro
ller <NaController>] -Schedule <SnapmirrorScheduleInfo> [-WhatIf] [-Confirm]
[<CommonParameters>]


DESCRIPTION
Sets the schedule for a given destination. The API must be executed on the
destination filer. Currently, the schedule is in /etc/snapmirror.conf.


PARAMETERS
-Destination <String>
The destination location of a schedule to set. The destination location
is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol
/<volume>/<qtree>.

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

-Source <String>
The source location of a schedule to set. The source location is of the
volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/
<qtree>.

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

-Minutes <String>
Minutes in the hour for which the schedule is set. The form is crontab-l
ike, with possible values of:
- := match nothing;
1 := match minute 1;
1,3 := match minute 1 and 3;
2-5 := match minute 2,3,4,5;
1-12/3 := match minute 1,4,7,10;
0-55/5 := match minute 0,5,10,15,20,25,30,35,40,45,50,55;
* := matches all possible legal values;

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

-Hours <String>
Hours in the day for which the schedule is set. The form is crontab-like
, with possible values of:
- := match nothing;
1 := match hour 1;
1,3 := match hour 1 and 3;
2-5 := match hour 2,3,4,5;
1-24/3 := match hour 1,4,7,10,13,16,19,22;
* := matches all possible legal values;

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

-DaysOfMonth <String>
Days in the week for which the schedule is set.

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

-DaysOfWeek <String>
Days in the week for which the schedule is set. 0 represents Sunday, and
6 represents Saturday. The form is crontab-like, with possible values o
f:
- := match nothing;
1 := match day 1 (Mon);
1,3 := match day 1 and 3 (Mon and Wed);
2-5 := match day 2,3,4,5 (Tue,Wed,Thu,Fri);
* := matches all possible legal values;

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

-MaxTransferRate <Int64>
Maximum transfer rate in bytes per second. The default is as fast as th
e filer can transfer.

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

-Restart <String>
Restart mode when transfer is interrupted. Possible values are "always"
, "never" and "default". If value is set to "always", then an interrup
ted transfer will always restart, if it has a restart checkpoint and the
conditions are the same as before the transfer was interrupted. If val
ue is set to "never", then an interrupted transfer will never restart,
even if it has a restart checkpoint. If the Restart parameter is not sp
ecified, then it is set to "default", whereupon snapmirror behaves like
the "always" case, unless it has passed the next scheduled transfer time
, in which case it will begin that scheduled transfer instead of restart
ing.

Required? false
Position? named
Default value default
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

-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

-Schedule <SnapmirrorScheduleInfo>
Alternate parameter set that accepts a schedule object of the type retur
ned by Get-NaSnapmirrorSchedule.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
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.Types.Snapmirror.SnapmirrorStatusInfo


NOTES


Category: snapmirror
API: snapmirror-set-schedule

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

C:\PS>Get-NaSnapmirror | Set-NaSnapmirrorSchedule -Minutes 0 -Hours 3 -DaysO
fMonth * -DaysOfWeek * -MaxTransferRate 1mb


Set all Snapmirrors to update at 0300 hours every day.


BaseSnapshot : benson(0118045471)_dunn_vol2_mirror.1
Contents : Replica
CurrentTransferError :
CurrentTransferType :
DestinationLocation : benson:dunn_vol2_mirror
LagTime : 1420
LagTimeTS : 00:23:40
LastTransferDuration : 1218
LastTransferDurationTS : 00:20:18
LastTransferFrom : dunn:vol2
LastTransferSize : 88573992960
LastTransferType : initialize
MirrorTimestamp : 1280783067
MirrorTimestampDT : 8/2/2010 9:04:27 PM
SourceLocation : dunn:vol2
State : snapmirrored
Status : idle
TransferProgress : 0



RELATED LINKS
Get-NaSnapmirrorSchedule
Remove-NaSnapmirrorSchedule
Set-NaSnapmirrorSyncSchedule







 Data ONTAP® PowerShell Toolkit