Data ONTAP® PowerShell Toolkit

Cmdlet: Invoke-NaSnapmirrorInitialize


NAME
Invoke-NaSnapmirrorInitialize

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

SYNTAX
Invoke-NaSnapmirrorInitialize [-Destination] <String> [[-Source] <String>] [
-MaxTransferRate <Int32>] [-SourceSnapshot <String>] [-DestinationSnapshot <
String>] [-Controller <NaController>] [-WarningAction <ActionPreference>] [-
WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Starts an initial transfer over the network for a specific destination. The
API must be issued to the destination filer.


PARAMETERS
-Destination <String>
The destination location of the initial transfer. The destination locat
ion is of the volume form: <filer>:<volume> or the qtree form: <filer>:/
vol/<volume>/<qtree>. The <filer> must match the destination filer. If t
he destination-location is in the volume form, the volume must be in the
restricted state. If the destination-location is the qtree form, the q
tree 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 initial transfer. The source location is of
the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volum
e>/<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-initialize

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

C:\PS>Invoke-NaSnapmirrorInitialize benson:dunn_vol2_mirror dunn:vol2


Set up a Snapmirror relationship with source controller 'dunn' volume 'vol2'
and destination controller 'benson' volume 'dunn_vol2_mirror'.


BaseSnapshot :
Contents : -
CurrentTransferError :
CurrentTransferType : initialize
DestinationLocation : benson:dunn_vol2_mirror
LagTime : 0
LastTransferDuration : 0
LastTransferFrom : -
LastTransferSize : 0
LastTransferType :
MirrorTimestamp : 0
SourceLocation : dunn:vol2
State : uninitialized
Status : transferring
TransferProgress : 520192



RELATED LINKS
Get-NaSnapmirror







 Data ONTAP® PowerShell Toolkit