Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcSnapmirror


NAME
Set-NcSnapmirror

SYNOPSIS
Changes one or more parameters of a SnapMirror relationship.

SYNTAX
Set-NcSnapmirror [-DestinationCluster <String>] -DestinationVserver <String>
-DestinationVolume <String> [-SourceCluster <String>] [-SourceVserver <Stri
ng>] [-SourceVolume <String>] [-Schedule <String>] [-Tries <Int32>] [-MaxTra
nsferRate <Int64>] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<Com
monParameters>]

Set-NcSnapmirror [-Destination] <String> [[-Source] <String>] [-Schedule <St
ring>] [-Tries <Int32>] [-MaxTransferRate <Int64>] [-Controller <NcControlle
r[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Changes one or more parameters of a SnapMirror relationship. For load-shari
ng mirrors, a change to a parameter affects all of the SnapMirror relationsh
ips in the set of load-sharing mirrors. Destination volumes in a set of loa
d-sharing mirrors do not have individual parameter settings. Changes made b
y the cmdlet do not take effect until the next manual or scheduled update of
the SnapMirror relationship. Changes do not affect updates that have start
ed and have not finished yet.

The cmdlet must be used from the destination cluster.

The key parameter that identifies any SnapMirror relationship is the destina
tion volume. You must specify the destination endpoint when using Set-NcSna
pmirror.


PARAMETERS
-DestinationCluster <String>
Specifies the destination cluster of the SnapMirror relationship. The d
estination vserver and destination volume must also be specified if usin
g this parameter.

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

-DestinationVserver <String>
Specifies the destination vserver of the SnapMirror relationship. The d
estination cluster and destination volume must also be specified if usin
g this parameter.

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

-DestinationVolume <String>
Specifies the destination volume of the SnapMirror relationship. The de
stination cluster and destination vserver must also be specified if usin
g this parameter.

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

-SourceCluster <String>
Specifies the source cluster of the SnapMirror relationship. The source
vserver and source volume must also be specified if using this paramete
r.

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

-SourceVserver <String>
Specifies the source vserver of the SnapMirror relationship. The source
cluster and source volume must also be specified if using this paramete
r.

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

-SourceVolume <String>
Specifies the source volume of the SnapMirror relationship. The source
cluster and source vserver must also be specified if using this paramete
r.

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

-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

-Destination <String>
Specifies the destination endpoint of the SnapMirror relationship in the
format: [cluster:]//vserver/volume. This format may change in the futu
re. When specifying a destination endpoint, you must use either the des
tination location, or the destination cluster, destination vserver, and
destination volume.

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

-Source <String>
Specifies the source endpoint of the SnapMirror relationship in the form
at: [cluster:]//vserver/volume. This format may change in the future.
When specifying a source endpoint, you must use either the source locati
on, or the source cluster, source vserver, and source volume.

Required? false
Position? 2
Default value
Accept pipeline input? true (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
NetApp.Ontapi.Filer.C.Snapmirror810.SnapmirrorInfo


NOTES


Category: snapmirror
API: snapmirror-modify
Family: cluster

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

C:\PS>Get-NcSnapmirror -DestinationVserver costea02 | Set-NcSnapmirror -Sche
dule 8hour


Set the schedule for all SnapMirror relationships with their destination on
vserver 'costea02'.


SourceLocation DestinationLocation Status
MirrorState
-------------- ------------------- ------
-----------
VxeRubble://costea01/unitTestLuns VxeRubble://costea02/unitTestLunsSM idle
snapmirrored



RELATED LINKS
New-NcSnapmirror
Get-NcSnapmirror
Remove-NcSnapmirror







 Data ONTAP® PowerShell Toolkit