Citrix Policy Reporter - RSOP CtxCseUtil Tool

Citrix Policy Reporter - RSOP CtxCseUtil Tool

book

Article ID: CTX138533

calendar_today

Updated On:

Description

CtxCseUtil.exe

Created Date: October 24th, 2012

Version: 1.0

Description

CtxCseUtil is a tool that can generate resultant set of policy (RSOP) report (per computer, per user or both) for Citrix policies on a device that has the Group Policy Management Console installed.

Please note:
You can download the required file from the Citrix downloads website by visiting the following link: https://www.citrix.com/downloads/citrix-tools

Prerequisites

The following items must be in place for CtxCseUtil to function properly:

  • Windows Remote Management (WinRM) service must be enabled and started
  • CtxCseUtil can be used to generate a report on the local device or from a remote device, either way you’ll need the files attached to this article for CtxCseUtil (Note: Some hotfixes do install this tool as well, for example GPMx170WX64003 will add this tool as well)
  • You need to run CtxCseUtil with an account that has domain administrator privileges.
  • To run CtxCseUtil.exe on XenApp 6.0 servers, you need to have GPCSExt100W2K8R2X64003 installed as well.
  • On XD 7.6, and possibly above, the CtxCseUtil needs to be run from within a session and the logon user for that session needs to be specified using the /u parameter. If not a general WINRM error is generated.

Note: If you are running a report remotely, WinRM must be enabled on both the source device (where CtxCseUtil is being run from) and the target device (were the RSOP data is at)

 

Installing CtxCseUtil.exe

To install CtxCseUtil:

• Take the attached zip file in this article and copy it to the device you wish to run it from

• Extract the zip file on the device

• You should see CtxCseUtil.exe and the dependent files in the folder

How to Use CtxCseUtil.exe

Once CtxCseUtil is installed, here’s how you run it:

• Get to a cmd prompt

• Change into the directory where CtxCseUtil.exe is installed

• Issue the appropriate commands based on what type of report you are trying to generate

Usages details for CtxCseUtil.exe:

CtxCseUtil.exe /rsop [/o(u|c)] [/u user] [/c ComputerName] [/f filename] [/q] [/dbg]

• /rsop Generate the RSOP Report for Citrix policies.

• /o(u|c) Generate only the computer report or only the user report. By default, both are generated.

• /u Specify the target user. The default is the active user.

• /c Specify the target computer [IP Address/MachineName]. The default is the local computer.

• /f Specify a file name for the report. The default is CitrixRsopResult.html.

• /q Specify if you want to run in Quiet Mode. By default, Quiet Mode is off.

• /dbg Enable debugging output for the execution of the command.

When issuing commands with CtxCseUtil.exe, is has the following return values:

• ERRORLEVEL 0 if successful

• Greater than 0 if an error occurred

Examples:

CtxCseUtil.exe /rsop
CtxCseUtil.exe /rsop /ou
CtxCseUtil.exe /rsop /u user1 /c remotecomputer1
CtxCseUtil.exe /rsop /u user1 /f Test1_user1_121024.html /q
CtxCseUtil.exe /rsop /ou /u user1
CtxCseUtil.exe /rsop /oc /c remotecomputer1
CtxCseUtil.exe /rsop /u user1 /c remotecomputer1 /dbg
CtxCseUtil.exe /rsop /dbg

Note: By default, the resultant RSOP report will be called CitrixRsopResult.html and in the same folder as CtxCseUtil.exe. However, you can override the report name using the /f switch.

Optional step: In some cases, it’s possible that recent GPO results may not be gathered due to policy modification updates. It’s advised to run gpupdate /force for the user before running the command.

Security Permissions Required by CtxCseUtil.exe

The account being used to run CtxCseUtil.exe needs to have domain administrative privileges in order to run properly.

Uninstalling CtxCseUtil.exe

If you extracted the attached zip file to install CtxCseUtil.exe, you can remove the tool by deleting the folder where CtxCseUtil.exe is located.

NOTE: Some Citrix hotfixes install CtxCseUtil.exe as well, do not remove any folders where CtxCseUtil.exe is at if installed via a hotfix (e.g. C:\Program Files\Citrix\Group Policy\Management),.

Additional Information

Microsoft Blog: How to install GPMC via RSAT

 

Contact Information

Questions? Concerns? Send any feedback for this tool to supporttools@citrix.com.

 

Disclaimer

These software applications are 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 code be used to support of 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 code.

 

Additional Information

Please note:
You can download the required file from the Citrix downloads website by visiting the following link: https://www.citrix.com/downloads/citrix-tools