|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NcSnapmirrorBreak
NAME
Invoke-NcSnapmirrorBreak
SYNOPSIS
Breaks a SnapMirror relationship between a source and destination volume of
a data protection mirror.
SYNTAX
Invoke-NcSnapmirrorBreak [-DestinationCluster <String>] -DestinationVserver
<String> -DestinationVolume <String> [-SourceCluster <String>] [-SourceVserv
er <String>] [-SourceVolume <String>] [-Passthru] [-InfiniteVolume] [-Contro
ller <NcController[]>] [<CommonParameters>]
Invoke-NcSnapmirrorBreak [-Destination] <String> [[-Source] <String>] [-Pass
thru] [-InfiniteVolume] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Breaks a SnapMirror relationship between a source and destination volume of
a data protection mirror. When Data ONTAP breaks the relationship, the dest
ination volume is made a read-write volume and can diverge from the source v
olume, client redirection is turned off on the destination volume, the resta
rt checkpoint is cleared, and the clients can see the latest Snapshot copy.
The cmdlet applies only to data protection mirrors and not to load-sharing m
irrors.
The cmdlet must be issued on 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
-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-break, snapmirror-break-async
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Invoke-NcSnapmirrorBreak VxeRubble://costea02/unitTestLunsSM
Break the SnapMirror with destination 'VxeRubble://costea02/unitTestLunsSM'.
RELATED LINKS
Get-NcSnapmirror
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|