cluster peer show

08/29/2024 Contributors

Display peer cluster information

Availability: This command is available to cluster administrators at the admin privilege level.

Description

The cluster peer show command displays information about the peering relationships between the current cluster and other clusters. Cluster peering enables independent clusters to coordinate and exchange data.

Parameters

{ [-fields <fieldname>,…]

If you specify the -fields <fieldname>, … parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-cluster <text>] - Peer Cluster Name

Selects the peered clusters that match this parameter value.

[-cluster-uuid <UUID>] - Cluster UUID (privilege: advanced)

Selects the peered clusters that match this parameter value.

[-peer-addrs <Remote InetAddress>,…] - Remote Intercluster Addresses

Selects the peered clusters that match this parameter value (remote-host name or IP address).

[-availability <availability>] - Availability of the Remote Cluster

Selects the peered clusters that match this parameter value. This parameter can have four different values:

Available - The peer cluster availability status will be Available only if all the nodes in the local cluster are able to contact all the nodes in the remote cluster.
Partial - The peer cluster availability status will be Partial only if some nodes in the local cluster are not able to contact some or all nodes in the peer cluster.
Unavailable - The peer cluster availability status will be Unavailable only if all the nodes in the local cluster are not able to contact any node in the peer cluster.
Pending - The peer cluster availability status will be Pending while the system is creating in-memory health data.
Unidentified - The peer cluster availability status will be Unidentified if the cluster peer offer is created for an anonymous cluster and is unused. When the offer is used, then the availability will get changed to any of the above mentioned status.

Note: If one or more nodes in the local cluster are offline or unreachable, then those nodes are not used to determine the availability status for the remote nodes.

[-rcluster <text>] - Remote Cluster Name

Selects the peered clusters that match this parameter value.

[-ip-addrs <Remote InetAddress>,…] - Active IP Addresses

Selects the peered clusters that match this parameter value.

[-serialnumber <Cluster Serial Number>] - Cluster Serial Number

Selects the peered clusters that match this parameter value.

[-remote-cluster-nodes <text>,…] - Remote Cluster Nodes

Selects the peered clusters that match this parameter value.

[-remote-cluster-health {true|false}] - Remote Cluster Health

Selects the peered clusters that match this parameter value.

true - This means that there is cluster quorum in the peer cluster.
false - This means that there is no cluster quorum in the peer cluster.

[-unreachable-local-nodes <text>,…] - Unreachable Local Nodes

Selects the peered clusters that match this parameter value.

[-timeout <integer>] - Operation Timeout (seconds) (privilege: advanced)

Selects the peered clusters that match this parameter value.

[-address-family {ipv4|ipv6}] - Address Family of Relationship

Selects the peered clusters that have a relationship established using this protocol.

[-auth-status-admin {no-authentication|revoked|use-authentication}] - Authentication Status Administrative

Selects the peered clusters that match this parameter value, which must be chosen from the following values.

no-authentication - The cluster peer relationship uses no authentication.
use-authentication - The cluster peer relationship is authenticated.
revoked - The cluster peer relationship is revoked until agreement can be reached.

[-auth-status-operational {ok|absent|pending|expired|revoked|declined|refused|ok-and-offer|absent-but-offer|revoked-but-offer|key-mismatch|intent-mismatch|incapable}] - Authentication Status Operational

Selects the peered clusters that match this parameter value, which must be one of the following values.

ok - The clusters both use authentication and they have agreed on an authentication key.
absent - The clusters agree not to use authentication.
pending - This cluster has made an outstanding offer to authenticate with the other cluster, but agreement has not yet been reached.
expired - This cluster's offer to authenticate with the other cluster expired before agreement was reached.
revoked - This cluster has revoked any prior authentication agreement.
declined - The other cluster has revoked the authentication agreement and is declining to communicate with this cluster.
refused - The other cluster actively refuses the communication attempts, perhaps because its part of the peering relationship has been deleted.
ok-and-offer - The clusters agree on an authentication key and are using it. In addition, this cluster has made an outstanding offer to re-authenticate with the other cluster.
absent-but-offer - The clusters currently agree that neither side requires authentication of the other, but this cluster has made an outstanding offer to authenticate.
revoked-but-offer - This cluster has revoked any authentication agreement, but it has made an outstanding offer to authenticate.
intent-mismatch - The two clusters disagree on whether authentication is required.
key-mismatch - The two clusters both believe that they are authenticated, but one of the shared secrets has become corrupted.
incapable - The other cluster is no longer running a version of Data ONTAP that supports authenticated cluster peering.

[-rpc-connect-timeout <integer>] - Timeout for RPC Connect (privilege: advanced)

Selects the peered clusters that match this parameter value.

[-update-ping-timeout <integer>] - Timeout for Update Pings (privilege: advanced)

Selects the peered clusters that match this parameter value.

[-last-updated <MM/DD/YYYY HH:MM:SS>] - Last Update Time

Selects the peered clusters that match this parameter value.

[-ipspace <IPspace>] - IPspace for the Relationship

Selects the peered clusters whose relationships are to cross the named local IPspace. The default value is the IPspace name "Default". In relationships created before ONTAP 8.3.1, the initial value is "-" and is not updated to "Default" until an action is taken on a cluster peer relationship, such as creating, modifying, or deleting a relationship.

[-encryption-protocol-proposed {none|tls-psk}] - Proposed Setting for Encryption of Inter-Cluster Communication

Selects the peered clusters that match the value of this parameter, that is, whether they are proposing to encrypt their cross-cluster communication or not.

[-encryption-protocol {none|tls-psk}] - Encryption Protocol For Inter-Cluster Communication

Selects the peered clusters that match the value of this parameter, that is, whether they are encrypting their cross-cluster communication or not.

[-psk-algorithm {akep2|jpake}] - Algorithm By Which the PSK Was Derived

Selects the peered clusters that match the value of this parameter, that is, which of the following algorithms was used to derive the Pre-Shared Key between the clusters.

akep2 - The key was obtained through the AKEP2-and-PBKDF2 algorithm.
jpake - The key was obtained through the J-PAKE algorithm.

Examples

This example shows the output of the cluster peer show command when all nodes in the local cluster are able to contact all nodes in the remote peer cluster. Additionally, the peer relationship is authenticated and operating correctly.

cluster1::> cluster peer show
Peer Cluster Name         Cluster Serial Number Availability   Authentication
------------------------- --------------------- -------------- --------------
cluster2                  1-80-123456           Available      ok

Detailed information for this scenario is shown below.

cluster1::> cluster peer show -instance
Peer Cluster Name: cluster2
              Remote Intercluster Addresses: cluster2-d2, 10.98.234.246
         Availability of the Remote Cluster: Available
                        Remote Cluster Name: cluster2
                        Active IP Addresses: 10.98.234.246, 10.98.234.243
                      Cluster Serial Number: 1-80-123456
                       Remote Cluster Nodes: cluster2-01, cluster2-02
                      Remote Cluster Health: true
                    Unreachable Local Nodes: -
             Address Family of Relationship: ipv4
       Authentication Status Administrative: use-authentication
          Authentication Status Operational: ok
                           Last Update Time: 02/05 21:05:41
               IPspace for the Relationship: Default
 Encryption for Inter-Cluster Communication: none

This example shows the output of the cluster peer show command when some nodes in the local cluster are not able to contact some or all of the nodes in the remote peer cluster.

cluster1::> cluster peer show
Peer Cluster Name         Cluster Serial Number Availability   Authentication
------------------------- --------------------- -------------- --------------
cluster2                  1-80-123456           Available      ok

Detailed information for this scenario is shown below.

cluster1::> cluster peer show -instance
Peer Cluster Name: cluster2
              Remote Intercluster Addresses: cluster2-d2, 10.98.234.246
         Availability of the Remote Cluster: Partial
                        Remote Cluster Name: cluster2
                        Active IP Addresses: 10.98.234.246, 10.98.234.243
                      Cluster Serial Number: 1-80-123456
                       Remote Cluster Nodes: cluster2-01, cluster2-02
                      Remote Cluster Health: false
                    Unreachable Local Nodes: -
             Address Family of Relationship: ipv4
       Authentication Status Administrative: use-authentication
          Authentication Status Operational: ok
                           Last Update Time: 02/05 21:05:41
               IPspace for the Relationship: Default
 Encryption for Inter-Cluster Communication: none

This example shows the output of the cluster peer show command when some nodes in the local cluster cannot be contacted from the node where the command is executed, but all the other nodes including node on which command is executed are able to contact all nodes in the remote peer cluster.

cluster1::> cluster peer show
Peer Cluster Name         Cluster Serial Number Availability   Authentication
------------------------- --------------------- -------------- --------------
cluster2                  1-80-123456           Available      ok

Detailed information for this scenario is shown below.

cluster1::> cluster peer show -instance
                          Peer Cluster Name: cluster2
              Remote Intercluster Addresses: cluster2-d2, 10.98.234.246
         Availability of the Remote Cluster: Available
                        Remote Cluster Name: cluster2
                        Active IP Addresses: 10.98.234.246, 10.98.234.243
                      Cluster Serial Number: 1-80-123456
                       Remote Cluster Nodes: cluster2-01, cluster2-02
                      Remote Cluster Health: true
                    Unreachable Local Nodes: cluster1-01
             Address Family of Relationship: ipv4
       Authentication Status Administrative: use-authentication
          Authentication Status Operational: ok
                           Last Update Time: 02/05 21:05:41
               IPspace for the Relationship: Default
 Encryption for Inter-Cluster Communication: none

This example shows the output of the cluster peer show command when some nodes in the local cluster cannot be contacted from the node where the command is executed, and the node on which command is executed is also not able to contact the remote peer cluster.

cluster1::> cluster peer show
Peer Cluster Name         Cluster Serial Number Availability   Authentication
------------------------- --------------------- -------------- --------------
cluster2                  1-80-123456           Unavailable    ok

Detailed information for this scenario is shown below.

cluster1::> cluster peer show -instance
Peer Cluster Name: cluster2
              Remote Intercluster Addresses: cluster2-d2, 10.98.234.246
         Availability of the Remote Cluster: Unavailable
                        Remote Cluster Name: cluster2
                        Active IP Addresses: 10.98.234.246, 10.98.234.243
                      Cluster Serial Number: 1-80-123456
                       Remote Cluster Nodes: cluster2-01, cluster2-02
                      Remote Cluster Health: -
                    Unreachable Local Nodes: cluster1-01
             Address Family of Relationship: ipv4
       Authentication Status Administrative: use-authentication
          Authentication Status Operational: ok
                           Last Update Time: 02/05 21:05:41
               IPspace for the Relationship: Default
 Encryption for Inter-Cluster Communication: none

This example shows the output of the cluster peer show command when all the nodes in the local cluster are not able to contact any nodes in the remote peer cluster.

cluster1::> cluster peer show
Peer Cluster Name         Cluster Serial Number Availability   Authentication
------------------------- --------------------- -------------- --------------
cluster2                  1-80-123456           Unavailable    ok

Detailed information for this scenario is shown below.

cluster1::> cluster peer show -instance
Peer Cluster Name: cluster2
              Remote Intercluster Addresses: cluster2-d2, 10.98.234.246
         Availability of the Remote Cluster: Unavailable
                        Remote Cluster Name: cluster2
                        Active IP Addresses: 10.98.234.246, 10.98.234.243
                      Cluster Serial Number: 1-80-123456
                       Remote Cluster Nodes: cluster2-01, cluster2-02
                      Remote Cluster Health: -
                    Unreachable Local Nodes: -
             Address Family of Relationship: ipv4
       Authentication Status Administrative: use-authentication
          Authentication Status Operational: ok
                           Last Update Time: 02/05 21:05:41
               IPspace for the Relationship: Default
 Encryption for Inter-Cluster Communication: none

This example shows the output of the cluster peer show command while the system is creating in-memory health data.

cluster1::> cluster peer show
Peer Cluster Name         Cluster Serial Number Availability   Authentication
------------------------- --------------------- -------------- --------------
cluster2                  1-80-123456           Pending        ok

Detailed information for this scenario is shown below.

cluster1::> cluster peer show -instance
Peer Cluster Name: cluster2
              Remote Intercluster Addresses: cluster2-d2, 10.98.234.246
         Availability of the Remote Cluster: Pending
                        Remote Cluster Name: cluster2
                        Active IP Addresses: 10.98.234.246, 10.98.234.243
                      Cluster Serial Number: 1-80-123456
                       Remote Cluster Nodes: -
                      Remote Cluster Health: -
                    Unreachable Local Nodes: -
             Address Family of Relationship: ipv4
       Authentication Status Administrative: use-authentication
          Authentication Status Operational: ok
                           Last Update Time: 02/05 21:05:41
               IPspace for the Relationship: Default
 Encryption for Inter-Cluster Communication: none

This example shows the output of the cluster peer show command for the offer created for an anonymous cluster:

cluster1::> cluster peer show
Peer Cluster Name         Cluster Serial Number Availability   Authentication
------------------------- --------------------- -------------- --------------
Clus_4gHR                 -                     Unidentified   pending

Detailed information for this scenario is shown below.

cluster1::> cluster peer show -instance
Peer Cluster Name: Clus_4gHR
              Remote Intercluster Addresses: -
         Availability of the Remote Cluster: Unidentified
                        Remote Cluster Name: Clus_4gHR
                        Active IP Addresses: 10.98.234.246, 10.98.234.243
                      Cluster Serial Number: -
                       Remote Cluster Nodes: -
                      Remote Cluster Health: -
                    Unreachable Local Nodes: -
             Address Family of Relationship: ipv4
       Authentication Status Administrative: use-authentication
          Authentication Status Operational: ok
                           Last Update Time: 02/05 21:05:41
               IPspace for the Relationship: Default
 Encryption for Inter-Cluster Communication: none

cluster peer show

Creating your file...

Description

Parameters

Examples