Citrix NetScaler documentation script version 3.0
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.
- 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.