Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Update-NcSnapmirror


NAME
Update-NcSnapmirror

SYNOPSIS
Changes one or more parameters of one or more SnapMirror relationships.

SYNTAX
Update-NcSnapmirror -Query <SnapmirrorInfo> [-Schedule <String>] [-Tries <In
t32>] [-MaxTransferRate <Int64>] [-ContinueOnFailure] [-MaxFailureCount <Int
32>] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>
]


DESCRIPTION
Changes one or more parameters of one or more SnapMirror relationships.


PARAMETERS
-Query <SnapmirrorInfo>
A SnapmirrorInfo object with various fields set to indicate which SnapMi
rror relationships to modify. Other fields should remain set to null.
Use "Get-NcSnapmirror -Template" to get the initially empty SnapmirrorIn
fo object.

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

-Schedule <String>
Name of the schedule on which the relationship operates.

Required? false
Position? named
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. Note: You can set the tries o
ption to zero (0) to disable manual and scheduled updates for the SnapMi
rror relationship.

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

-MaxTransferRate <Int64>
Specifies the upper bound, in bytes per second, at which data is transfe
rred between clusters. The default is unlimited (0) which permits the S
napMirror relationship to fully utilize the available network bandwidth.
This option does not affect load-sharing mirrors and other SnapMirror
relationships confined to a single cluster.

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

-ContinueOnFailure
This input element is useful when multiple objects match a given query.
If set to true, the API will continue modifying the next matching objec
t even when modification of a previous object fails. If set to false, t
he API will return on the first failure. Default: false.

Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false

-MaxFailureCount <Int32>
When allowing failures, then this input element may be provided to limit
the number of failed modify operations before the server gives up and r
eturns. If set, the cmdlet will continue modifying the next matching ob
ject even when the modification of a previous matching object fails, and
do so until the total number of objects failed to be modified reaches t
he maximum specified. If set to the maximum or not provided, then there
will be no limit on the number of failed modify operations. Only appli
cable if ContinueOnFailure is specified. Default: 2^32-1

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NcController[]>
A Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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

<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.PowerShell.SDK.Cmdlets.TableModifyResult


NOTES


Category: snapmirror
API: snapmirror-modify-iter
Family: cluster

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

C:\PS>$query = Get-NcSnapmirror -Template
$query.DestinationLocation = "VxeRubble://*"
Update-NcSnapmirror -Query $query -Schedule 8hour -MaxTransferRate 1mb


Update all SnapMirror relationships with destinations on cluster 'VxeRubble'
.


NcController : VxeRubble
SuccessCount : 3
FailureCount : 0
SuccessList : {VxeRubble://costea01/unitTestLuns --> VxeRubble://costea02/u
nitTestLunsSM, VxeRubble://costea01/vol1 --> VxeRubble://costea01/vol1_LS1,
VxeRubble://costea01/vol1 --> VxeRubble://costea01/vol1_LS2}
FailureList : {}



RELATED LINKS
Get-NcSnapmirror
Set-NcSnapmirror







 Data ONTAP® PowerShell Toolkit