Vserver Peer State Test

Vserver peer relationship is an authorization infrastructure that enables a cluster administrator to set up peering applications such as SnapMirror relationships between Vservers either existing within a cluster (intracluster) or in the peered clusters (intercluster). Only a cluster administrator can set up Vserver peer relationships.

Vserver peer infrastructure enables you to set up a backup and recovery mechanism between Vservers. You can set up mirroring relationship at volume level between peered Vservers. If a Vserver's volume becomes unavailable, the cluster administrator or a Vserver administrator can configure the respective mirrored volume of the peered Vserver to serve data.

One Vserver can be peered with multiple Vservers within a cluster or across clusters. In clustered Data ONTAP 8.2, only SnapMirror data protection (DP), vault (XDP) and load-sharing relationship (LS) relationships can be set up by using the Vserver peer infrastructure.

For a hassle free data transfer through the NetApp Cluster, administrators need to constantly monitor the state of the Vserver peer relationship failing which administrators may not be able to figure out the Vserver through which data transfer stopped abruptly. The Vserver Peer State test exactly helps the administrators achieve this!

This test auto-discovers the Vservers on the NetApp Cluster and reports the current state of the Vserver peer relationship for each Vserver.

Target of the test : A NetApp Cluster

Agent deploying the test : An external/remote agent

Outputs of the test : One set of results for each local Vserver:peered Vserver on the NetApp Cluster being monitored .

Configurable parameters for the test
Parameters Description

Test Period

How often should the test be executed.


The IP address of the storage controller cluster.


Specify the port at which the specified host listens in the Port text box. By default, this is NULL.


Here, specify the name of the user who possesses the readonly role. If such a user does not pre-exist, then, you can create a special user for this purpose using the steps detailed in Creating a New User with the Role Required for Monitoring the NetApp Cluster.


Specify the password that corresponds to the above-mentioned User.

Confirm Password

Confirm the Password by retyping it here.

Authentication Mechanism

In order to collect metrics from the NetApp Cluster, the eG agent connects to the ONTAP management APIs over HTTP or HTTPS. By default, this connection is authenticated using the LOGIN_PASSWORD authentication mechanism. This is why, LOGIN_PASSWORD is displayed as the default Authentication Mechanism.


Set the Use SSL flag to Yes, if SSL (Secured Socket Layer) is to be used to connect to the NetApp Unified Storage System, and No if it is not.

API Report

By default, in most environments, NetApp Cluster listens on port 80 (if not SSL-enabled) or on port 443 (if SSL-enabled) only. This implies that while monitoring the NetApp Cluster, the eG agent, by default, connects to port 80 or 443, depending upon the SSL-enabled status of the NetApp Cluster - i.e., if the NetApp Cluster is not SSL-enabled (i.e., if the Use SSL flag above is set to No), then the eG agent connects to the NetApp Cluster using port 80 by default, and if the NetApp Cluster is SSL-enabled (i.e., if the Use SSL flag is set to Yes), then the agent-NetApp Cluster communication occurs via port 443 by default. Accordingly, the API Port parameter is set to default by default.

In some environments however, the default ports 80 or 443 might not apply. In such a case, against the API Port parameter, you can specify the exact port at which the NetApp Cluster in your environment listens, so that the eG agent communicates with that port for collecting metrics from the NetApp Cluster.

Exclude Aggregates

If you wish to exclude certain aggregates from the scope of monitoring, specify a list of comma-separated aggregates in this text box. By default, none will be displayed here.


Specify the duration (in seconds) beyond which the test will timeout if no response is received from the device. The default is 120 seconds.

Measurements made by the test
Measurement Description Measurement Unit Interpretation


Indicates the current state of this Vserver peer relationship.


The values that this measure can report and their corresponding numeric values have been listed in the table below.

Measure Value Numeric Value Description
Peered 1

Indicates either one of the following:

  • An intercluster Vserver peer relationship is accepted from the peered cluster.
  • An intracluster Vserver peer relationship is established.
  • An intercluster or intracluster Vserver peer relationship is resumed.
Pending 2 An intercluster Vserver peer relationship is requested from the local cluster.
Initializing 3 The local cluster is communicating with the peer cluster for initializing the Vserver peer relationship.
Initiated 4 An intercluster Vserver peer relationship is requested from the local cluster.
Deleted 5 An intercluster Vserver peer relationship isdeleted from any of the peered clusters.
Suspended 6 An intercluster or intracluster Vserver peer relationship is suspended from the local or peered cluster.
Rejected 7 An intercluster Vserver peer relationship is rejected from the peered cluster.


By default, this measure reports the above-mentioned Measure Values while indicating the current state of this Vserver peer. However, in the graph of this measure, states will be represented using the corresponding numeric equivalents i.e., 1 to 7.