• Citrix NetScaler Documentation Script Version 4.0

    September 5, 2017

    NetScaler, PowerShell

    Barry Schiffer and Iain Brighton are pleased to release Version 4.0 of the NetScaler documentation script.

    Citrix NetScaler documentation script version 4.0

    #Version 4.0 31-Aug-2017

    The script is now fully compatible with NetScaler 12.0 released in July 2017

    • Fixed NetScaler SSL connections
    • Added SAML Authentication policies
    • Updated GSLB Parameters to include late 11.1 build enhancements
    • Added Support for NetScaler Clustering
    • Added AppExpert
      • Pattern Sets
      • HTTP Callouts
      • Data Sets
    • Numerous bug fixes

    Because Barry’s Version 4.0 of the script uses the Nitro API, Barry asked me to only release a Signed version of the script. Please only use the script when the signed script is validated just so you know the script has not been altered.

    As the documentation script only reads the information there is no risk in using the script. However, we advise using a read only account for the script, according to security best practices its common sense to use least privileges for service accounts.

    You can always find the most current script by going to https://carlwebster.com/where-to-get-copies-of-the-documentation-scripts/


    Webster, Barry, and Iain

    About Carl Webster

    Webster is a Sr. Solutions Architect for Choice Solutions, LLC and specializes in Citrix, Active Directory and Technical Documentation. Webster has been working with Citrix products for many years starting with Multi-User OS/2 in 1990.

    View all posts by Carl Webster

    to “Citrix NetScaler Documentation Script Version 4.0”

    1. Eaglan Kurek Says:

      Hi Carl,

      Found a bug in version 4.10 when connecting using SSL; the function “Get-vNetScalerObjectCount” always connects with http://

      The $Uri line needs to be replaced with:
      if ($script:nsSession.UseNSSSL) { $protocol = ‘https’; }
      else { $protocol = ‘http’; }
      $Uri = ‘{0}://{1}/nitro/v1/{2}/{3}?count=yes’ -f $protocol, $script:nsSession.Address, $Container.ToLower(), $Object.ToLower();


      • Carl Webster Says:

        I have sent your comment on to Andrew who is helping to maintain the script and who did the work on 4.10.



        • Eaglan Kurek Says:

          Ok, found anther one. Iteration over the Content Switch policies wasn’t working. This code fixes the issue:

          ## IB – Iterate over all Content Switch bindings (uses new function)
          foreach ($CSbinding in $csvserverbindings) {

          $lb = $CSbinding.targetlbvserver;
          $csvpolicyname = $CSbinding.policyname;
          $cspolicy = Get-vNetScalerObject -ResourceType cspolicy -Name $csvpolicyname;
          $csvactionname = $cspolicy.action;
          $csaction = Get-vNetScalerObject -ResourceType csaction -Name $csvactionname;
          $priority = $CSbinding.priority;
          $rule = $cspolicy.rule;

          if ([String]::IsNullOrWhiteSpace($lb)) { $lb = $csaction.targetlbvserver }

          ## IB – Add each Content Switch binding with a policyName to the array
          $ContentSwitchPolicies += @{
          Policy = $csvpolicyname;
          Action = $csvactionname;
          Priority = $priority;
          Rule = $rule;
          LB = $lb;


    2. Steffen Leissner Says:

      Hello Carl,

      would you send me the script that works with the ns.conf too. Sometime the admin desktops havn’t Office installed.

      Thanks in advance


    3. Kitson Says:


      Would you please send me the updated script that works with ns.conf. I see you have an updated one that works with MS Word 2016. I understand it needs testing. Thanks!


    4. Sven Albert Says:

      Hi Carl,
      I have a strange Problem with Script Version 4.
      We are using NS 12.0.56 and the Script starts perfectly, but after the advanced Features section, the word document is empty, only the Headlines are there. No Errors reported while the script is running. Du you have any ideas?
      Thanks and regards


    5. kitson Says:

      Can this still be ran against the ns.conf file?


      • Carl Webster Says:

        No, you have to use an older version of the script.



        • Eric Smith Says:


          But the older versions do not support the later versions of Word. Most of us do the documentation after we have left the customer and no longer have access to the devices. Which is why using the ns.conf was so nice. Any ideas?




          • Carl Webster Says:

            I have sent you an updated version of the last script to support the ns.conf file.



            • David Taig Says:

              Carl, can you also please send updated version of the lastest script to support the ns.conf file. Thanks David..

            • Carl Webster Says:

              Script has been sent. Remember, it is a script that needs testing. It is not ready for release.


    6. ounet Says:

      Hi, thanks for the scripts. I’m face off problem. In my admin tools I do not have and can not install word. Does it existe a way to use the script like the way that your storefront script works ? regards


    7. Serge Says:

      How do i find the page on your website on how to configure netscaler gateway with storefront or WI. you are really a genius. second carl i’ve seen with the best citrix knowledge. Carl Starlhood is one. I have never configured one and i am new to netscaler. a picture with all the steps would be appreciated.


    8. Ronald Says:

      Great script! Had to change one line in the script to get the output working; (the proces would otherwise hang).

      $Script:Word.Visible = $True

      Works perfectly now!


      • Carl Webster Says:

        Doing so will slow the script down by an extreme amount of time. I have never heard of anyone needing to do this to any of the documentation scripts in almost 400,000 downloads.



    Leave a Reply