Monitor vFabric License Usage

vFabric Platform provides 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.

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.

Prerequisites

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, 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
    G52D1-9FQ1K-48CLT-0CZK2-3RWJG,"Aug 1, 2011 - Aug 7, 2011",2,4,1.1
    G52D1-9FQ1K-48CLT-0CZK2-3RWJG,"Aug 8, 2011 - Aug 14, 2011",2,3,0.5
    G52D1-9FQ1K-48CLT-0CZK2-3RWJG,"Aug 15, 2011 - Aug 21, 2011",0,1,0
    G52D1-9FQ1K-48CLT-0CZK2-3RWJG,"Aug 22, 2011 - Aug 28, 2011",0,2,0.07
    G52D1-9FQ1K-48CLT-0CZK2-3RWJG,"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
    G52D1-9FQ1K-48CLT-0CZK2-3RWJG,"Aug 1, 2010 - July 31, 2011",50,75,30.5

    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
    G52D1-9FQ1K-48CLT-0CZK2-3RWJG,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 4. 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.

You can specify the following optional parameters to limit the reporting to a particular cluster or data center of the vCenter Server:

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

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

You can specify the following optional parameters to limit the reporting to a particular cluster or data center of the vCenter Server:

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

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.

You are required to specify the following parameters:

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

Specify the following optional parameters to limit the reporting to a particular cluster or data center of the vCenter Server:

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

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

versions-over-periods.batDisplays a report of the virtual machines that have run each vFabric component included in vFabric Platform 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 are required to specify the following parameters:

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

Specify the following optional parameters to limit the reporting to a particular cluster or data center of the vCenter Server:

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