License Usage Utility for Citrix XenApp 6.5

Written by Thomas Poppelgaard on. Posted in XenApp

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

Introduction

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:

http://community.citrix.com/display/edgesight/Custom+Reports

Setting up the PowerShell Module

Steps to setup the PowerShell Module:

  1. The CSPLicenseReportingTool.zip file is included in the same zip file as this document.
  2. 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.
  3. Open a PowerShell prompt.
  4. Navigate to the folder where you unzipped the contents.
  5. 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

Get-CitrixLicenseUsage

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.

Example

Get-CitrixLicenseUsage –LicenseServer serverName –FromDate 3/1 –ToDate 3/31 –LicenseType Premium

Syntax

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.

Parameters

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

/Poppelgaard

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)

Trackback from your site.

Comments (5)

  • Marku

    |

    Is there an installation guide availiable in the web? The only guide I found on the citrix website isn’t availiable for download.

    with best regards

    Markus

    Reply

  • Arjen

    |

    Same question, how to install the License Usage Utility for Citrix XenApp 6.5? No guide or documentation available…

    Markus, did you find anything?
    Regards,

    Reply

  • Thomas Poppelgaard

    |

    Arjen, i will try to dig in and see if i can find some more info on documentation/guides…

    Reply

  • Thomas Poppelgaard

    |

    i have added the documentation in the article now and added it to the source

    Reply

  • Blake

    |

    I have copied this file to my system and can run get-citrixlicenseusage – but i get no output.

    Reply

Leave a comment

Turn on pictures to see the captcha *

Recent Comments

Dan

|

Hi Thomas,
Some features in your screenshots (eg create appointments and contacts) seem to be missing from the iOS version of @WorkMail that got released in April, do you know if these features are still coming in a future release? The Android client is far more functional by comparison.
Regards
Dan

Christian Eilskov

|

You can see the DHCP options here:

http://www.wyse.com/kb and search for 21501

You can transfer a image using Wyse Device Manager(WDM), the same goes for smaller updates like new ICA client and so.

Thomas Poppelgaard

|

Thank you Barry =)
The deep compression codec for Citrix XenDesktop HDX 3D Pro will be intergrated for Citrix XenApp in Excalibur so there is a big difference with bandwidth consumption. This means that XenApp in Excalibur will be the best platform for user density and works great over WAN with high latency as HDX 3D Pro have been known to deliver for several years. Yes i know of cases with WAN optimization, I will gather these and share them.

Best regards
Thomas

Barry Schiffer

|

Hi Thomas,

Nice work! Awesome to see these results on XenApp! Is there any noticable difference between XA 6.5 and Excalibur that you are aware of? Do you have experience with WAN Optimization and how this helps to reduce bandwidth further?

Kind regards,

Barry

Our Team
Feeds from Citrix Blog :