PowerShell: Documenting Citrix Policies

UPDATE: I had updated this script (updated link in the comments below), but had not updated the post with the new script. This has been done.

Disclaimer: This post references PowerShell XenApp Commands that were released as a technology preview for XenApp 4.5/5.0. I have not tested the script against the XenApp 6 which uses a different version of these XenApp Commands.

Documentation is a vital (yet rarely loved) part of systems administration/engineering.  Exhaustively documenting Citrix can turn your hair white.  There are  farm-wide settings, polices, application publishing properties, zone configuration, and that’s just the beginning.

We are in the midst of architecting a new Citrix environment where I work and we are taking advantage of this to review everything we have done before and changing it if needed.  We’re also attempting to document every facet of our new environment which includes, Provisioning (DHCP), XenApp, XenServer, XenDesktop, AppSense, Netscalers, Web Interface, and MS App-V.

For this post, I’m providing a PowerShell script I modified from Kent Finkle that will capture a Citrix Policy and what it’s applied to in a Word document.  The script will also export the Citrix policy and its filter (what it’s applied to) to 2 XML files that can be used to recreate or restore the configuration if it’s lost.
NOTE: This script assumes that the XenApp PowerShell Commands are installed on the server you’re running the script from.  You can download them from

Here’s the script:

# NAME: get-citrixpolicy.ps1
# AUTHOR: Alain Assaf
# DATE  : 5/11/2010
# SOURCE1: Author: Kent Finkle http://kentfinkle.com/CreateSaveWordDoc.aspx
# SOURCE2: Author: Mark Alexander Bain http://command-line-programming.suite101.com/article.cfm/how_to_create_a_word_document_with_powershell
# COMMENT: Output a Citrix Policy to a Word document.
#          Assumes XenApp Commands are installed on source server
# VERSION: 1.0.0 - Initial script
# VERSION: 1.0.5 - Added policy filter and xml export of policy and filter
# VERSION: 1.0.6 - 8/23/2010 - Added prompt for policy and got document to
#                  automatically save and close.
#Load XenApp Commands
Add-PSSnapin -Name *citrix*

#Initalize farm
$farm = get-xafarm

#Output list of Current Policies and prompt for one to create a document and backup
Get-XAPolicyConfiguration | select PolicyName
$polname = Read-Host "Enter a Citrix Policy to create a report and backup"

#Set variables
$docpath = "\\NETWORKSHARE\Documentation\Architecture\Citrix\policies"
$hname = $env:computername
$uname = $env:username
$a = get-date –format g
$b = get-date -uformat "%m%d%Y"
$oMissing = [System.Reflection.Missing]::Value

#Test path & create if not present
if (!(Test-path -path $docpath)) { new-item $docpath -type directory | out-null }

# Create new Word document
$objWord = New-Object -comobject Word.Application
$objWord.Visible = $True

$objDoc = $objWord.Documents.Add($oMissing, $oMissing, $oMissing, $oMissing)
$objSelection = $objWord.Selection

$objSelection.Font.Name = "Arial"
$objSelection.Font.Size = "18"
$objSelection.TypeText("Citrix Policy Report")
$objSelection.TypeText(" for Farm: " + $farm.FarmName)
$objSelection.Font.Size = "8"
$objSelection.Font.Italic = $True
$objSelection.TypeText("Script run on: " + $hname)
$objSelection.TypeText(" by: " + $uname)
$objSelection.TypeText(" at " + $a)
$objSelection.Font.Italic = $False

$objSelection.Font.Size = "10"
$policy = Get-XAPolicyConfiguration -PolicyName $polname
$objSelection.Font.Bold = $True
$objSelection.TypeText("Citrix Policy: " + $policy.PolicyName)
$objSelection.Font.Bold = $False
$objSelection.Font.Size = "10"

$outpol = $policy | Out-String
$objSelection.TypeText("" + $outpol)

$policyfilter = Get-XAPolicyFilter -PolicyName $polname
$objSelection.Font.Bold = $True
$objSelection.TypeText($policyfilter.PolicyName + " policy applied to:")
$objSelection.Font.Bold = $False
$objSelection.Font.Size = "10"

$outpolfilter = $policyfilter | Out-String
$objSelection.TypeText("" + $outpolfilter)

$doctitle = $farm.FarmName + "_" + $policy.PolicyName + "_" + $b
$savepath = "$docpath\$doctitle.doc"

$poltitle = $farm.FarmName + "_" + $policy.PolicyName + "_Policy" + "_" + $b
$polfiltertitple = $farm.FarmName + "_" + $policyfilter.PolicyName + "_PolicyFilter" + "_" + $b

export-clixml -path "$docpath\$poltitle.xml" -InputObject $policy
export-clixml -path "$docpath\$polfiltertitple.xml" -InputObject $policyfilter

Here’s a sample of the Word document (sanitized for public consumption):


The intention is to run this script periodically to provide documentation and a backup of all the policies applied to a farm.  I encourage you to explore the PowerShell commands provided by Citrix.  You will be able to document every aspect of your farm and also have an easy way to backup/restore the information as needed.



9 thoughts on “PowerShell: Documenting Citrix Policies”

  1. Hi Alain,

    the script does not work for me as I get the following error:

    Get-XAPolicyConfiguration : Cannot find policy with name CITRIX POLICY NAME (0x80320007)
    At D:\temp\get-citrixpolicy.ps1:54 char:36
    + $policy = Get-XAPolicyConfiguration <<<< -PolicyName $polname
    Get-XAPolicyFilter : Cannot find policy with name CITRIX POLICY NAME (0x80320007)
    At D:\temp\get-citrixpolicy.ps1:64 char:35
    + $policyfilter = Get-XAPolicyFilter <<<< -PolicyName $polname

    I have Xenapp powwershell commands installed.

    1. I originally wrote this script while working with the XenApp Commands technology preview for XenApp 4.5/5.0. I do not know if it works with the Cmdlets that came with XenApp 6. That being said, I’ve revised this script to use a more generic App-PSSnapin command to load the XenApp Cmdlets. I’ve also added a couple of lines to list the current Citrix policies in the farm and then prompt the user for one to run the script against. I’ve also changed some of the Word commands to automatically close the document with the correct name (note: it will overwrite an existing document). I got the modified Word actions from Mark Alexander Bain in his post here: http://command-line-programming.suite101.com/article.cfm/how_to_create_a_word_document_with_powershell.

      Here’s a link to download the new script: get-citrixpolicy.ps1

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s