|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NcSnapmirrorInitialize
NAME
Invoke-NcSnapmirrorInitialize
SYNOPSIS
Performs the initial update of a SnapMirror relationship.
SYNTAX
Invoke-NcSnapmirrorInitialize [-DestinationCluster <String>] -DestinationVse
rver <String> -DestinationVolume <String> [-SourceCluster <String>] [-Source
Vserver <String>] [-SourceVolume <String>] [-MaxTransferRate <Int64>] [-Pass
thru] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters
>]
Invoke-NcSnapmirrorInitialize [-Destination] <String> [[-Source] <String>] [
-MaxTransferRate <Int64>] [-Passthru] [-Controller <NcController[]>] [-WhatI
f] [-Confirm] [<CommonParameters>]
DESCRIPTION
Performs the initial update of a SnapMirror relationship. This API is usual
ly used after New-NcSnapmirror, but it can be used alone, that is, without N
ew-NcSnapmirror, to create and initially update a SnapMirror relationship.
A job will be spawned to operate on the SnapMirror relationship, and the job
id will be returned. The progress of the job can be tracked using the job c
mdlets.
You must specify the destination endpoint.
The cmdlet must be used from the destination cluster.
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
-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
-Passthru
Specify to output the SnapMirror object rather than the job ID.
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
-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
DataONTAP.C.PowerShell.SDK.Cmdlets.JobStartResult
NOTES
Category: snapmirror
API: snapmirror-initialize
Family: cluster
-------------- Example 1 --------------
C:\PS>Invoke-NcSnapmirrorInitialize //costea02/unitTestLunsSM | Get-NcJob
Start an initialize operation on the SnapMirror with destination '//costea02
/unitTestLunsSM' and display the job.
JobId JobName JobPriority JobState JobVserver JobCompletion
----- ------- ----------- -------- ---------- -------------
1633 SnapMirror initialize exclusive running VxeRubble
RELATED LINKS
Get-NcSnapmirror
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|