|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NcSnapmirrorQuiesce
NAME
Invoke-NcSnapmirrorQuiesce
SYNOPSIS
Disables future transfers to a SnapMirror destination.
SYNTAX
Invoke-NcSnapmirrorQuiesce [-DestinationCluster <String>] -DestinationVserve
r <String> -DestinationVolume <String> [-SourceCluster <String>] [-SourceVse
rver <String>] [-SourceVolume <String>] [-Passthru] [-Controller <NcControll
er[]>] [<CommonParameters>]
Invoke-NcSnapmirrorQuiesce [-Destination] <String> [[-Source] <String>] [-Pa
ssthru] [-Controller <NcController[]>] [<CommonParameters>]
Invoke-NcSnapmirrorQuiesce [-Query] <SnapmirrorInfo> [-ContinueOnFailure] [-
MaxFailureCount <Int32>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Disables future transfers to a SnapMirror destination. If there is no trans
fer in progress, the SnapMirror relationship becomes 'Quiesced'. If there i
s a transfer in progress, the SnapMirror relationship becomes 'Quiescing' un
til the transfer completes. If the current transfer aborts, it will be trea
ted like a future transfer and will not restart. When a SnapMirror relation
ship is quiesced, it remains in that state across reboots and fail-overs.
The relationship must exist on the destination and you must specify the dest
ination endpoint.
This cmdlet must be issued on the destination cluster.
If applied to a load-sharing (LS) SnapMirror relationship, all the relations
hips in the set will be quiesced.
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
-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
-Query <SnapmirrorInfo>
A SnapmirrorInfo object with various fields set to indicate which SnapMi
rror relationships to modify. Other fields should remain set to null.
Use "Get-NcSnapmirror -Template" to get the initially empty SnapmirrorIn
fo 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
NOTES
Category: snapmirror
API: snapmirror-quiesce,snapmirror-quiesce-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Invoke-NcSnapmirrorQuiesce //costea02/unitTestLunsSM -Passthru
Quiesce the SnapMirror with destination '//costea02/unitTestLunsSM' and disp
lay the SnapMirror object.
SourceLocation DestinationLocation Status
MirrorState
-------------- ------------------- ------
-----------
VxeRubble://costea01/unitTestLuns VxeRubble://costea02/unitTestLunsSM quiesc
ed snapmirrored
-------------- Example 2 --------------
C:\PS>$q = Get-NcSnapmirror -Template
$q.SourceVserver = "beam01"
Invoke-NcSnapmirrorQuiesce -Query $q
Quiesce all snapmirror relationships for source vserver beam01.
SuccessCount : 1
FailureCount : 0
SuccessList : {beam01:luns --> beam02:luns}
FailureList : {}
RELATED LINKS
Get-NcSnapmirror
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|