Data ONTAP® PowerShell Toolkit

Cmdlet: Get-NaSnapmirror


NAME
Get-NaSnapmirror

SYNOPSIS
Return the SnapMirror status.

SYNTAX
Get-NaSnapmirror [[-Location] <String>] [-Controller <NaController>] [-Warni
ngAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>
]


DESCRIPTION
Return the SnapMirror status. This API can be issued on either the source o
r destination filer.


PARAMETERS
-Location <String>
The source location or destination location of the SnapMirror pair. Poss
ible types are volume or qtree only. If this input is provided, only the
SnapMirror relationships with a matching source or destination will be
reported. The argument is invalid if the named location doesn't exist.
The argument can also be invalid if it is a flexclone name. (Be aware th
at the "Get-NaSnapmirrorDestination" API can return flexclone names.) Th
en this API will return an output value with a "state" of "unknown". If
the argument is not specified, all source, destination SnapMirror pairs
are returned.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Controller <NaController>
The DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningAction <ActionPreference>


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningVariable <String>


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
NetApp.Ontapi.Filer.Snapmirror.SnapmirrorStatusInfo


NOTES


Category: snapmirror
API: snapmirror-get-status

-------------- Example 1 --------------

C:\PS>Get-NaSnapmirror benson:dunn_vol2_mirror


Get the status of the snapmirror using location "benson:dunn_vol2_mirror".
In this example, the given location is the destination, but this cmdlet also
accepts source locations.


BaseSnapshot : benson(0118045471)_dunn_vol2_mirror.9
Contents : Replica
CurrentTransferError :
CurrentTransferType :
DestinationLocation : benson:dunn_vol2_mirror
LagTime : 4001
LastTransferDuration : 9
LastTransferFrom : dunn:vol2
LastTransferSize : 7656
LastTransferType : update
MirrorTimestamp : 1266339005
SourceLocation : dunn:vol2
State : snapmirrored
Status : idle
TransferProgress : 0



RELATED LINKS







 Data ONTAP® PowerShell Toolkit