• Citrix Application Delivery Controller (Formerly NetScaler) Documentation Script Version 4.30

    September 28, 2018

    NetScaler, PowerShell

    #Version 4.3 18-September-2018

    Added ability to export data on a workstation without Word installed and create the report on another workstation

    .EXAMPLE
    PS C:\PSScript > .\Citrix_ADC_Script_V4_3_Signed.ps1 -Export
    OR
    PS C:\PSScript > .\Citrix_ADC_Script_V4_3_Signed.ps1 -Offline

    Will run without MS Word installed and create an export of API data to create a configuration report on another machine. API data will be exported to C:\PSScript\ADCDocsExport\.

    .EXAMPLE
    PS C:\PSScript > .\Citrix_ADC_Script_V4_3_Signed.ps1 -Export -ExportPath “C:\ADCExport”
    OR
    PS C:\PSScript > .\Citrix_ADC_Script_V4_3_Signed.ps1 -Offline -OfflinePath “C:\ADCExport”

    Will run without MS Word installed and create an export of API data to create a configuration report on another machine. API data will be exported to C:\ADCExport\.

    .EXAMPLE
    PS C:\PSScript > .\Citrix_ADC_Script_V4_3_Signed.ps1 -Import

    Will create a configuration report using the API data stored in C:\PSScript\ADCDocsExport.

    .EXAMPLE
    PS C:\PSScript > .\Citrix_ADC_Script_V4_3_Signed.ps1 -Import -ImportPath “C:\ADCExport”

    Will create a configuration report using the API data stored in C:\ADCExport.

    If you have any feature requests, suggestions for enhancements or bugs to report, please feel free to contact me on twitter (@andymc84) or email (amccullough84@gmail.com)

    Thanks

    Andy

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

    Thanks

    Webster and Andy

    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

    5 Responses to “Citrix Application Delivery Controller (Formerly NetScaler) Documentation Script Version 4.30”

    1. Aaron Says:

      Thank you for writing a Netscaler script that can be run without Word (offline mode). This has always been a challenge for me as a lot of the time I need to run on systems without Word.

      Reply

    2. Mike Morrison Says:

      I can’t seem to get v.4.3 of the script to run. I’m running PowerShell 5.1 on Windows 7, trying to document a Citrix ADC running v.12.1.49.23.nc of the firmware. Regardless of whether I launch PowerShell as an administrator or not, I get the following error:

      Invoke-RestMethod : The resource you are looking for has been removed, had its name changed, or is temporarily unavailable.
      At C:\Users\mmorrison\Downloads\Citrix\Documentation PowerShell Scripts\Citrix NetScaler ADC V.4.30\Citrix_ADC_Script_v4_3_Signed.ps1:3048 char:25
      + $restResponse = Invoke-RestMethod @invokeRestMethodParams;
      + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      + CategoryInfo : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], WebException
      + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

      I’ve tried the -UseSSL switch, which helps a little: Instead of getting the error right after entering the NSIP, it waits until after I enter the “To:” e-mail address. Any help or insight would be appreciated.

      Thanks,
      Mike Morrison

      Reply

      • Carl Webster Says:

        I have let Andrew know of this comment. He should answer as soon as he can.

        Webster

        Reply

      • Andy McCullough Says:

        Hi Mike,

        I’ve replied via email with some more steps, but for anyone else with a similar issue:

        Just to clarify, the -UseSSL parameter is to use SSL for sending the output as an email attachment via an SMTP server, which is why you’re being prompted for From and To addresses. If you were looking to try using an SSL connection to the NetScaler then you would need to use the -UseNSSSL parameter.

        From what you’re describing the script is hitting the first point where it’s talking to the NetScaler and getting a 404 response back.

        Are you able to test a few things –

        If there’s a proxy server enabled on your workstation, try disabling it

        Check that if you browse to the NSIP you’re using in a browser you reach the NetScaler logon page

        In powershell try running Invoke-restmethod -uri http://yourNSIP/nitro/v1/config/login

        You should get back a “NITRO Login Failure” message – which is good if you do as you’re connecting OK to the NetScaler.

        Thanks,

        Andy

        Reply

    Leave a Reply