|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NcSnapmirrorRelease
NAME
Invoke-NcSnapmirrorRelease
SYNOPSIS
Remove a SnapMirror relationship on the source endpoint.
SYNTAX
Invoke-NcSnapmirrorRelease [-Destination] <String> [[-Source] <String>] [-Re
lationshipId <String>] [-RelationshipInfoOnly] [-Controller <NcController[]>
] [<CommonParameters>]
Invoke-NcSnapmirrorRelease [-DestinationCluster <String>] -DestinationVserve
r <String> -DestinationVolume <String> [-SourceCluster <String>] [-SourceVse
rver <String>] [-SourceVolume <String>] [-RelationshipId <String>] [-Relatio
nshipInfoOnly] [-Controller <NcController[]>] [<CommonParameters>]
Invoke-NcSnapmirrorRelease [-Query] <SnapmirrorDestinationInfo> [-ContinueOn
Failure] [-MaxFailureCount <Int32>] [-Controller <NcController[]>] [<CommonP
arameters>]
DESCRIPTION
Remove a SnapMirror relationship on the source endpoint. It unlocks and clea
nups the snapshots pertaining to the relationship. It does not destroy any v
olume. You must specify the destination endpoint when using Invoke-NcSnapmir
rorRelease.
Unless RelationshipInfoOnly is specified, this operation will fail if it is
unable to reach the source volume and clean up snapshots.
This cmdlet must be executed on the source Vserver or source cluster followi
ng the deletion of the relationship on the destination Vserver or destinatio
n cluster. It is possible to issue Invoke-NcSnapmirrorRelease on the source
Vserver without deleting the relationship on the destination Vserver. Howev
er, the relationship will continue to exist because the destination is the a
uthority. The relationship will reappear on the source on the next transfer.
PARAMETERS
-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
-RelationshipId <String>
The relationship unique identifier of the SnapMirror relationship.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-RelationshipInfoOnly
If specified, only relationship information is removed.
Required? false
Position? named
Default value
Accept pipeline input? false
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
-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
-Query <SnapmirrorDestinationInfo>
A SnapmirrorDestinationInfo object with various fields set to indicate w
hich SnapMirror relationships to modify. Other fields should remain set
to null. Use "Get-NcSnapmirrorDestination -Template" to get the initia
lly empty SnapmirrorDestinationInfo object.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ContinueOnFailure
This input element is useful when multiple objects match a given query.
If set to true, the cmdlet will continue modifying the next matching ob
ject even when modification of a previous object fails. If set to false
, the cmdlet will return on the first failure.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxFailureCount <Int32>
When allowing failures, then this input element may be provided to limit
the number of failed modify operations before the server gives up and r
eturns. If set, the cmdlet will continue modifying the next matching ob
ject even when the modification of a previous matching object fails, and
do so until the total number of objects failed to be modified reaches t
he maximum specified. If set to the maximum or not provided, then there
will be no limit on the number of failed modify operations. Only appli
cable if ContinueOnFailure is specified. Default: 2^32-1
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
DataONTAP.C.PowerShell.SDK.Cmdlets.TableModifyResult
NOTES
Category: snapmirror
API: snapmirror-release,snapmirror-release-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Invoke-NcSnapmirrorRelease -DestinationVserver beam02 -DestinationVolu
me luns -SourceVserver beam01 -SourceVolume luns
Release the given snapmirror relationship.
-------------- Example 2 --------------
C:\PS>$q = Get-NcSnapmirrorDestination -Template
$q.DestinationVserver = "beam02"
Invoke-NcSnapmirrorRelease -Query $q
Release all snapmirror relationships with a destination vserver of 'beam02'.
RELATED LINKS
Get-NcSnapmirror
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|