|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcSnapmirrorDestination
NAME
Get-NcSnapmirrorDestination
SYNOPSIS
Get information about one or more SnapMirror relationships whose source endp
oints are in the Vserver or the cluster the cmdlet is issued on.
SYNTAX
Get-NcSnapmirrorDestination [-Source <String[]>] [-SourceVolume <String[]>]
[-SourceVserver <String[]>] [-Destination <String[]>] [-DestinationVolume <S
tring[]>] [-DestinationVserver <String[]>] [-Attributes <SnapmirrorDestinati
onInfo>] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonP
arameters>]
Get-NcSnapmirrorDestination -Template [-VserverContext <String>] [-Controlle
r <NcController[]>] [<CommonParameters>]
Get-NcSnapmirrorDestination -Query <SnapmirrorDestinationInfo> [-Attributes
<SnapmirrorDestinationInfo>] [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]
DESCRIPTION
Get information about one or more SnapMirror relationships whose source endp
oints are in the Vserver or the cluster the cmdlet is issued on.
The information returned can be stale. Stale information corresponds to a Sn
apMirror relationship that has been deleted on its destination cluster or Vs
erver. Stale information may result to several entries being returned with t
he same source and destination endpoints, but with different relationship ID
s.
Note that the information for a SnapMirror relationship will not be availabl
e on its source Vserver or source cluster until at least one transfer is ini
tiated.
This API is only supported on Data ONTAP 8.2 and above operating in Cluster-
Mode. It can be issued on a Vserver or a Cluster.
PARAMETERS
-Source <String[]>
Specifies the source endpoint of the SnapMirror relationship in the form
at [vserver:]volume. 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
-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
-Destination <String[]>
Specifies the destination endpoint of the SnapMirror relationship in the
format [vserver:]volume. 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
-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
-Attributes <SnapmirrorDestinationInfo>
For improved scalability in large clusters, provide a SnapmirrorDestinat
ionInfo object with various fields set to indicate which fields to retur
n on all objects. Undesired fields should remain set to null. Use "Get
-NcSnapmirrorDestination -Template" to get the initially empty Snapmirro
rDestinationInfo object. If not specified, all data is returned for eac
h 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 SnapmirrorDestinationInfo object for use with ad
vanced queries involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <SnapmirrorDestinationInfo>
For advanced queries, provide a SnapmirrorDestinationInfo object with va
rious fields set to indicate which records to retrieve. Other fields sh
ould remain set to null. Use "Get-NcSnapmirrorDestination -Template" to
get the initially empty SnapmirrorDestinationInfo 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.SnapmirrorDestinationInfo
NOTES
Category: snapmirror
API: snapmirror-get-destination-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Get-NcSnapmirrorDestination
Get all of the snapmirror destinations on the current cluster.
RELATED LINKS
Get-NcSnapmirror
Remove-NcSnapmirror
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|