VDI-in-a-Box License Details Test

VDI-in-a-Box is licensed based on the count of concurrent users. By tracking the number of users who are simultaneously connected to virtual desktops via the vdimanager, you can easily figure out how the concurrent user licenses have been utilized.

The startup license on the other hand does not affect the VDI-in-a-Box license count.  It is used to allow a Citrix product to communicate with the license server using a continuous open connection. Each time a Citrix product starts, it opens a connection to the license server by checking out the startup license. Every five minutes the license server and the products send a heartbeat message to each other to verify that they are mutually communicating.

This test tracks the usage of the Citrix Startup and VDI-in-a-Box licenses, and helps determine the following:

  • Whether adequate Citrix startup licenses are available for supporting continuous connections to the Citrix License server;
  • Whether sufficient concurrent user licenses are available or more licenses need to be purchased.

This way, you can ensure the uninterrupted use of the vdimanager and the virtual desktops it manages.

Target of the test : A VDI-in-a-Box Manager

Agent deploying the test : A remote agent

Outputs of the test : One set of results for Citrix Startup licenses and Citrix CDI in-a-box licenses.

Configurable parameters for the test
Parameters Description

Test period

This indicates how often should the test be executed.

Host

The host for which this test is to be configured.

Port

The port at which the specified host listens to.

VDI in a Box Host

The IP address of the vdimanager that is being monitored.

VDI in a Box Username, VDI in a Box Password, and Confirm Password

The test needs to log on to the VDI-in-a-Box appliance to pull out the metrics of interest. For this purpose, you need to configure the test with the credentials of a user with login rights to the appliance. By default, the appliance supports a root user named root (with the default password root) and a Read-only user named kvm (with the default password kaviza123). If you prefer not to expose the credentials of the root user, then you can configure the VDI in a Box Username and VDI in a Box Password parameters with the credentials of the user kvm. Confirm the password of this user by retyping it in the Confirm Password text box.

Note:

The default password of user kvm is kaviza123. If this is changed, then make sure you configure the VDI in a box password parameter with the new password.

SSH Port

Specify the SSH port number of the vdimanager. By default, this is 22.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

Licenses installed

Indicates the total number of licenses of this type that are currently installed.

Number

 

Licenses in use

Indicates the number of licenses of this type that are currently in use.

Number

If the value of this measure is equal to that of Licenses installed, it indicates that all the licenses are utilized. If you have exhausted the startup licenses, then VDI-in-a-Box may not be able to communicate continuously with the license server and check out licenses, until additional licenses of this type are purchased.  If no more VDI-in-box licenses are free, it implies that subsequent desktop requests from users will be rejected, until additional licenses of this type are purchased.

Available licenses

Indicates the number of licenses of this type that are currently unused.

Number

A high value is desired for this measure.

License utilization

Indicates the percentage of installed licenses that are currently in use.

Percent

A value close to 100% is indicative of rapid depletion of licenses; you may have to purchase additional licenses to continue using the product.

If enough startup licenses are not available, then VDI-in-a-Box may not be able to communicate continuously with the license server and check out licenses until additional licenses of this type are purchased.  If sufficient VDI-in-box licenses are not available, it implies that subsequent requests for desktops will be rejected by the vdimanager, until additional licenses of this type are purchased.