|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NcSnapmirrorAbort
NAME
Invoke-NcSnapmirrorAbort
SYNOPSIS
Stops ongoing transfers for a SnapMirror relationship.
SYNTAX
Invoke-NcSnapmirrorAbort [-DestinationCluster <String>] -DestinationVserver
<String> -DestinationVolume <String> [-SourceCluster <String>] [-SourceVserv
er <String>] [-SourceVolume <String>] [-ClearCheckpoint] [-CheckOnly] [-Pass
thru] [-InfiniteVolume] [-Controller <NcController[]>] [<CommonParameters>]
Invoke-NcSnapmirrorAbort [-Destination] <String> [[-Source] <String>] [-Clea
rCheckpoint] [-CheckOnly] [-Passthru] [-InfiniteVolume] [-Controller <NcCont
roller[]>] [<CommonParameters>]
DESCRIPTION
Stops ongoing transfers for a SnapMirror relationship. The relationship is
identified by its destination endpoint. You must specify the destination en
dpoint.
The cmdlet stops all of the active transfers to each associated volume on th
e receiving side in a set of load-sharing mirrors. Load-sharing mirrors are
either up to date and serving data to clients, or they are lagging and not
serving data to clients. If the cmdlet identifies an up-to-date load-sharin
g mirror, then SnapMirror transfers to associated up-to-date load-sharing mi
rrors in the set of load-sharing mirrors are also aborted. If the cmdlet id
entifies a lagging load-sharing mirror, then only the SnapMirror transfer as
sociated with the lagging load-sharing mirror is aborted. After the cmdlet s
uccessfully completes its operation, the volume on the receiving side of the
transfer might contain a restart checkpoint. The restart checkpoint can be
used by a subsequent transfer to restart and continue the aborted SnapMirror
transfer.
The cmdlet must be used from the destination cluster.
When run with the InfiniteVolume switch, the cmdlet runs asynchronously. A
job is returned. The status of the job can be tracked using the Job cmdlets
.
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
-ClearCheckpoint
If specified, the restart checkpoint is cleared.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CheckOnly
If specified, only snapmirror check operations active on the relationshi
p will be aborted.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Passthru
Specify to output the SnapMirror object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InfiniteVolume
Specify the InfiniteVolume parameter to indicate the SnapMirror relation
ship is between Infinite Volumes.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
NOTES
Category: snapmirror
API: snapmirror-abort, snapmirror-abort-async
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Invoke-NcSnapmirrorAbort VxeRubble://costea02/unitTestLunsSM
Abort any SnapMirror transfers to destination 'VxeRubble://costea02/unitTest
LunsSM'.
RELATED LINKS
Get-NcSnapmirror
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|