UDAdmin.exe tool has been enhanced for better reporting and exporting of User Device License usage

UDAdmin.exe tool has been enhanced for better reporting and exporting of User Device License usage

book

Article ID: CTX215674

calendar_today

Updated On:

Description

Question:
How to check license usage in Xendesktop/Xenapp with the enhanced UDAdmin.exe tool for reporting and monitoring?

Answer:
With License Server 11.14.0.1 Build 23101, some enhancements have been made to the UDAdmin command for better reporting of User Device License usage.
The enhancements made to this tool include: -

  1.  -list parameter has been modified to support inclusion of timestamps in the output generated and -times parameter has been added.
  2. -events parameter has been newly added to report events in a chronological order.
  3. -export parameter has been newly added which allows exporting User Device license usage in a CSV format.
 
More details are given below for each of the above-mentioned enhancements: -

Enhancement 1:  -list parameter has been modified and -times parameter has been added.
The original version of this tool had a limitation in the Date/time logic the result on which was not enough resolution on timestamps to know at what time of day a license request was made.  The tool has now been improved to included timestamps in the output generated.  Running the command udadmin -list -times generates the output along with timestamps.  A sample output it given here: -
 
Sample1: Usage of udadmin -list -times

C:\Program Files\Citrix\Licensing\LS>udadmin -list -times

Usage data is 0 minutes old. Next update in 15 minutes.
Users:
 u01.01 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.04 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.10 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.11 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.12 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.13 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.14 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.15 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.16 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.17 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.18 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u01.19 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 u06 XDT_PLT_UD 2017.1201 (Tue Sep 12 14:30:37 2017)
 user10 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 user11 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 user12 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 user13 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 user14 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 
Devices:
 D.ADV.23 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 D01 XDT_PLT_UD 2017.1201 (Tue Sep 12 14:30:33 2017)
 D01.02 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.05 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.20 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.21 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.22 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.23 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.24 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.25 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.26 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.27 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.28 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 D01.29 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
 devicename20(D.ADV.20) XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 devicename20(D.ADV.21) XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 devicename22 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 devicename24 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)
 
Sample2: Usage of udadmin -list -a -times with the -a switch that organizes output by feature and version

C:\Program Files\Citrix\Licensing\LS>udadmin -list -a -times

Usage data is 318 minutes old. No changes since.

Feature : XDT_ADV_UD
Installed: 1010000 Installed Overdraft : 0
In Use : 10 Users: 5 Devices: 5

Version : 2017.1201
Installed: 1001000 Installed Overdraft : 0
In Use : 10 Users: 5 Devices: 5

Users:
 user10 (Thu Sep 21 19:56:41 2017)
 user11 (Thu Sep 21 19:56:41 2017)
 user12 (Thu Sep 21 19:56:41 2017)
 user13 (Thu Sep 21 19:56:41 2017)
 user14 (Thu Sep 21 19:56:41 2017)

Devices:
 D.ADV.23 (Thu Sep 21 19:56:41 2017)
 devicename20(D.ADV.20) (Thu Sep 21 19:56:41 2017)
 devicename20(D.ADV.21) (Thu Sep 21 19:56:41 2017)
 devicename22 (Thu Sep 21 19:56:41 2017)
 devicename24 (Thu Sep 21 19:56:41 2017)

Version : 2017.1202
Installed: 1000 Installed Overdraft : 0
In Use : 0 Users: 0 Devices: 0

Enhancement 2:  -events parameter has been added.
The -events parameter has been newly added.  This reports all events logged by the User Device Licensing for each feature sorted in chronological order. An example of each possible logged event is presented below. License server outages less than two hours (7200 seconds) are not logged.
 
Sample1: Usage of -events parameter.

C:\Program Files\Citrix\Licensing\LS>udadmin -events

Feature : CXM_ENTU_UD
 FIRST_CREATION (Sat Dec 02 10:55:15 2017)
 UPGRADE_FROM_V2 (Sun Dec 03 10:55:15 2017)
 UPGRADE_FROM_V1 (Sun Dec 03 10:56:55 2017)
 TAMPERING_DETECTED (Sun Dec 03 10:56:55 2017)
 REPLAY_DETECTED (Mon Dec 04 10:55:15 2017) license server outage duration = 7200 seconds
 REMOVE_USER (Mon Dec 04 11:15:15 2017)
 REMOVE_USER (Mon Dec 04 11:28:35 2017)
 REMOVE_USER (Mon Dec 04 11:30:15 2017)
 REMOVE_DEVICE (Mon Dec 04 11:31:55 2017)
 REMOVE_DEVICE (Mon Dec 04 11:45:15 2017)
 REMOVE_DEVICE (Mon Dec 04 11:46:55 2017)
 REPLAY_DETECTED (Thu Dec 14 21:39:36 2017) license server outage duration = 16585 seconds

Feature : XDT_ADV_UD
 REPLAY_DETECTED (Fri Jan 05 00:14:38 2018) license server outage duration = 1825001 seconds

Feature : XDT_BAS_UD
 REMOVE_USER (Wed Oct 11 22:18:09 2017)
 REMOVE_DEVICE (Wed Oct 11 22:18:09 2017)
 REMOVE_USER (Sun Dec 03 21:18:09 2017)
 REMOVE_DEVICE (Sun Dec 03 21:18:09 2017)
 FIRST_CREATION (Mon Dec 04 21:18:09 2017)
 REMOVE_USER (Mon Dec 04 21:18:09 2017)
 REMOVE_DEVICE (Mon Dec 04 21:18:09 2017)
 UPGRADE_FROM_V2 (Tue Dec 05 21:18:09 2017)
 REMOVE_USER (Tue Dec 05 21:18:09 2017)
 REMOVE_DEVICE (Tue Dec 05 21:18:09 2017)
 UPGRADE_FROM_V1 (Tue Dec 05 21:19:49 2017)
 TAMPERING_DETECTED (Tue Dec 05 21:19:49 2017)
 REMOVE_USER (Wed Dec 06 21:18:09 2017)
 REMOVE_DEVICE (Wed Dec 06 21:18:09 2017)
 REPLAY_DETECTED (Wed Dec 06 21:18:09 2017) license server outage duration = 7200 seconds
 REMOVE_USER (Thu Dec 07 21:18:09 2017)
 REMOVE_DEVICE (Thu Dec 07 21:18:09 2017)
 REMOVE_USER (Thu Dec 14 21:18:09 2017)
 REMOVE_DEVICE (Thu Dec 14 21:18:09 2017)
 REPLAY_DETECTED (Fri Jan 05 00:14:38 2018) license server outage duration = 1824989 seconds

Feature : XDT_STD_UD
 FIRST_CREATION (Thu Dec 14 21:39:37 2017)
 
Sample2: Usage of udadmin -f FEATURE -events parameter along with FEATURE which restricts output to a specific feature.

C:\Program Files\Citrix\Licensing\LS>udadmin -f FEATURE -events

Restricts event logging to only the feature specified.
C:\Program Files\Citrix\Licensing\LS>udadmin -f XDT_STD_UD -events
Feature : XDT_STD_UD
 FIRST_CREATION (Thu Dec 14 21:39:37 2017)

Enhancement 3:  -export parameter has been added.
The -export parameter has been newly added in this version. This exports all features into one .csv document. The first row is the column header. It is organized by feature and then user. Every unique (user,deviceId,versionRequested) is reported on one line. Redundant licensing requests for the same (user,deviceid,versionRequested) are not remembered by User Device individually... only the timestamp is updated by the most recent request.   Refer to the sample output given below: -
 
Sample1:  Usage of -export parameter

C:\Program Files (x86)\Citrix\Licensing\LS>udadmin -export

feature,userId,deviceId,deviceName,versionRequested,versionUserAllocated,versionDeviceAllocated,time
CXM_ENTU_UD,u01,D01,,2016.0103,,2018.0105,Mon Dec 11 10:55:13 2017
CXM_ENTU_UD,u01,D01,,2016.0102,,2018.0105,Mon Dec 11 10:55:14 2017
CXM_ENTU_UD,u02,D01,,2016.0101,,2018.0105,Mon Dec 11 10:55:16 2017
CXM_ENTU_UD,u03,D01,,2016.0101,,2018.0105,Mon Dec 11 10:55:17 2017
CXM_ENTU_UD,user10,D.ENTU.10,devicename10,2010.1204,2018.0105,,Tue Dec 12 11:26:18 2017
CXM_ENTU_UD,user10,D.ENTU.10,devicename10,2010.1205,2018.0105,,Tue Dec 12 11:26:18 2017
CXM_ENTU_UD,user11,D.ENTU.11,devicename11,2010.1204,2018.0105,,Tue Dec 12 11:26:18 2017
CXM_ENTU_UD,user11,D.ENTU.11,devicename11,2010.1205,2018.0105,,Tue Dec 12 11:26:18 2017
CXM_ENTU_UD,user28,D.ENTU.24,devicename24,2010.1204,,2018.0105,Tue Dec 12 11:26:18 2017
CXM_ENTU_UD,user28,D.ENTU.24,devicename24,2010.1205,,2018.0105,Tue Dec 12 11:26:18 2017
CXM_ENTU_UD,user29,D.ENTU.24,devicename24,2010.1204,,2018.0105,Tue Dec 12 11:26:18 2017
CXM_ENTU_UD,user29,D.ENTU.24,devicename24,2010.1205,,2018.0105,Tue Dec 12 11:26:18 2017
XDT_BAS_UD,u64,DEVICEID,,2018.1201,,2018.1201,Wed Oct 11 22:18:09 2017
XDT_BAS_UD,u63,DEVICEID,,2018.1201,,2018.1201,Thu Oct 12 22:18:09 2017
XDT_BAS_UD,u62,DEVICEID,,2018.1201,,2018.1201,Fri Oct 13 22:18:09 2017
XDT_BAS_UD,u02,DEVICEID,,2018.1201,,2018.1201,Tue Dec 12 21:18:09 2017
XDT_BAS_UD,u01,DEVICEID,,2018.1201,,2018.1201,Wed Dec 13 21:18:09 2017
XDT_BAS_UD,u00,DEVICEID,,2018.1201,,2018.1201,Thu Dec 14 21:18:09 2017
 
Sample2:  Usage of udadmin -f FEATURE -export - Same as above but only the specified FEATURE is exported.

C:\Program Files (x86)\Citrix\Licensing\LS>udadmin -f XDT_BAS_UD -export

feature,userId,deviceId,deviceName,versionRequested,versionUserAllocated,versionDeviceAllocated,time
XDT_BAS_UD,u64,DEVICEID,,2018.1201,,2018.1201,Wed Oct 11 22:18:09 2017
XDT_BAS_UD,u63,DEVICEID,,2018.1201,,2018.1201,Thu Oct 12 22:18:09 2017
XDT_BAS_UD,u62,DEVICEID,,2018.1201,,2018.1201,Fri Oct 13 22:18:09 2017
XDT_BAS_UD,u02,DEVICEID,,2018.1201,,2018.1201,Tue Dec 12 21:18:09 2017
XDT_BAS_UD,u01,DEVICEID,,2018.1201,,2018.1201,Wed Dec 13 21:18:09 2017
XDT_BAS_UD,u00,DEVICEID,,2018.1201,,2018.1201,Thu Dec 14 21:18:09 2017
 

Environment

This software application is provided to you as is with no representations, warranties or conditions of any kind. You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that: (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application. In no event should the software application be used to support ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the software application.