-
Citrix NetScaler Documentation Script Version 4.0
September 5, 2017
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/
Thanks
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 WebsterSubscribe
Subscribe to our e-mail newsletter to receive updates.
33 Responses to “Citrix NetScaler Documentation Script Version 4.0”
Leave a Reply
February 10, 2020 at 11:12 am
would be great to have some way to trim and cherry pick which sections to document, and which to skip.
there are nearly 15,000 lines of code , can you point the locations where something like that could be commented out ?
February 12, 2020 at 11:15 am
This is an excellent enhancement request. I will add it to my to-do list. I have this capability in several other scripts.
Webster
March 4, 2019 at 1:50 pm
When I run the script it stalls at
cmdlet Get-vNetScalerObjectCount at command pipeline position 1
Supply values for the following parameters:
Object:
Not sure what object to provide here.
May 10, 2019 at 11:12 am
Yep same here.
October 28, 2018 at 7:43 pm
I was looking for away to have this iterate through a list of IP addresses of NetScalers and have this create a new document for each, has anyone else done this? I was looking to have this as a task to create new documentation
February 7, 2019 at 8:19 pm
#MeToo! There would also require a means of programatically passing the full credentials (not just the UserName)…
August 27, 2018 at 9:39 pm
Carl, could you please send me an updated version of the lastest script to support the ns.conf file. Thanks a lot.
Manuel..
August 28, 2018 at 11:55 am
https://carlwebster.com/citrix-netscaler-documentation-script-version-2-60-beta/
Webster
August 13, 2018 at 10:02 am
Hi Carl,
How are you doing? Hope you are well! Please can you send me the script?
Thank You
Jay
August 22, 2018 at 12:46 pm
The 4.xx NetScaler/ADC scripts can be downloaded from the link in the article.
Webster
July 30, 2018 at 8:21 am
Hi Carl,
would you send me the script that works with the ns.conf too?
Thank you in advance
Marc
August 1, 2018 at 11:57 am
On its way.
Webster
July 3, 2018 at 3:33 pm
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();
July 3, 2018 at 3:37 pm
I have sent your comment on to Andrew who is helping to maintain the script and who did the work on 4.10.
Webster
July 4, 2018 at 10:41 am
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;
}
}
July 4, 2018 at 11:13 am
I have sent this comment also on to Andrew.
Webster
July 3, 2018 at 1:14 pm
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
Steffen
July 3, 2018 at 1:25 pm
Files have been emailed.
Webster
July 2, 2018 at 4:31 pm
Carl,
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!
July 2, 2018 at 5:10 pm
Files have been emailed.
Webster
May 24, 2018 at 8:27 am
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
Sven
June 1, 2018 at 12:23 am
I have a couple of people looking at this issue.
Webster
May 3, 2018 at 4:03 pm
Can this still be ran against the ns.conf file?
May 12, 2018 at 6:20 am
No, you have to use an older version of the script.
Webster
May 16, 2018 at 5:18 pm
Hello,
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?
Thanks,
-Eric
June 1, 2018 at 12:24 am
I have sent you an updated version of the last script to support the ns.conf file.
Webster
June 3, 2018 at 1:15 am
Carl, can you also please send updated version of the lastest script to support the ns.conf file. Thanks David..
June 3, 2018 at 12:07 pm
Script has been sent. Remember, it is a script that needs testing. It is not ready for release.
Webster
February 12, 2018 at 12:44 pm
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
February 1, 2018 at 10:58 am
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.
February 2, 2018 at 8:50 am
Sorry, I can spell NetScaler. THere are no NetScaler articles on my site. Sorry.
Webster
September 19, 2017 at 10:27 am
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!
September 23, 2017 at 12:13 pm
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.
Webster