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

If this test uses the Web Services API, then in the VC User and VC Password text boxes, specify the name and password (respectively) of a user with Administrator or Virtual Machine Administrator privileges to vCenter. However, if owing to security constraints you prefer not to expose the credentials of such a user, then, you can create a special role for this purpose on vCenter, assign the Licenses permission to this role, and assign this role to a local/domain user to vCenter. The procedure for creating this special role and assigning it to an existing local/domain user has been detailed in Section 1.1.3.1 of this document.

On other hand, if this test executes using the Command Line Interface, then the VC user and vc password parameters should be set to none.

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.

 

Configuring a Special Role on vCenter and Assigning the Role to an Existing Local/Domain User

If the vCenter Licenses test has been configured to use the Web Services API for collecting license statistics from vCenter, then the eG agent executing the test should possess either Administrator or Virtual Machine Administrator privileges to vCenter. However, owing to security constraints, users of some environments might not want to expose the credentials of their Administrators or Virtual Machine Administrators. In such environments therefore, administrators can create a special role for this purpose on vCenter, and assign that role to an existing local/domain user. The steps for the same are detailed below:

  1. Login to a system on which the VMware Infrastructure Client is installed.
  2. Double-click on the VMware Infrastructure Client icon on your desktop.
  3. Figure 1 then appears. To connect to the vCenter, select the IP address / Name of the vCenter, and then provide the login information. To grant access permissions to a user, you will have to login to vCenter as an administrator. Therefore, provide the User name and Password of the administrator in Figure 1.

    1a-final

    Figure 1 : Connecting to vCenter

  4. Figure 7 then appears. Click on the Administration icon indicated by Figure 2.

    1

    Figure 2 : The VMware Infrastructure Client console

  5. Doing so opens the Roles tab page by default. This lists all the existing user roles on vCenter. To create a new role, click on the Add Role button indicated by Figure 3.

    2

    Figure 3 : Adding a new role

  6. In Figure 4 that then appears, Enter Name of the new role. Then, grant permissions to the new role by first expanding the Global node of the tree structure in the Privileges section of Figure 4. To grant the Licenses permission to the new role, select the check box corresponding to Licenses in Figure 4. Then, click the OK button.

    3

    Figure 4 : Providing the details of the new role

  7. Figure 5 will then appear displaying the role that you just created.

    4

    Figure 5 : The newly created role appended to the list of existing roles in the Roles tab page

  8. Next, click on the Inventory icon indicated by Figure 5. When Figure 6 appears, click on the Hosts & Clusters node in the tree-structure in the left panel of Figure 6, and then click on the Permissions tab page in the right panel. This tab page lists the local/domain users to vCenter and the roles currently assigned to them.

    4

    Figure 6 : The Permissions tab page

  9. To assign the newly created role to one of the listed users, right-click anywhere in the empty, white space in the right panel, and select the Add Permission option from the shortcut menu that appears.

    5

    Figure 7 : Selecting the Add Permission option

  10. Figure 8 then appears. To choose the user who is to be assigned the new role, click the Add button in Figure 8.

    7-final

    Figure 8 : Adding a user

  11. This will open Figure 9. If you want to assign the new role to a domain user, select the Domain, and then select the user from the Users and Groups list. If you want to assign the new role to a local user, select (server) from the Domain list, and then select a user from the Users and Groups list.
  12. Either way, to add the user, click on the Add button in Figure 9. This will add the chosen user to the Users box. Then, click the ok button in Figure 9.

    7

    Figure 9 : Selecting a local/domain user

  13. When you return to Figure 8, you will find that the local/domain user you selected from Figure 9 is displayed in the Users and Groups section (see Figure 10).

    8

    Figure 10 : Assign the newly created role to the user

  14. To assign the newly created role to this user, select the user displayed in the Users and Groups section in Figure 10, pick the newly created role from the Assigned Role section, and then, click the ok button in Figure 10.
  15. Figure 11 then appears displaying the user-role mapping.

    9

Figure 11 : The Permissions tab page displaying the chosen user and the role assigned to him/her