xawen/prtg-netscaler

NetScaler sensors for PRTG

PRTG-NetScaler

A collection of PRTG scripts to monitor key metrics and status of NetScaler health.

This sensor library relies on the NetScaler PowerShell module written by Brandon Olin.

Discussion

https://itrandomness.com/2018/01/monitoring-netscaler-with-prtg/

Included Scripts

• NetScaler-AppliancePerformance.ps1 - Monitor general NetScaler perfomance stats.
  • CPU utlization
  • Packet engine CPU utilization
  • Management engine CPU utilization
  • Disk usage
  • Memory usage
  • Network throughput (RX/TX)
  • SSL transactions per second
• NetScaler-AllvServer-State.ps1 - Monitor state and health of all instances of all vServer types.
  • Health % for each vServer
  • State (Up, down, maint) for each vServer
  • Note: includes Load Balancing, AAA, VPN (Gateway) and Content Switch vServers
• NetScaler-LBvServer-State.ps1 - Monitor state and health of all instances of Load Balancer vServers.
  • Health % for each vServer
  • State (Up, down, maint) for each vServer
• NetScaler-CertExpiration.ps1 - Monitor days until expiration for all SSL server certificates.
  • Days until next certificate expiration date
  • Days until expiration for each server type certificate
• NetScaler-ConfigSavedState.ps1 - Monitor for unsaved configuration changes.
  • Unsaved configuration change status
  • Time since changes were saved

Configuration

1. On the PRTG Server open a Powershell (x86) prompt as admin and run:
   • Install-Module -Name NetScaler -scope AllUsers
   • Set-ExecutionPolicy Unrestricted
   • Note: This MUST be done in the (x86) version of powershell
2. Create a user on the NetScaler with the read-only Command Policy
3. Copy all .ps1 files to C:\Program Files (x86)\PRTG Network Monitor\Custom Sensors\EXEXML
   • Directory may vary with PRTG install path
4. Copy all .ovl files to C:\Program Files (x86)\PRTG Network Monitor\lookups\custom
   • Directory may vary with PRTG install path
5. In PRTG go to Setup > Administrative tools:
   • Reload lookups
   • Restart core server (optional, run if PRTG has issues finding the script)
6. Add a NetScaler device in PRTG. Set the hostname or IP to the NSIP address.
7. Edit your NetScaler device in PRTG and set the Linux credentials to the new read only account
8. Add a new EXE/Script Advanced type sensor to your NetScaler device
9. Set the following options on the sensor
   • Name - Set a descriptive name
   • EXE/Script - Choose the desired script
   • Parameters - Enter: %host %linuxuser %linuxpassword
10. Select continue

Notes

• If you have IP Reputation enabled, the NetScaler will also update the reputation database ever 5 minutes (default). When this happens, the "Last Config Changed Time" time will be updated. This will cause the "Time since changes were saved" counter in NetScaler-ConfigSavedState.ps1 to be inaccurate.

Screenshots

prtg-netscaler's Issues

No exception handling leads to generic error messages

The scripts do not catch any exceptions. This can be implemented by adding try-catch-blocks where applicable. Since exception are not caught any exceptional situation might cause the script to fail and have PRTG display a very generic error message: "XML: The returned XML does not match the expected schema. (code: PE233) -- JSON: The returned JSON does not match the expected structure (Invalid JSON.). (code: PE231)".

PRTG SpeedSize reference uses unsupported plurals

https://github.com/xawen/PRTG-NetScaler/blob/master/NetScaler-AppliancePerformance.ps1#L77-L89

The SpeedSize values there are in plurals. PRTG's reference materials on the subject don't appear to support plurals:
https://www.paessler.com/manuals/prtg/custom_sensors

CPU stat issue

Latest prtg and netscaler 11.1
All works fine but for CPU, Packet and Management CPU, PRTG shows only 0 for all of them while this is the result i get back from the script. Really weird.... Any idea what could be wrong?

<result> <channel>CPU Usage</channel> <value>0</value> <unit>Percent</unit> </result> <result> <channel>Packet CPU Usage</channel> <value>0.400000</value> <unit>Percent</unit> </result> <result> <channel>Management CPU Usage</channel> <value>2.800000</value> <unit>Percent</unit> </result> <result>
Btw, thanks these great scripts!

Edit: your screenshots are showing the same issue. 0% for all 3 cpu counters