Citrix NetScaler Powershell documentation script v3

Citrix NetScaler documentation script version v3

Citrix NetScaler Access Gateway MPX

Citrix NetScaler


With great pleasure I can finally share the release of the Citrix NetScaler documentation script version 3.0.

The latest version, 2.5, was released at the end of 2014, yes 2014! It has been a while and there are many reasons for that, mostly joyful and some unfortunate.


In total the Citrix NetScaler Documentation Script has been downloaded at least 13.000 times already and we still see a daily demand for it. I’ve also received a huge amount of response with new ideas or just a basic thank you. This release is a major update and will help us to release new versions faster.

The main reason it took this long is that we have literally changed everything, and I mean everything. Except for the output which all looks quite familiar aside from new information we are now able to document.

With the release of version 3.0 we moved from parsing the ns.conf configuration file to utilising the NetScaler Nitro API. Although this makes perfect sense it proved to be quite the project.

The project started with replacing the functions, were we read and analyse the configuration file, Iain Brighton created by functions that are able to utilise the Nitro API. This took some time to get right because every time we though we had it we needed something more specific.
All the Powershell Nitro functions have been created by Iain Brighton specifically for the NetScaler documentation script. The functions have been shared via Github…..

When we got the functions right it was time to find all the information we need for documentation in the NetScaler script. This part of the project proved to be very time consuming but in the process a lot more information was found which has all been added to the documentation script.

Before I start with explaining what has changed I want to point out that, although I started this script, this truly has been a team effort. The script wouldn’t have been this great if it wasn’t for Carl Webster and Iain Brighton. Webster developed an amazing PowerShell template to get started with documenting and outputting to Microsoft Word. Iain has written all of the functions I use in the script to make sure I’m getting all the values out in a way it’s readable.

Please have a look at the team page to see a list of everyone who helped me develop and test the script.

What’s new

  • Uses Nitro API to connect to NetScaler instead of ns.conf
  • Microsoft Office 2016 support
  • NetScaler 11.0 support

For the complete release notes click here

The Citrix NetScaler documentation script version 3.0 can be downloaded here.


Bookmark the permalink.

About Barry Schiffer

Barry is an IT Architect with 15 years of IT experience. He has gained both a broad and deep knowledge in the sphere of IT. Throughout the years, Barry has developed into a specialist in the field of Microsoft Windows, Server Based Computing, desktop and server virtualisation.Barry is co-founder and member of the Board of the Dutch Citrix User Group.Barry is awarded with the Citrix Technology Professional award in 2015 and received the RES Software Valued Professional award in 2012.

4 Responses to Citrix NetScaler Powershell documentation script v3

  1. Aaron Kahn says:

    Hi Barry. Big fan of your scripts. I like the new version, but with the change of using Nitro, in order to run it, I now need to be connected to the customer’s network (versus just having them send me the ns.conf file). A lot of times, I might be connected to a machine that doesn’t have Word on it. Is there any way for me to collect the information to a text file, and then reformat it later? I looked in the script and see that you have options for text and html, but they did not appear to do anything.

    Thanks to you and your team for all the hard work.

    • Thanks Aaron.

      With version 3.0 we decided to go for Nitro only, it’s virtually impossible to have both ns.conf and Nitro in one script, the input for both is completely different and I unfortunately don’t have time to maintain two scripts. Carl and Iain are working on an updated script template that will make it possible to run the script on a machine without Microsoft Word installed. This should fix part of your issues.

      The text and html options are for output only, this makes the documentation output in docx/html/pdf. This means output so not the input for the script:).

  2. Kumar Iyer says:

    thanks a lot Barry!!!!
    Fantastic efforts. This one script has reduced the job of deployment guys in a big way. Guys like Barry are invaluable assets to IT.Keep up the good work.

  3. khawaja says:

    I am unable to connect NetScaler for generating documentation. I used IP as well as FQDN; in both cases it is not working. Please suggest how can i resolve this.

    Invoke-RestMethod : Unable to connect to the remote server
    At E:\PS\NetScaler_Script_v3_6_Unsigned.ps1:2801 char:25
    + $restResponse = Invoke-RestMethod @invokeRestMethodParams;
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : NotSpecified: (:) [Invoke-RestMethod], WebException
    + FullyQualifiedErrorId : System.Net.WebException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

Leave a Reply