|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcSnapmirror
NAME
Get-NcSnapmirror
SYNOPSIS
List SnapMirror relationships.
SYNTAX
Get-NcSnapmirror [-Destination <String[]>] [-DestinationCluster <String[]>]
[-DestinationVserver <String[]>] [-DestinationVolume <String[]>] [-Source <S
tring[]>] [-SourceCluster <String[]>] [-SourceVserver <String[]>] [-SourceVo
lume <String[]>] [-Attributes <SnapmirrorInfo>] [-VserverContext <String>] [
-Controller <NcController[]>] [<CommonParameters>]
Get-NcSnapmirror -Template [-VserverContext <String>] [-Controller <NcContro
ller[]>] [<CommonParameters>]
Get-NcSnapmirror -Query <SnapmirrorInfo> [-Attributes <SnapmirrorInfo>] [-Vs
erverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
List SnapMirror relationships.
PARAMETERS
-Destination <String[]>
A SnapMirror destination endpoint in the format: [cluster:]//vserver/vol
ume. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DestinationCluster <String[]>
A SnapMirror destination cluster. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DestinationVserver <String[]>
A SnapMirror destination vserver. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DestinationVolume <String[]>
A SnapMirror destination volume. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Source <String[]>
A SnapMirror source endpoint in the format: [cluster:]//vserver/volume.
Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SourceCluster <String[]>
A SnapMirror source cluster. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SourceVserver <String[]>
A SnapMirror source vserver. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SourceVolume <String[]>
A SnapMirror source volume. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <SnapmirrorInfo>
For improved scalability in large clusters, provide a SnapmirrorInfo obj
ect with various fields set to indicate which fields to return on all ob
jects. Undesired fields should remain set to null. Use "Get-NcSnapmirr
or -Template" to get the initially empty SnapmirrorInfo object. If not
specified, all data is returned for each object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
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
-Template
Specify to get an empty SnapmirrorInfo object for use with advanced quer
ies involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <SnapmirrorInfo>
For advanced queries, provide a SnapmirrorInfo object with various field
s set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcSnapmirror -Template" to get the initially emp
ty SnapmirrorInfo object.
Required? true
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.Types.Snapmirror.SnapmirrorInfo
NOTES
Category: snapmirror
API: snapmirror-get-iter
Family: cluster
-------------- Example 1 --------------
C:\PS>Get-NcSnapmirror
List all SnapMirror relationships.
SourceLocation DestinationLocation Status
MirrorState
-------------- ------------------- ------
-----------
VxeRubble://costea01/vol1_LS1 VxeRubble://costea01/vol1_LS2 idle
snapmirrored
VxeRubble://costea01/unitTestLuns VxeRubble://costea02/unitTestLunsSM idle
snapmirrored
-------------- Example 2 --------------
C:\PS>$query = Get-NcSnapmirror -Template
$query.RelationshipType = "load_sharing"
Get-NcSnapmirror -Query $query
Using an advanced query, get all load-sharing SnapMirror relationships.
SourceLocation DestinationLocation Status MirrorSta
te
-------------- ------------------- ------ ---------
--
VxeRubble://costea01/vol1_LS1 VxeRubble://costea01/vol1_LS2 idle snapmirro
red
RELATED LINKS
Remove-NcSnapmirror
Set-NcSnapmirror
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|