Vserver State Test

A virtual storage server (Vserver) contains data volumes and one or more Logical interfaces (LIFs) through which it serves data to the clients. Starting with clustered Data ONTAP 8.1.1, a Vserver can either contain one or more FlexVol volumes, or a single Infinite Volume.

A Vserver securely isolates the shared virtualized data storage and network, and appears as a single dedicated server to its clients. Each Vserver has a separate administrator authentication domain and can be managed independently by a Vserver administrator.

In a cluster, Vserver facilitates data access. A cluster must have at least one Vserver to serve data.

Vservers use the storage and network resources of the cluster. However, the volumes and LIFs are exclusive to the Vserver. Multiple Vservers can coexist in a single cluster without being bound to any node in a cluster. However, they are bound to the physical cluster on which they exist.

A cluster can have one or more Vservers with FlexVol volumes and Vservers with Infinite Volumes.

A NetApp Cluster contains the following types of Vservers:

  • Admin Vserver
  • Node Vserver
  • Data Vserver

Vservers provide data access to clients without regard to physical storage or controller, similar to any storage system. When you use Vservers, they provide benefits such as nondisruptive operation, scalability, security and support unified storage. Therefore, continuous availability of the Vserver is essential so that there does not exist any disrutipon in the data transfer and hence, it becomes imperative to monitor the state of the Vservers. This is exactly how the Vserver State test helps!

This test auto-discovers the Vservers configured on the NetApp Cluster and reports the current state of 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 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.

Records Per Call

The eG agent by default, executes the API commands in order to query the aggregates in the target environment. In critical infrastructures spanning large number of aggregates, a single execution by the eG agent may query(or download) a sizeable amount of monitoring data, thereby adding to the cluster load. To avoid this, you can tweak the Records Per Call parameter to enable the eG agent to obtain monitoring data iteratively in chunks instead of retrieving the entire amount of monitoring data in a single go. Say for example, the eG agent is required to query 1000 aggregates, then specifying the value 100 in this text box will enable the eG agent to query 100 aggregates at a time for 10 times to obtain monitoring data from all the aggregates. By default, the value of this parameter is 10.


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.


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

Measure Value Numeric Value
Running 0
Starting 1
Initializing 2
Stopping 3
Stopped 4
Deleting 5


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