ZenPack:Citrix NetScaler (Commercial)

From Zenoss Wiki
Revision as of 17:46, 11 March 2016 by Chet Luther (Talk | contribs)$7

(diff) ← Older revision | Approved revision (diff) | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Note: This ZenPack is available in commercial versions of Zenoss. Click here to request more information about this commercial ZenPack. Click here to see all commercial ZenPacks.

Zenoss, Inc.
ZenPack name

Devices Monitored:

Citrix NetScaler (Commercial) ZenPack

Monitoring for Citrix NetScaler VPX devices.


The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.


This ZenPack is included with commercial versions of Zenoss and enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.


Version 1.0.6- Download
Released on 2016/03/11
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.0.x


This ZenPack provides support for monitoring Citrix NetScaler. Monitoring is performed through a NetScaler VPX using SNMP.



The features added by this ZenPack be summarized as follows. They are each detailed further below.

  • Initial discovery and continual synchronization of relevant components.
  • Performance monitoring.
  • Event management.
  • Operational reports.


The following components will be automatically discovered through the NetScaler address you provide. The properties and relationships will be continually maintained by way of SNMP Walks to the NetScaler device.

Virtual Servers
Attributes: State, Health, Services Up / Bound
Relationships: Services, Service Groups
Attributes: State
Relationships: Virtual Servers, Servers, Service Groups (optional)
Service Groups
Attributes: State
Relationships: Services
Attributes: State
Relationships: Services, Service Groups
Ethernet Interfaces
Attributes: MAC Address, Operational Status, Admin Status
Relationships: None
Attributes: MAC Address
Relationships: None

Performance Monitoring

The following metrics will be collected every 5 minutes by default. Any otherNetScaler metrics can also be collected by adding them to the appropriate monitoring template.

Virtual Servers
Service Groups
Virtual Servers
State: Down, Unknown, Busy, Out of Service (OOS), Transition to OOS, Up
Current Connections: client, servers
Total Requests/Responses: requests, responses
Total Requests/Responses (bytes): requests, responses
Total Received/Sent (packets): received, transmitted
Current Services States: summation of service states
Hits vs Misses: hits, misses
Rates of Bytes: received, transmitted, requested
State: Down, Unknown, Busy, Out of Service (OOS), Transition to OOS, Up
Max Requests per Connection: Max
Avg Transaction Time: Average
Service Connections: Established, Active, Current
Total Requests vs Responses: Requests, Responses
Total Requests vs Responses (Bytes): Requests, Responses
Total Packets Received vs Sent: Received, Transmitted
Request Rate: Rate: Bytes Rate: Received, Transmitted
Total Clients vs Servers: Clients, Servers, Max
Active Transactions: Transactions
Service Groups
State: Disabled, Enabled;Servers: State: Down, Unknown, Busy, Out of Service (OOS), Transition to OOS, Up
Ethernet Interfaces
Utilization: Received, Transmitted
Throughput (Data): Received, Transmitted
Throughput (Packets): Rx'd/Tx'd Unicast, Rx'd/Tx'd Broadcast, Rx'd/Tx'd Multicast
Errors: Rx'd/Tx'd Errors, Rx'd/Tx'd Discards
Total Packets: Received, Transmitted, Dropped, Broadcast
Total Bytes: Received, Transmitted

Event Management

The following event classes and their subclasses will be continually collected and passed into the Zenoss event management system.

  • Alarm
  • Event
  • ExtendedEvent
  • EventEx

Various information encoded in these event classes will be used to automatically determine as best as possible the following Zenoss event fields.

Standard Zenoss Event Fields
  • device (set to NetScaler device in the /Network/NetScaler device class)
  • component
  • summary
  • severity
  • eventClassKey (for mapping specific event types)
  • eventKey (for de-duplication and auto-clear fingerprinting)

Events collected through this mechanism will be timestamped based on the time they occurred within NetScaler. Not by the time at which they were collected.

Installed Items

Installing this ZenPack will add the following items to your Zenoss system.

Device Classes
  • /Network/NetScaler
Modeler Plugins
  • snmp.NetScaler
Monitoring Templates
  • NetScalerVirtualServers (in /Network/NetScaler)
  • NetScalerServices (in /Network/NetScaler)
  • NetScalerServiceGroups (in /Network/NetScaler)
  • NetScalerServers (in /Network/NetScaler)
  • NetScalerEthernetInterfaces (in /Network/NetScaler)
  • NetScalerVLANs (in /Network/NetScaler)


If any issues are encountered with the functionality offered by this ZenPack, the following checklist should be followed to verify that all configurations are correct.

Configuration Checklist

  1. Verify that Zenoss has been fully restarted after the ZenPack was installed.
  2. Verify that the NetScaler's address, username and password are correct.
  3. Verify that the NetScaler is connecting to the proper SNMP community (zProperty: zSnmpCommunity).
  4. Verify that the Zenoss collector server to which the endpoint device is assigned has network connectivity through any firewalls to the endpoint address on port 443/tcp (https).
  5. Check the logs.

Known Issues

The following issues have been identified in the most recent release of this ZenPack.

(ZEN-9476) The first set of data for the components - services and virtual servers take 30 minutes
After modeling NetScaler ZP, it presents the first set of data for Virtual LANs and Ethernet interfaces within usual 15 minutes. However, it takes 30 minutes to present the data for other components. There is no recommended work-around at this time.


There is no service impact or root analysis available for the netscaler device.


  • Fix potential "Empty or invalid id specified" modeling error.
  • Fix change detection on automatic cycle modeling. (ZEN-22442)
1.0.5 (2016-01-20)
  • Licensing fixes. No functional changes.
1.0.4 (2014-12-08)
  • Allow toggling of monitoring for all component types. (ZEN-14859)
1.0.3 (2014-11-06)
  • Add basic virtual server impact.
  • Replace "Ethernet Interfaces" with more functional standard "Interfaces".
1.0.2 (2014-04-04)
  • Prevent components from periodically being removed by modeling. (ZEN-10499)
1.0.1 (2014-03-03)
  • Fix potential zenchkrels "vlan" error. (ZEN-10424)
1.0.0 (2013-12-19)
  • Initial release.


Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.zenoss.NetScaler-*.egg
  4. Restart these services:
    $ zenoss restart


Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus