Monitoring vFabric License Usage

vFabric Suite provides Windows command-line tools and a simple Web user interface to monitor vFabric license usage by the VMs.

Note: Although you previously activated vFabric licenses using the vSphere client, you cannot yet use the vSphere client user interface to monitor the vFabric license usage; rather, you must use the commands described in this section.

Subtopics

Monitor License Usage Using Command-Line Tools

Monitor License Usage Using the Web User Interface

Displaying the Component Events File in Readable Format

Monitor License Usage Using Command-Line Tools

vFabric Suite provides the following Windows command-line tools to monitor current and periodic vFabric license usage by the VMs. You run these tools on the same Windows computer on which you installed vCenter Server.

Prerequisites

  • The vFabric license-usage reports require a 64-bit JDK or JRE (version 1.6). By default, the reports use the JRE installed with vCenter Server (located by default in the c:\Program Files\VMware\Infrastructure\jre directory). The reports use the following line to add these Java binaries to the PATH variable:

    SET PATH=%PATH%;C:\Program Files\VMware\Infrastructure\jre\bin

    If you have installed your own JDK or JRE on the vCenter Server computer, and updated the system PATH variable with its location, then the vFabric license-usage reports will use that JDK/JRE instead. This should not cause any problems, as long as the JDK/JRE is 64-bit and version 1.6. If it is not, then you must change the SET PATH line in the license reports to the following:

    SET PATH=C:\Program Files\VMware\Infrastructure\jre\bin;%PATH%

    The preceding sample assumes the default location of the VMware infrastructure directory; if you installed vCenter into a different directory, then make the appropriate change.

    The vFabric license-usage reports are located by default in C:\Program Files\VMware\Infrastructure\vFabric Platform\Reporting.

Procedure

  1. On the Windows computer on which vCenter Server is running, open a command window and change to the vCenter-Install-Dir\vFabric Platform\Reporting directory, where vCenter-Install-Dir refers to the directory in which you installed vCenter Server (default is C:\Program Files\VMware\Infrastructure.) For example:

    prompt> cd c:\Program Files\VMware\Infrastructure\vFabric Platform\Reporting
  2. Run the desired monitoring command; see Command Reference for a table that lists all the commands along with their required or optional parameters.

    For example, run the usage-over-periods.bat command to display vFabric license usage over a period of time. You must specify the start and end dates of the time period, as well as the period, such as monthly or yearly.

    prompt> usage-over-periods.bat -startDate 08/01/2011 -endDate 08/31/2011 -period WEEKLY

    The output will look something like the following:

    License Key,Period,Minimum Usage,Maximum Usage,Average Usage
    123AA-123BB-123CC-123DD-123EE,"Aug 1, 2011 - Aug 7, 2011",2,4,3.1
    123AA-123BB-123CC-123DD-123EE,"Aug 8, 2011 - Aug 14, 2011",2,3,2.5
    123AA-123BB-123CC-123DD-123EE,"Aug 15, 2011 - Aug 21, 2011",0,1,0
    123AA-123BB-123CC-123DD-123EE,"Aug 22, 2011 - Aug 28, 2011",0,2,0.07
    123AA-123BB-123CC-123DD-123EE,"Aug 29, 2011 - Aug 31, 2011",1,4,1.3

    The output shows the minimum, maximum, and average use of a single vFabric license for each week in the month of August, 2011. If you had installed additional vFabric licenses, then these would also show up in the report.

    Another example is to view the year-to-date usage of your vFabric licenses. For example, if today is July 31, 2011:

    prompt> usage-over-periods.bat -startDate 08/01/2010 -endDate 07/31/2011 -period YEARLY

    The output will look something like the following:

    License Key,Period,Minimum Usage,Maximum Usage,Average Usage
    123AA-123BB-123CC-123DD-123EE,"Aug 1, 2010 - July 31, 2011",50,75,30.5

    To view the daily usage over the last 90 days and group the output by the associated resource pool, run the following command:

    prompt> usage-over-periods.bat -days 90 -group resourcePool

    Run the current-usage.bat Windows command to get a report of the current vFabric license usage.

    prompt> current-usage.bat

    The output will look something like the following:

    License Key,Quantity Licensed,Quantity Available,Current Usage
    123AA-123BB-123CC-123DD-123EE,500,498,2

    The entry shows the 500-license vFabric license key, with 498 licenses available and 2 currently in use.

    To limit the report to the current usage on the myVDC datacenter, run the following:

    prompt> current-usage.bat -datacenter myVDC

    To view a weekly report of the number of virtual machines on a cluster called mycluster that have run the vFabric components from March 1, 2011 to March 31, 2011, run the following monitoring command:

    prompt> versions-over-periods.bat -startDate 03/01/2011 -endDate 03/31/2011 -period WEEKLY -cluster mycluster

Command Reference

Table 2. vFabric License Server Monitoring Commands

Monitoring CommandDescription
current-usage.batDisplays the current vFabric license usage and capacity, organized by license key. By default, the command displays information for the entire vCenter Server.

To group the output by cluster, resource pool, or data center, specify the -group cluster | resourcePool | datacenter parameter. For example, to group by resource pool, specify -group resourcePool. The output will list the associated resource pool for each license usage entry.

To limit the reporting to a particular cluster, resource pool, or data center of the vCenter server, specify one of the following optional parameters:

  • -cluster cluster-name: Displays current usage and capacity information for the specified cluster.

  • -datacenter datacenter-name: Displays current usage and capacity information for the specified virtual data center.

  • -resourcePool resourcePool-name: Displays current usage and capacity information for the specified resource pool.

Important: You cannot use the -group parameter in conjunction with the -cluster, -resourcePool, or -datacenter parameters.

current-versions.batDisplays the current number of virtual machines that are running each vFabric component included in vFabric Suite. By default, the command displays information for the entire vCenter Server.

To group the output by cluster, resource pool, or data center, specify the -group cluster | resourcePool | datacenter parameter. For example, to group by resource pool, specify -group resourcePool. The output will list the associated resource pool for each license usage entry.

To limit the reporting to a particular cluster, resource pool, or data center of the vCenter server, specify one of the following optional parameters:

  • -cluster cluster-name: Displays current number of virtual machines in the specified cluster that are running each vFabric component.

  • -datacenter datacenter-name: Displays current number of virtual machines in the specified data center that are running each vFabric component.

  • -resourcePool resourcePool-name: Displays current number of virtual machines in the specified resource pool that are running each vFabric component.

Important: You cannot use the -group parameter in conjunction with the -cluster, -resourcePool, or -datacenter parameters.

usage-over-periods.batDisplays a report of vFabric license usage and capacity over a period of time, organized by license key. The report includes the minimum, maximum, and average usage over the specified period. By default, the command displays information for the entire vCenter Server.

To group the output by cluster, resource pool, or data center, specify the -group cluster | resourcePool | datacenter parameter. For example, to group by resource pool, specify -group resourcePool. The output will list the associated resource pool for each license usage entry.

You can specify the period of time in one of two ways. The simplest way is to use the -days number parameter which specifies a time range in which the end date is today, the start date is the current date minus number of days, and the period is daily. For example, use -days 90 to specify an approximate time range of the last three months.

Alternatively, you can use all three of the following parameters to specify a more customized time range:

  • -startDate MM/DD/YYYY : Start date of the report. For example, use -startDate 06/01/2011 for a start date of June 1, 2011.

  • -endDate MM/DD/YYYY : End date of the report. For example, use -endDate 12/31/2011 for the end date of December 31, 2011.

  • -period DAILY|WEEKLY|MONTHLY|YEARLY : Period the report covers, such as daily or monthly. For example, -period DAILY.

Note: Do not specify a period prior to when the License Server was installed; if you do, the average usage will not be accurate.

To group the output by cluster, resource pool, or data center, specify the -group cluster | resourcePool | datacenter parameter. For example, to group by resource pool, specify -group resourcePool. The output will list the associated resource pool for each license usage entry.

To limit the reporting to a particular cluster, resource pool, or data center of the vCenter server, specify one of the following optional parameters:

  • -cluster cluster-name: Displays periodic usage information for the specified cluster.

  • -datacenter datacenter-name: Displays periodic usage information for the specified virtual data center.

  • -resourcePool resourcePool-name: Displays periodic usage information for the specified resource pool.

Important: You cannot use the -group parameter in conjunction with the -cluster, -resourcePool, or -datacenter parameters.

versions-over-periods.batDisplays a report of the virtual machines that have run each vFabric component included in vFabric Suite over a period of time. The report includes the minimum, maximum, and average number of virtual machines over the specified time period. By default, the command displays information for the entire vCenter Server.

You can specify the period of time in one of two ways. The simplest way is to use the -days number parameter which specifies a time range in which the end date is today, the start date is the current date minus number of days, and the period is daily. For example, use -days 90 to specify an approximate time range of the last three months.

Alternatively, you can use all three of the following parameters to specify a more customized time range:

  • -startDate MM/DD/YYYY : Start date of the report. For example, use -startDate 06/01/2011 for a start date of June 1, 2011.

  • -endDate MM/DD/YYYY : End date of the report. For example, use -endDate 12/31/2011 for the end date of December 31, 2011.

  • -period DAILY|WEEKLY|MONTHLY|YEARLY : Period the report covers, such as daily or monthly. For example, -period DAILY.

Note: Do not specify a period prior to when the License Server was installed; if you do, the average usage will not be accurate.

To group the output by cluster, resource pool, or data center, specify the -group cluster | resourcePool | datacenter parameter. For example, to group by resource pool, specify -group resourcePool. The output will list the associated resource pool for each license usage entry.

To limit the reporting to a particular cluster, resource pool, or data center of the vCenter server, specify one of the following optional parameters:

  • -cluster cluster-name: Displays periodic component version information for the specified cluster.

  • -datacenter datacenter-name: Displays periodic component version information for the specified virtual data center.

  • -resourcePool resourcePool-name: Displays periodic component version information for the specified resource pool.

Important: You cannot use the -group parameter in conjunction with the -cluster, -resourcePool, or -datacenter parameters.