Data ONTAP® PowerShell Toolkit

Cmdlet: Invoke-NaSnapmirrorUpdate


NAME
Invoke-NaSnapmirrorUpdate

SYNOPSIS
Starts a transfer over the network for a specific destination.

SYNTAX
Invoke-NaSnapmirrorUpdate [-Destination] <String> [[-Source] <String>] [-Max
TransferRate <Int32>] [-SourceSnapshot <String>] [-DestinationSnapshot <Stri
ng>] [-Controller <NaController>] [-WarningAction <ActionPreference>] [-Warn
ingVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Starts a transfer over the network for a specific destination. The update is
asynchronously handled, and there is no guarantee that it succeeds. The sn
apmirror-get-status API can be used to check the status of the update. The
API must be issued on the destination filer.


PARAMETERS
-Destination <String>
The destination location of the update transfer. The destination locati
on is of the volume form: <filer>:<volume> or the qtree form: <filer>:/v
ol/<volume>/<qtree>. The <filer> must match the destination filer. If th
e destination-location is in the volume form, the volume must be in the
restricted state. If the destination-location is the qtree form, the qt
ree must not already exist.

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

-Source <String>
The source location of the update transfer. The source location is of t
he volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume
>/<qtree>. If the source-location is not specified, then the source in /
etc/snapmirror.conf for the destination path is used.

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

-MaxTransferRate <Int32>
Maximum transfer rate in kilobytes per second. The default is as fast a
s the filer can transfer.

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

-SourceSnapshot <String>
Designates which source snapshot to use for a qtree update. The default
creates new snapshot on the source for the transfer.

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

-DestinationSnapshot <String>
Creates the specified snapshot (in addition to the regular SnapMirror sn
apshot) on the destination after the qtree SnapMirror transfer is over.

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

-Controller <NaController>
The DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.

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

-WarningAction <ActionPreference>


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

-WarningVariable <String>


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

<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.Snapmirror.SnapmirrorStatusInfo


NOTES


Category: snapmirror
API: snapmirror-update

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

C:\PS>Get-NaSnapmirror | Invoke-NaSnapmirrorUpdate


Update all Snapmirrors.


BaseSnapshot : benson(0118045471)_dunn_vol2_mirror.2
Contents : Replica
CurrentTransferError :
CurrentTransferType : update
DestinationLocation : benson:dunn_vol2_mirror
LagTime : 597
LastTransferDuration : 13
LastTransferFrom : dunn:vol2
LastTransferSize : 1504
LastTransferType : scheduled
MirrorTimestamp : 1266347880
SourceLocation : dunn:vol2
State : snapmirrored
Status : transferring
TransferProgress : 0



RELATED LINKS
Invoke-NaSnapmirrorInitialize







 Data ONTAP® PowerShell Toolkit