Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcClusterPeer


NAME
Get-NcClusterPeer

SYNOPSIS
Returns a list of cluster peer relationships.

SYNTAX
Get-NcClusterPeer [[-Name] <String[]>] [-Address <String[]>] [-Availability
<String[]>] [-Attributes <ClusterPeerInfo>] [-Controller <NcController[]>] [
<CommonParameters>]

Get-NcClusterPeer -Template [-Controller <NcController[]>] [<CommonParameter
s>]

Get-NcClusterPeer -Query <ClusterPeerInfo> [-Attributes <ClusterPeerInfo>] [
-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Returns a list of cluster peer relationships.


PARAMETERS
-Name <String[]>
The name of the peer cluster. Data ONTAP wildcards are permitted.

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

-Address <String[]>
The remote IP address or host name of the peer cluster. Data ONTAP wild
cards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Availability <String[]>
The status of the peer cluster connection. Data ONTAP wildcards are per
mitted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Attributes <ClusterPeerInfo>
For improved scalability in large clusters, provide a ClusterPeerInfo ob
ject with various fields set to indicate which fields to return on all o
bjects. Undesired fields should remain set to null. Use "Get-NcCluster
Peer -Template" to get the initially empty ClusterPeerInfo object. If n
ot specified, all data is returned for each object.

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

-Controller <NcController[]>
A Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each 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 ClusterPeerInfo object for use with advanced que
ries involving the Query attribute.

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

-Query <ClusterPeerInfo>
For advanced queries, provide a ClusterPeerInfo object with various fiel
ds set to indicate which records to retrieve. Other fields should remai
n set to null. Use "Get-NcClusterPeer -Template" to get the initially e
mpty ClusterPeerInfo 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
NetApp.Ontapi.Filer.C.ClusterPeer810.ClusterPeerInfo


NOTES


Category: cluster peer
API: cluster-peer-get-iter
Family: cluster

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

C:\PS>Get-NcClusterPeer


List all peer clusters.


ClusterName Availability ActiveAddresses
----------- ------------ ---------------
stlfas3170-7-8-cluster available {10.61.178.64, 10.61.178.63}



RELATED LINKS
Add-NcClusterPeer
Remove-NcClusterPeer
Set-NcClusterPeer







 Data ONTAP® PowerShell Toolkit