|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcSnapmirror
NAME
Remove-NcSnapmirror
SYNOPSIS
Removes the SnapMirror relationship of a source volume and a destination vol
ume.
SYNTAX
Remove-NcSnapmirror [-DestinationCluster <String>] -DestinationVserver <Stri
ng> -DestinationVolume <String> [-SourceCluster <String>] [-SourceVserver <S
tring>] [-SourceVolume <String>] [-Controller <NcController[]>] [-WhatIf] [-
Confirm] [<CommonParameters>]
Remove-NcSnapmirror [-Destination] <String> [[-Source] <String>] [-Controlle
r <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Removes the SnapMirror relationship of a source volume and a destination vol
ume. The volumes are not destroyed and snapshot copies on the volumes are n
ot removed. The cmdlet fails if a SnapMirror transfer for the SnapMirror re
lationship is in progress.
A set of load-sharing mirrors might contain multiple destination volumes, ea
ch destination volume having a separate SnapMirror relationship with the com
mon source volume. When used on one of the SnapMirror relationships from th
e set of load-sharing mirrors, the cmdlet deletes the specified SnapMirror r
elationship from the set of load-sharing mirrors. The cmdlet preserves the
read-write or read-only attributes of the volumes of a SnapMirror relationsh
ip after the relationship is deleted. Therefore, a read-write volume that w
as the source of a SnapMirror relationship retains its read-write attributes
, and a data protection volume or a load-sharing volume that was a destinati
on of a SnapMirror relationship retains its read-only attributes.
Note: When a SnapMirror relationship from a set of load-sharing mirrors is d
eleted, the destination volume becomes a data protection volume and retains
the read-only attributes of a data protection volume.
You can use this cmdlet from the source or from the destination cluster. Wh
en used from the destination cluster, the SnapMirror relationship informatio
n on the source and destination clusters is deleted. When used from the sou
rce cluster, only the SnapMirror relationship information on the source clus
ter is deleted.
You must specify the destination endpoint when using Remove-NcSnapmirror.
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
-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
NOTES
Category: snapmirror
API: snapmirror-destroy
Family: cluster
-------------- Example 1 --------------
C:\PS>Remove-NcSnapmirror VxeRubble://costea02/unitTestLunsSM
Destroy the SnapMirror relationship with destination 'VxeRubble://costea02/u
nitTestLunsSM'.
RELATED LINKS
New-NcSnapmirror
Get-NcSnapmirror
Set-NcSnapmirror
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|