Most people dislike documentation – or rather, they like having it but most don’t like creating it! Like most others working in the EUC space, I’ve become accustom to leveraging Carl Webster’s fine collection of documentation scripts to provide a basis of key configuration documentation, both as part of project completion and also as a BAU activity (how many people can say that their documentation is truly up to date?).

Recently I’ve been spending some time extending the coverage of the NetScaler Documentation Script to cover more customer deployment scenarios. While doing this NetScaler MAS (Management and Analytics System) has been released and is becoming a standard feature of customer deployments. This has it’s own configuration separate from the NetScaler’s themselves so again requires a level of documentation as part of a customer handover.

For those of you not familiar with MAS, there’s a great overview from Al Taylor at CloudDNA here – in short, it’s largely free although if you want Analytics on more than 30 vServers you will require additional licensing, however provides some fantastic capabilities around fleet and configuration management for Citrix NetScaler (VPX, CPX, MPX, SDX), CloudBridge and SD-WAN.

I’m pleased to make available a documentation script for NetScaler MAS! The Script itself is based on Carl Webster‘s script template and leverages the Nitro functions written and created by Iain Brighton and Barry Schiffer. As the script is based on Carl’s template the output will be familiar to those of you used to using his collection of documentation scripts.

In this Version 1 release, the focus is on the core configuration of the platform, configuration jobs and stylebooks. Documentation of orchestration components will be added in subsequent versions.

The Script uses Nitro API to read (and ONLY read) your configuration – no modifications to configuration are made through the use of the distributed script.

Where can I download the script?

Carl Webster has kindly agreed to host the script alongside the many others in his collection, and to offer the greatest accessibility it can be downloaded from his download section here:

Important Notice:

The script is provided AS IS without warranty of any kind. The author further disclaims all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The entire risk arising out of the use or performance of the script remains with you. In no event shall its authors, or anyone else involved in the creation, production, or delivery of the script be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the script, even if the author has been advised of the possibility of such damages, rising out of the use of or inability to use the script.

What’s in Version 1.0?

This version includes:

– MAS System Configuration
– Basic Configuration
– System Administration Settings
– Licensing
– Notification Settings
– SNMP Configuration
– Authentication Settings
– Device Profiles
– Managed Instances
– Instance Groups
– Event Management
– Configuration Templates
– DataCenters/IP Blocks
– Stylebooks
– Analytics Settings


Any feedback is welcome – if there are scenarios you are using MAS for that is not covered by the script, let me know! Equally, if you spot any bugs I’ll endeavour to get them fixed ASAP.

Feedback can be provided either using the comments below, or ping me on Twitter @andymc84

Happy Documenting!