License Usage Utility for Citrix XenApp 6.5
The License Usage Utility for Citrix XenApp 6.5 is specifically designed for use by Citrix Service Providers (use by Enterprise customers is not supported at this time). The utility allows a Citrix Service Provider to extract XenApp license data and accurately report monthly user usage.
Guide to Using the Citrix Service Provider License Reporting Tool
Citrix® Service Providers (CSP) need to generate reports of the active unique users that accessed their services for monthly CSP reporting. The preferred way to do this is to use the Citrix Service Provider License Reporting Tool. The Citrix Service Provider License Reporting Tool is implemented as a PowerShell module (found in the CSPLicenseCommand.dll). This module contains one PowerShell cmdlet that you can use to generate the license usage report. CSPs should run this cmdlet on the last day of the month for a given reporting period. As an alternative CSPs can use the custom EdgeSight® report Citrix Service Provider – License Usage Report found here:
Setting up the PowerShell Module
Steps to setup the PowerShell Module:
- The CSPLicenseReportingTool.zip file is included in the same zip file as this document.
- Unzip the contents of the zip file to a folder on the machine you wish to run the tool. This does not have to be the Citrix License Server. The CSP License Reporting Tool can work remotely.
- Open a PowerShell prompt.
- Navigate to the folder where you unzipped the contents.
- Type Import-Module .\CSPLicenseCommand.dll at the prompt and hit enter.
The module is now loaded and you can execute the one and only command in the module Get- CitrixLicenseUsage.
Using the Get-CitrixLicenseUsage cmdlet
CSPs can use the Get-CitrixLicenseUsage command to generate a report of the active unique users that accessed services for monthly CSP reporting. You can filter the results by an Active Directory OU or user group.
Get-CitrixLicenseUsage –LicenseServer serverName –FromDate 3/1 –ToDate 3/31 –LicenseType Premium
Get-CitrixLicenseUsage [-LicenseServer] <String> [[-PortNumber] <UInt32>] [[-FromDate] <DateTime>] [[-ToDate] <DateTime>] [-LicenseType <CSPLicenseType>] [-FilterByOU <String>] [-FilterByUserGroup <String>]
This command returns the number of unique XenApp users for a given time period.
-LicenseServer <string> This parameter specifies the License Server to connect to in order to retrieve the unique users.
If you want all the parameters for Get-CitrixLicenseUsage cmdlet, please read the documentation i have linked under Source.
Download License Usage Utility for Citrix XenApp 6.5 here (require MyCitrix ID)
Download documentation for License Usage Utility for Citrix XenApp 6.5 here (require MyCitrix ID)