Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcSnapmirrorPolicy


NAME
Set-NcSnapmirrorPolicy

SYNOPSIS
Modify the specified SnapMirror Policy.

SYNTAX
Set-NcSnapmirrorPolicy [-Name] <String> [-Tries <Int32>] [-UnlimitedTries] [
-TransferPriority <String>] [-Restart <String>] [-IgnoreAccessTime [<Boolean
>]] [-Comment <String>] [-VserverContext <String>] [-Controller <NcControlle
r[]>] [<CommonParameters>]


DESCRIPTION
Modify the specified SnapMirror Policy.


PARAMETERS
-Name <String>
The name of the SnapMirror policy.

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

-Tries <Int32>
Specifies the maximum number of times to attempt each manual or schedule
d transfer for a SnapMirror relationship. The default is '8'. This valu
e is ignored if the UnlimitedTries switch is set.

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

-UnlimitedTries
If specified, specify an unlimited number of tries.

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

-TransferPriority <String>
Specifies the priority at which a SnapMirror transfer runs.

Possible values:
'normal' : By default every transfer in the system has this priority. Th
ese transfers are scheduled before most 'low' priority transfers.
'low' : These transfers have least priority and usually are scheduled
after most 'normal' priority transfers.

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

-Restart <String>
Defines the behavior of SnapMirror if an interrupted transfer exists. Ap
plies to SnapMirror data protection relationship only. Possible values:
"always", "never", "default"

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

-IgnoreAccessTime [<Boolean>]
If true, incremental transfers will ignore files which have only their a
ccess time changed. Applies to SnapMirror vault relationships only.

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

-Comment <String>
A human readable description associated with the SnapMirror policy.

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

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

Required? false
Position? named
Default value
Accept pipeline input? false
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.SnapmirrorPolicy.SnapmirrorPolicyInfo


NOTES


Category: snapmirror policy
API: snapmirror-policy-modify
Family: vserver

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

C:\PS>Set-NcSnapmirrorPolicy -Name sn_policy -TransferPriority normal -Resta
rt always


Modify the snapmirror policy sn_policy.


Name TotalRules TotalKeep Tries TransferPriority Resta
rt Vserver
---- ---------- --------- ----- ---------------- -----
-- -------
sn_policy 1 4 5 normal alway
s beam01



RELATED LINKS
Get-NcSnapmirrorPolicy
New-NcSnapmirrorPolicy
Remove-NcSnapmirrorPolicy







 Data ONTAP® PowerShell Toolkit