Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcSnapmirrorPolicyRule


NAME
Set-NcSnapmirrorPolicyRule

SYNOPSIS
Modify the specified SnapMirror Policy rule.

SYNTAX
Set-NcSnapmirrorPolicyRule [-Name] <String> [-SnapmirrorLabel] <String> [-Re
tentionCount <String>] [-Preserve [<Boolean>]] [-WarnThreshold <Int32>] [-Vs
erverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Modify the specified SnapMirror Policy rule.


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

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

-SnapmirrorLabel <String>
Specifies the Snapshot copy label.

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

-RetentionCount <String>
Specifies the Snapshot copy retention count.

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

-Preserve [<Boolean>]
Specifies whether Snapshot copy preserve is enabled.

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

-WarnThreshold <Int32>
Specifies the warning threshold count.

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-rule
Family: vserver

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

C:\PS>Set-NcSnapmirrorPolicyRule -Name sn_policy -SnapmirrorLabel weekly -Re
tentionCount 10 -Preserve $true


Modify the snapmirror policy rule for snapmirror label 'weekly'.


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



RELATED LINKS
Get-NcSnapmirrorPolicy
Add-NcSnapmirrorPolicyRule
Remove-NcSnapmirrorPolicyRule







 Data ONTAP® PowerShell Toolkit