vCenter Licenses Test

This test reports critical statistics related to the license management by vCenter.

Target of the test : A VMware vCenter server

Agent deploying the test : An internal agent

Outputs of the test : One set of results for the vCenter server being monitored.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

The host for which this test is to be configured.

Port

Refers to the port at which the specified host listens to.

Using

The Using parameter determines whether this test should be monitored using the web services API or CLI (command line interface).

If you are monitoring vCenter in an agentless manner, then you might want to execute this test using the web services API, as this approach supports both agent-based and agentless monitoring modes. In such a case therefore, select Web services API from the Using list box. If the Web services API option is chosen, then ensure that the Virtual Center Server Home parameter is set to none. Also, make sure that the VC User and VC Password parameters represent the user name and password to connect to the vCenter server. By default, Web Services API is selected from the Using list.

The command line interface is typically preferred, if vCenter is monitored in an agent-based manner. In such a case therefore, select Command Line Interface from the Using list. If this option is chosen, then ensure that the VirtualCenter License File, Virtual Center Server Home and ReReadLicense parameters are configured with valid values, and the VC User and VC Password parameters are set to None.

Note:

vCenter 4.0 does not support the command line interface; therefore, set the using parameter to Web services API while monitoring vCenter 4.0.

VC User and VC Password

To connect to vCenter and extract metrics from it, this test should be configured with the name and password of a user with Administrator or Virtual Machine Administrator privileges to vCenter. However, if, owing to security constraints, you are not able to use the credentials of such users for test configuration, then you can configure this test with the credentials of a user with Read-only rights to vCenter. For this purpose, you can assign the ‘Read-only’ role to a local/domain user to vCenter, and then specify name and password of this user against the VC User and VC Password text boxes. The steps for assigning this role to a user on vCenter have been detailed in the Creating a Special Role on vCenter and Assigning the Role to a New User topic under the eG Monitoring Capabilities -> Virtualization and Containers -> Virtualization Technologies -> VMware vSphere ESX node sequence in the eG Enterprise documentation portal Monitoring VMware Infrastructures

vCenter servers terminate user sessions based on timeout periods. The default timeout period is 30 mins. When you stop an agent, sessions currently in use by the agent will remain open for this timeout period until vCenter times out the session. If the agent is restarted within the timeout period, it will open a new set of sessions. If you want the eG agent to close already existing sessions on vCenter before it opens new sessions, then, instead of the ‘Read-only’ user, you can optionally configure the VC User and VC Password parameters with the credentials of a user with permissions to View and Stop Sessions on vCenter. For this purpose, you can create a special role on vCenter, grant the View and Stop Sessions privilege (prior to vCenter 4.1, this was called the View and Terminate Sessions privilege) to this role, and then assign the new role to a local/domain user to vCenter. The steps for assigning this role to a user on vCenter have been detailed in the Creating a Special Role on vCenter and Assigning the Role to a New User topic under the eG Monitoring Capabilities -> Virtualization and Containers -> Virtualization Technologies -> VMware vSphere ESX node sequence in the eG Enterprise documentation portal Monitoring VMware Infrastructures

Confirm Password

Confirm the password by retyping it in this text box.

Virtual Center Server Home

If the using parameter is set to Web services API, then specify none against Virtual Center Server Home. On the other hand, if Command Line Interface is chosen from the Using list, then provide the full path to the install directory of the VMware Licensing server. For example, c:\progra~1\VMware\Vmware License Server.

VirtualCenter License File

In the VirtualCenter License File text box, specify the name of the vCenter license file used by this test for reporting license-related statistics; this is vmware.lic by default. This parameter is of relevance only if the Using flag is set to Command Line Interface.

ReReadLicense

If the test executes using the Web services API, then you will have to set this flag to true or false to indicate whether the eG agent should or should not check for license changes everytime it runs this test. If this flag is set to true, then the eG agent will check for changes in license status everytime this test runs. If this flag is set to false, then the eG agent will not check for license changes.

The status of the ReReadLicense flag will be disregarded if the using parameter is set to Command Line Interface.

Webport

By default, in most virtualized environments, vCenter listens on port 80 (if not SSL-enabeld) or on port 443 (if SSL-enabled) only. This implies that while monitoring vCenter, the eG agent, by default, connects to port 80 or 443, depending upon the SSL-enabled status of vCenter – i.e., if vCenter is not SSL-enabled (i.e., if the SSL flag above is set to No), then the eG agent connects to vCenter using port 80 by default, and if vCenter is SSL-enabled (i.e., if the SSL flag is set to Yes), then the agent-vCenter communication occurs via port 443 by default.  Accordingly, the Webport 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 Webport parameter, you can specify the exact port at which vCenter in your environment listens, so that the eG agent communicates with that port for collecting metrics from vCenter.

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

Licenses installed

Indicates the number of licenses currently installed on vCenter.

Number

 

Licenses in use

Indicates the number of licenses currently being used.

Number

Ideally, this value should be lesser than the value of the Licenses installed measure. If this measure is equal to Licenses installed, then it indicates that the vCenter has run out of licenses. Use the detailed diagnosis capability of this measure to view the details of the licenses that are in use.

Note:

If the using parameter of this test has been set to Web Services API, then the eG agent will not be able to generate detailed measures for this test – i.e., the detailed diagnosis for this measure will not be available. If the using parameter is set to Command Line Interface, then you will be able to view the detailed diagnosis of this measure.

Available licenses

Indicates the number of licenses not in use currently.

Number

 

License utilization

Indicates the percentage of licenses currently in use.

Percent

Ideally, this value should be low. A value equal to or close to 100% is a cause for concern, as it indicates that the vCenter has run out of licenses.