-
Where to Get Copies of the Various Scripts
September 30, 2011
Active Directory, NetScaler, PowerShell, PVS, VMware, XenApp, XenApp 5 for Server 2003, XenApp 5 for Server 2008, XenApp 6.0, XenApp 6.5, XenDesktop 5.x
NOTE: All current scripts require PowerShell Version 3 or later.
All current documentation scripts create a Microsoft Word 2010, 2013, or 2016/2019/O365 document.
Word 2016, Word 2019 and the Office 365 version of Word have the same version number of 16. All documentation scripts will work with Word 2019 and Word Office 365 with no changes.
*****All the scripts run best on PowerShell Version 5*****
Many people have asked me where they can get copies of the various PowerShell documentation scripts. To make it easier to find, I have linked to all of them in this one article.
All scripts have been moved to the new Downloads page.
I am leaving this landing page here so I don’t break all the existing links people have to this page.
Thanks
Webster
Subscribe
Subscribe to our e-mail newsletter to receive updates.
333 Responses to “Where to Get Copies of the Various Scripts”
November 20, 2024 at 8:30 am
Hi, is it possible to get output in markdown format (wikipedia/devops)?
November 23, 2024 at 6:57 am
Not unless someone knows how to do that. I am retired from maintaining the scripts, so this is a job for someone else.
Sorry
Webster
February 1, 2024 at 9:50 am
I can and “invalid link” when I try and download.
February 9, 2024 at 7:31 am
The link is valid. I Just tried it and it worked. Did you try more than once? If so, can you email me a screenshot of your error? webster at carlwebster dot com
Thanks
Webster
June 26, 2021 at 7:21 am
Hi Carl,
We have Citrix XenApp and XenDesktop 7.15 environment CU6 environment.
I would like to get the list of Citrix Policies configiured from Citrix Studio (or) would like to export policies that are showing up in Policies tab of Citrix Studio to CSV/Excel/PDF/WORD?
Is there any possibility to achieve this or any powershell script already documented by you, If yes, could you please share it
June 26, 2021 at 8:14 am
You need https://www.carlwebster.com/downloads/download-info/xenappxendesktop-7-8/
Look in the detailed help for -Section Policies.
Webster
January 3, 2020 at 4:10 am
Hi Carl,
I am trying to document XA 6.5 farm in PDF format. MS Word is not available on ZDC.
If i use -HTML it works. But I would like to have a PDF file. ZDC dosen’t have any WORD or PDF viewer installed
I am getting attached error
.\XA65_Inventory_V5_Signed.ps1 -PDF -Summary
01/03/2020 14:36:53: Testing output parameters
01/03/2020 14:36:53: PDF is set
01/03/2020 14:36:54: CoName is
01/03/2020 14:36:54: Remoting is not being used
01/03/2020 14:36:54: Getting initial Farm data
01/03/2020 14:36:54: Verify farm version
This script directly outputs to Microsoft Word, please install Microsoft Word
Regards,
Jab
January 3, 2020 at 7:59 am
The PDF option uses the Word SaveAs PDF option. That means, to use the PDF option, Word is required. You can run the script remotely, but you will not get any Policy data as Citrix never added Remoting support to the XenApp 6.5 policy module.
Webster
January 6, 2020 at 12:37 am
Thanks for your reply. I was assuming with PDF options, you don’t need word installed.Now I understand its only for the output format.
Regards,
Jab
January 1, 2020 at 6:46 am
Hi Carl,
I am using Netscaler (ADC ) script Citrix_ADC_Script_v4_51_Signed and its creating blank report.
I am using export / import feature. I see few other members have faced this issue earlier. But no one has posted the fix for that.
Powershell version 5. – 32bit.
NO MS Word available on Jump server hence using export command.
I tried passing credentials via -credential syntax but same issue. I let it prompt me for userid / password – same issue.
I can logon to netscaler via same user / password with browser (AD user/password). I don;t have any local user on NS to test
Regards,
Jab
January 1, 2020 at 8:31 am
I am not a NetScaler person and recently had to document a NetScaler for a customer. I also had an empty Word doc. What I didn’t realize was my output folder had a subfolder that contained all the XML files. When I used that subfolder for the Import option, I got my fully populated Word doc.
In case that is not your issue, I forwarded your comment to the script’s author.
Webster
January 2, 2020 at 4:17 am
Thanks for your reply Carl.
I am also not a netscaler guy. And incidentally, I also have to document Netscaler setup at a customer site .
I checked and my output folder have no subfolder. It conains XML files only (all 1 KB)
I tried few things. Script ran for good 10-15 minutes but still produced 1 KB XML files only.
1) I am using Powershell x86
2) Bypass NSIP in Proxy
3) saved NS credentials in powershell variable using Get-credential
Command I used was – .\Citrix_ADC_Script_v4_51_Signed.ps1 -Export -ExportPath “.\NS” -Credential $my -NSIP 1.1.1.1
this time sript ran for good 10-15 minutes. But created 1KB XML.
After importing those XML, I get a blank %^ KB Word Document
Hope it helps.
Regards,
Jab
January 2, 2020 at 7:55 am
I had the same issues (1K XML files and long script runtime) because I was using the wrong IP address to connect to the NetScaler.
Webster
January 3, 2020 at 1:05 am
I checked again and NSIP is correct.
As per (https://docs.citrix.com/en-us/netscaler/12/networking/ip-addressing/configuring-netscaler-owned-ip-addresses/configuring-netscaler-ip-address.html)
After clicking on gear icon in the top-right corner of the Configuration page, nothing happens.
I don’t think I have full admin rights on netscaler, but I have operator access (as I have been told by old team members)
Regards,
Jab
January 3, 2020 at 8:00 am
You will need to request help from the script’s author.
amccullough84@gmail.com
Webster
April 25, 2019 at 6:45 pm
Thank you kindly for leaving this page up 🙂
February 1, 2019 at 11:46 am
Hi Carl,
Just wondering if you have a script(s) for XenApp/XenDesktop version 6.x & 7.x to pull general tooling information/inventory out of an environment?
Thanks
February 1, 2019 at 12:06 pm
Those I what I am most known for. Just follow the link on the page you left this comment.
Webster
December 5, 2018 at 12:16 pm
hello can i use the ADhealth Check without the need of MS Word locally installed?
December 14, 2018 at 11:30 am
No. THe author of that script did not add any additional output options.
Sorry
Webster
May 22, 2017 at 5:37 am
Hi Carl, please could you add me to test group for 7.x scripts. Thanks!
May 22, 2017 at 6:38 am
The 7.8+ script has been released.
Webster
March 13, 2017 at 9:50 am
Hello Carl,
In smaller environments I use the content switching capability of the Netscaler Gateway. But when I use the documentation script none of this is documented.
Am I missing something?
Kind regards
Bas
March 13, 2017 at 9:52 am
I have sent your query on to Barry Schiffer who created and maintains the NS script.
Webster
May 1, 2017 at 6:31 am
Hi Bas,
I’d expect the CAG content switch policies to show up in the Content switch chapter?
I’ll add it to the roadmap for v4 with NS v12 support. We need some time, probably end of may beginning of july.
Regards,
Barry
March 9, 2017 at 8:00 am
Hi Carl,
I am running your Netscaler V2.5 Script for documenting our clients Netscaler configs.I currently do not have access to NS environment. But I do have the ns.config file so that is why I am using this version of the script. The script runs for more than 1:30 hrs, is it normal ? and it stays for long time in “Closing Word”
March 9, 2017 at 8:11 am
Staying at Closing Word for a very long time is not normal. Your report should have already been created and saved at that point. If it has, you can safely exit the PoSH session.
Webster
March 9, 2017 at 8:20 am
Where I can see the report, I dont see any new documents in the same folder.
March 9, 2017 at 8:40 am
Try the -Folder parameter to specify an output folder.
If you are using 64-bit PoSH, try 32-bit PoSH.
Webster
March 9, 2017 at 8:38 am
Hi Carl, Do we need to have any connectivity with the Netscaler device while running this script(is it mandatroy), as I am using the ns.conf file alone.
March 9, 2017 at 8:40 am
Not if you are using the nsconf file.
Webster
March 9, 2017 at 11:33 am
Thank you Carl! It did wonders, I had to install a SaveAsPDFandXPS plugin, I dont know if that fixed, but post that, I got a prompt for choosing the location to save the docx file, it works now.
March 9, 2017 at 12:00 pm
What version of Word? If it is 2007, this is why I had to stop supporting 2007. It is a royal PITA to work with from a scripting viewpoint.
Webster
February 8, 2017 at 11:43 pm
Hi Carl,
Excellent job with the scripts!
Also could you add me to test group for XD7.8+ scripts. Thanks in advance,
Henrik
January 27, 2017 at 7:48 am
Hi Carl, please could you add me to test group for 7.8+ scripts. Thanks!
January 27, 2017 at 12:52 pm
Done
Webster
January 13, 2017 at 4:15 am
Hey carl i have a customer im suppose to do annual maintenance for this is my first time doing this how do i go about it. is there a checklist for it. for example i want to do it on
1. ShareFile
2. XenApp
3. XenDesktop
4. Netscaler
5. Secure Gateway
January 13, 2017 at 6:49 am
I have scripts to document 2, 3, and 4. I know of nothing to document ShareFile and Secure Gateway is basically a configuration file.
Webster
January 9, 2017 at 3:12 am
Hello Carl.
Thank you very much for your work and for sharing it.
Is it possible to send me a link to download your XenDesktop 7.8+ Beta script to test it on my new XenDeskop/XenApp 7.12 ?
Thank you in advance.
Best regards,
P.S : Happy new year
January 9, 2017 at 5:19 am
email me, webster@carlwebstercom and I will add you to the testers group.
Webster
December 28, 2016 at 1:20 pm
Hi Carl, I have a question regarding the “XenApp 6.0 Version 4.2 Documentation Script ” that you have available to download. I followed all of the steps 1 through 5 if applicable, and now ready to run the script against my XenApp environment. Now I am on the script usage portion. Any ideas? I am aiming to run this remotely against the servers. Unless I have to run them directly on them which I’d prefer not to touch?
PS C:\xa6sdk> .\XA6_Inventory_V42.ps1
Security warning
Run only scripts that you trust. While scripts from the internet can be useful, this script can potentially harm your
computer. If you trust this script, use the Unblock-File cmdlet to allow the script to run without this warning
message. Do you want to run C:\xa6sdk\XA6_Inventory_V42.ps1?
[D] Do not run [R] Run once [S] Suspend [?] Help (default is “D”): R
VERBOSE: 12/28/2016 12:18:43: Testing output parameters
VERBOSE: 12/28/2016 12:18:43: MSWord is set
VERBOSE: 12/28/2016 12:18:43: CoName is
Loading Windows PowerShell snap-in: Citrix.Common.Commands
WARNING: Missing Windows PowerShell snap-ins Detected:
WARNING: (Citrix.XenApp.Commands)
C:\xa6sdk\XA6_Inventory_V42.ps1 : Missing Citrix PowerShell Snap-ins Detected, check the console above for more
information. Are you sure you are running this script on a XenApp 6 Server? Script will now close.
At line:1 char:1
+ .\XA6_Inventory_V42.ps1
+ ~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : NotSpecified: (:) [Write-Error], WriteErrorException
+ FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,XA6_Inventory_V42.ps1
December 28, 2016 at 1:26 pm
Sorry but the XenApp 6.0 PoSH cmdlets do not support remoting. Also, Citrix never addedr remoting support to the 6.x group policy module. I also never added HTML support to the 5/6/6.5 scripts so Word and PoSH V3 are requirements.
Webster
December 7, 2016 at 10:14 pm
Hi,
I am running the script in admin mode and getting a full word document with empty content.
Am I missing something?
Regards
Bahir
December 8, 2016 at 6:18 am
Which script?
Webster
December 8, 2016 at 4:18 pm
Apologies. It is the NetScaler Documentation script.
I ran it with the NSIP address, user name and password.
It ran without a problem and created a word document with all the sections but they are all empty. No information was populated.
VERBOSE: 12/09/2016 09:37:46: Validate cover page Sideline for culture code en-
VERBOSE: 12/09/2016 09:37:46:
VERBOSE: 12/09/2016 09:37:46:
VERBOSE: 12/09/2016 09:37:46: AddDateTime : False
VERBOSE: 12/09/2016 09:37:46: Company Name :
VERBOSE: 12/09/2016 09:37:46: Cover Page : Sideline
VERBOSE: 12/09/2016 09:37:46: Dev : False
VERBOSE: 12/09/2016 09:37:46: Filename1 : C:\Users\XXXXXXX\Documents\NetScaler Documentation.docx
VERBOSE: 12/09/2016 09:37:46: Folder :
VERBOSE: 12/09/2016 09:37:46: From :
VERBOSE: 12/09/2016 09:37:46: NSIP : 172.XX.XX.XX
VERBOSE: 12/09/2016 09:37:46: Save As PDF : False
VERBOSE: 12/09/2016 09:37:46: Save As WORD : True
VERBOSE: 12/09/2016 09:37:46: ScriptInfo : False
VERBOSE: 12/09/2016 09:37:46: Smtp Port : 25
VERBOSE: 12/09/2016 09:37:46: Smtp Server :
VERBOSE: 12/09/2016 09:37:46: Title : NetScaler Documentation
VERBOSE: 12/09/2016 09:37:46: To :
VERBOSE: 12/09/2016 09:37:46: Use NS SSL : False
VERBOSE: 12/09/2016 09:37:46: Use SSL : False
VERBOSE: 12/09/2016 09:37:46: User Name : XXXXXXX
VERBOSE: 12/09/2016 09:37:46:
VERBOSE: 12/09/2016 09:37:46: OS Detected : Microsoft Windows 10 Enterprise
VERBOSE: 12/09/2016 09:37:46: PoSH version : 5.0.10586.672
VERBOSE: 12/09/2016 09:37:46: PSCulture : en-GB
VERBOSE: 12/09/2016 09:37:46: PSUICulture : en-GB
VERBOSE: 12/09/2016 09:37:46: Word language : 1033
VERBOSE: 12/09/2016 09:37:46: Word version : Word 2013
VERBOSE: 12/09/2016 09:37:46:
VERBOSE: 12/09/2016 09:37:46: Script start : 12/09/2016 09:37:46
VERBOSE: 12/09/2016 09:37:46:
VERBOSE: 12/09/2016 09:37:46:
VERBOSE: 12/09/2016 09:37:46: Load Word Templates
VERBOSE: 12/09/2016 09:37:47: Attempt to load cover page Sideline
VERBOSE: 12/09/2016 09:37:47: Create empty word doc
VERBOSE: 12/09/2016 09:37:47: Disable grammar and spell checking
VERBOSE: 12/09/2016 09:37:47: Insert new page, getting ready for table of contents
VERBOSE: 12/09/2016 09:37:47: Table of Contents – Automatic Table 2
VERBOSE: 12/09/2016 09:37:47: Set the footer
VERBOSE: 12/09/2016 09:37:47: Get the footer and format font
VERBOSE: 12/09/2016 09:37:47: Footer text
VERBOSE: 12/09/2016 09:37:47: Add page numbering
VERBOSE: 12/09/2016 09:37:47:
VERBOSE: 12/09/2016 09:37:48: Chapter 1/33 NetScaler IP
VERBOSE: 12/09/2016 09:37:48: Chapter 2/33 NetScaler Global HTTP Parameters
VERBOSE: 12/09/2016 09:37:48: Chapter 3/33 NetScaler Global TCP Parameters
VERBOSE: 12/09/2016 09:37:48: Chapter 4/33 NetScaler Global Diameter Parameter
VERBOSE: 12/09/2016 09:37:48: Chapter 5/33 NetScaler Time zone
VERBOSE: 12/09/2016 09:37:48: Chapter 6/33 NetScaler Location Database
VERBOSE: 12/09/2016 09:37:48: Chapter 7/33 NetScaler Administration
VERBOSE: 12/09/2016 09:37:48: Chapter 8/33 NetScaler Features
VERBOSE: 12/09/2016 09:37:48: Chapter 9/33 NetScaler Advanced Features
VERBOSE: 12/09/2016 09:37:48: Chapter 10/33 NetScaler Modes
VERBOSE: 12/09/2016 09:37:48: Chapter 11/33 NetScaler Monitoring
VERBOSE: 12/09/2016 09:37:48: Chapter 12/33 NetScaler Auditing
VERBOSE: 12/09/2016 09:37:49: Syslog Policies
VERBOSE: 12/09/2016 09:37:49: Chapter 13/33 NetScaler Networking
VERBOSE: 12/09/2016 09:37:49: Chapter 14/33 NetScaler Traffic Domains
VERBOSE: 12/09/2016 09:37:49: Chapter 15/33 NetScaler Authentication
VERBOSE: 12/09/2016 09:37:49: Chapter 16/33 NetScaler LDAP Authentication
VERBOSE: 12/09/2016 09:37:49: Chapter 17/33 NetScaler Radius Authentication
VERBOSE: 12/09/2016 09:37:49: Chapter 18/33 NetScaler Content Switching
VERBOSE: 12/09/2016 09:37:49: Chapter 19/33 NetScaler Load Balancers
VERBOSE: 12/09/2016 09:37:49: Chapter 20/33 NetScaler Cache Redirection
VERBOSE: 12/09/2016 09:37:49: Chapter 21/33 NetScaler Services
VERBOSE: 12/09/2016 09:37:49: Chapter 22/33 NetScaler Service Groups
VERBOSE: 12/09/2016 09:37:49: Chapter 23/33 NetScaler Servers
VERBOSE: 12/09/2016 09:37:49: Chapter 24/33 NetScaler Global Server Load Balancing
VERBOSE: 12/09/2016 09:37:49: GSLB Parameters
VERBOSE: 12/09/2016 09:37:49: GSLB Virtual Servers
VERBOSE: 12/09/2016 09:37:49: GSLB Services
VERBOSE: 12/09/2016 09:37:49: GSLB Sites
VERBOSE: 12/09/2016 09:37:49: NetScaler SSL
VERBOSE: 12/09/2016 09:37:49: Chapter 25/33 SSL Certificates
VERBOSE: 12/09/2016 09:37:49: SSL Ciphers
VERBOSE: 12/09/2016 09:37:49: SSL Services
VERBOSE: 12/09/2016 09:37:49: SSL Service Groups
VERBOSE: 12/09/2016 09:37:49: SSL Profiles
VERBOSE: 12/09/2016 09:37:50: Chapter 26/33 NetScaler Security
VERBOSE: 12/09/2016 09:37:50: Chapter 27/33 Citrix NetScaler (Access) Gateway
VERBOSE: 12/09/2016 09:37:50: NetScaler Gateway Global Settings
VERBOSE: 12/09/2016 09:37:50: Chapter 28/33 Citrix NetScaler (Access) Gateway Policies
VERBOSE: 12/09/2016 09:37:50: NetScaler Gateway Session Policies
VERBOSE: 12/09/2016 09:37:50: NetScaler Gateway AlwaysON Policies
VERBOSE: 12/09/2016 09:37:50: NetScaler Gateway Session Actions
VERBOSE: 12/09/2016 09:37:51: Chapter 29/33 NetScaler Monitors
VERBOSE: 12/09/2016 09:37:51: Table: Write NetScaler Monitors Table
VERBOSE: 12/09/2016 09:37:51: Chapter 30/33 NetScaler Policies
VERBOSE: 12/09/2016 09:37:51: Table: NetScaler Pattern Set Policies
VERBOSE: 12/09/2016 09:37:51: Table: NetScaler Responder Policies
VERBOSE: 12/09/2016 09:37:51: Table: NetScaler Rewrite Policies
VERBOSE: 12/09/2016 09:37:51: Chapter 31/33 NetScaler Actions
VERBOSE: 12/09/2016 09:37:51: Table: NetScaler Responder Action
VERBOSE: 12/09/2016 09:37:51: Table: NetScaler Rewrite Action
VERBOSE: 12/09/2016 09:37:51: Chapter 32/33 NetScaler Profiles
VERBOSE: 12/09/2016 09:37:51: Table: Write NetScaler TCP Profiles Table
VERBOSE: 12/09/2016 09:37:51: Table: Write NetScaler HTTP Profiles Table
VERBOSE: 12/09/2016 09:37:51: Finishing up document
VERBOSE: 12/09/2016 09:37:51: Set Cover Page Properties
VERBOSE: 12/09/2016 09:37:51: Update the Table of Contents
VERBOSE: 12/09/2016 09:37:52: Save and Close document and Shutdown Word
VERBOSE: 12/09/2016 09:37:52: Saving DOCX file
VERBOSE: 12/09/2016 09:37:52: Running Word 2013 and detected operating system Microsoft Windows 10 Enterprise
VERBOSE: 12/09/2016 09:37:52: Closing Word
VERBOSE: 12/09/2016 09:37:52: System Cleanup
VERBOSE: 12/09/2016 09:37:53: WinWord process is still running. Attempting to stop WinWord process # 8540
VERBOSE: Performing the operation “Stop-Process” on target “WINWORD (8540)”.
VERBOSE: 12/09/2016 09:37:53: C:\Users\XXXXXXXX\Documents\NetScaler Documentation.docx is ready for use
VERBOSE: 12/09/2016 09:37:53: Script has completed
VERBOSE: 12/09/2016 09:37:53:
VERBOSE: 12/09/2016 09:37:53: Script started: 12/09/2016 09:37:46
VERBOSE: 12/09/2016 09:37:53: Script ended: 12/09/2016 09:37:53
VERBOSE: 12/09/2016 09:37:53: Elapsed time: 0 days, 0 hours, 0 minutes, 6.565 seconds
December 8, 2016 at 5:11 pm
6.5 seconds to run the NS script shows the NS has nothing configured or something is wrong somewhere.
Try running the script with just the NSIP address and let it prompt from the username and password.
If that doesn’t work, send me the complete command line you are using but you can use 1.2.3.4 for the NSIP address.
Thanks
Webster
April 25, 2017 at 6:26 am
Bahir,
Did you solve this problem? I am also getting an empty word doc.
Dom
April 25, 2017 at 6:33 am
Need more info.
What script?
What version of the script?
What version of Word?
32-bit or 64-bit Word?
What version of Windows?
32-bit or 64-bit?
What version of PowerShell?
32-bit or 64-bit?
You need to help me help you.
Webster
April 25, 2017 at 7:05 am
Carl,
What script? NetScaler Documentation
What version of the script? NetScaler_Script_v3_6_Signed.ps1
What version of Word? Word 2013 32-bit
What version of Windows? Windows 7 Enterprise 64-bit
What version of PowerShell? 5.0.10586.117 32-bit and 64-bit
NS version 11.0
If I use the Dev parameter I see a large number of errors, most common are
‘The variable ‘$script:nsSession’ cannot be retrieved because it has not been set’
‘InvokevNetScalerNitroMethod : Cannot bind argument to parameter ‘Uri’ because it is an empty string’
‘The property ‘gslbvserver’ cannot be found on this object. Verify that the property exists’ – in this one the property varies.
Dom
April 25, 2017 at 7:08 am
Can you send me the -dev output file? webster@carlwebster.com
Webster
April 25, 2017 at 7:16 am
Also, email me the parameters used to run the script.
Webster
April 25, 2017 at 8:53 am
Carl,
Will email it all shortly.
Dom
November 28, 2016 at 4:51 pm
Carl….. One word.. Awesome!! Worked without issues. The only issue that I have found is a lot of my customers have me use a jump server to configure the NS and does not have Word on it. Do I have to use the older script that uses the NS.CONF file in order for the script to work? Or is there a workaround for this issue?
Thanks in advance,
Scott
November 28, 2016 at 4:53 pm
I believe Barry created the script to allow a remote connection to the NS. Check the help text for info since I am not a NS person.
Webster
November 27, 2016 at 11:03 am
Hi Carl, please add me to test group for XD7.8+ scripts
thanks a lot
November 29, 2016 at 7:37 am
Done
Webster