Agents Administration - Tests
 

Default Parameters for CtxNsLicExpiryTest

This test tracks the license usage of NetScaler and for each lincense determines when the license of each type is likely to expire.

This page depicts the default parameters that need to be configured for the CtxNsLicExpiryTest test.

  • The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

  • The eG agent is capable of monitoring the licenses installed in the target NetScaler device itself or managed by the Citrix license server or the license pool of the Citrix Application Delivery Management service. To enable this, set the USE API flag to Yes. This implies that this test will track the license files and report the availability, usage and license expiry details at regular intervals.

    If the Use API flag is set to No, it implies that the test will monitor only the license files installed in the target NetScaler device and itself and report when the license is likely to expire. In this case, the user is required to access the Citrix License file available in the NetScaler device to collect metrics. To access the Citrix License file, the user should be vested with superuser permission.

  • 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.

  • 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.

  • Confirm the NETSCALER PASSWORD by retyping it in the CONFIRM PASSWORD text box.

  • 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.

  • This flag is applicable only when the USE API flag is set to No.By default, the SHOW EXPIRED LICENSE flag is set to No indicating that this test will not monitor the licenses of NetScaler device that expired. Set this flag to Yes, if the expired licenses are also needed to be included for monitoring. As a result, this test will report -6 against the Days_to_expire measure to indicate the licenses that expired.

  • Once the above values are provided, click on the UPDATE button to register the changes made.

When changing default configurations of tests, the values with “$” indicate variables that will be replaced by the eG system according to the specific server being managed - for instance, $hostName is the host/nickname of the target host, $port is the port number of the server being monitored. E.g., for a server xyz:80, $hostName will be changed automatically by the eG manager to “xyz*” and $port will be changed to “80” when configuring a test.