The NetScaler Users Layer

NetScaler Sessions Test

By tracking the user activity on the NetScaler appliance, administrators will be able to determine the session load on the appliance at any given point in time. Moreover, by observing user logins over time, administrators will be able to easily figure out if user logins are happening consistently or sporadically. The latter could hint at a connection issue, requiring immediate attention. Also, when monitoring user sessions, administrators will also be able to capture unexpected logouts or abrupt session terminations and investigate the reason for the same. Such useful session-based insights are provided by the NetScaler Sessions test. This test tracks ICA and VPN user logins to the NetScaler appliance, measures the current session load on the appliance, and reveals the communication channel (ICA or VPN) used by the maximum number of users. The test additionally reports the count and percentage of new logins through each channel, and also captures inexplicable session logouts. The detailed diagnostics provided by the test also point administrators to the users who logged in newly and the users whose sessions logged out.

Target of the test : A NetScaler VPX/MPX

Agent deploying the test : A remote agent

Outputs of the test : One set of results for every type - i.e., ICA and VPN - of user session that the NetScaler appliance handles

Configurable parameters for the test
  1. Test period - How often should the test be executed
  2. Host - The host for which the test is to be configured.
  3. NetScaler username and NetScaler password - To monitor a NetScaler device, the eG agent should be configured with the credentials of a user with read-only privileges to the target NetScaler device. Specify the credentials of such a user in the NetScaler username and NetScaler password text boxes.
  4. confirm password - Confirm the NetScaler password by retyping it here.
  5. ssl - The eG agent collects performance metrics by invoking NITRO (NetScaler Interface Through Restful interfaces and Objects) APIs on the target NetScaler device. Typically, the NITRO APIs can be invoked through the HTTP or the HTTPS mode. By default, the eG agent invokes the NITRO APIs using the HTTPS mode. This is why, the ssl flag is set to Yes by default. If the target NetScaler device is not SSL-enabled, then the NITRO APIs can be accessed through the HTTP mode only. In this case, set the ssl flag to No.
  6. DD FREQUENCY – Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against dd frequency.
  7. DETAILED DIAGNOSIS – To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

    The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

    • The eG manager license should allow the detailed diagnosis capability
    • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Current sessions :

Indicates the current number of sessions of this type (ICA or VPN) on the NetScaler appliance.


This is a good indicator of the session load imposed on the NetScaler appliance by each communication channel (ICA or VPN).

New logins:

Indicates the number of new logins of this type to the NetScaler in the last measurement period.


A consistent zero value could indicate a connection issue.

You can use the detailed diagnosis of this test to know which users logged in recently.

Percent new logins:

Indicates the percentage of current sessions of this type that logged in during the last measurement period.



Sessions logging out:

Indicates the number of sessions of this type that logged out.


If all the current sessions of a type suddenly log out, it indicates a problem condition that requires investigation.

The detailed diagnosis of this measure lists the sessions that logged out.