network Integration
citrix-netscaler-appliance (en)


ServicePilot network-citrix-netscaler-appliance


# Citrix NetScaler MPX Appliance

Overview

This package is designed to monitor a Citrix NetScaler MPX appliance using SNMP.

Description

Based on an SNMP collection, this package automatically configures the ServicePilot Manager to collect statistics from the Citrix NetScaler MPX appliance in terms of:

  • CPU
  • Memory
  • Network Interfaces (will be automatically discovered)
  • vServers (will be automatically discovered)

Requirements

  • SNMP service must be installed, configured and started on the targeted Citrix NetScaler Appliance (Security: read-only SNMP community and allowed host must be set).

  • Network Flows - It is necessary to ensure network connectivity between ServicePilot and the monitored device. In case of a network infrastructure with a firewall, all of the following flows must be opened:

    • UDP/161 (SNMP): Between ServicePilot Manager and Citrix NetScaler Appliance
    • ICMP/Echo Request (Ping): Between ServicePilot Manager and Citrix NetScaler Appliance
    • UDP/162 (SNMP Trap): (Optional) Between Citrix NetScaler Appliance and ServicePilot Agent
  • ServicePilot Requirements

    • ServicePilot Manager minimum version: 8.5

Installation

Before adding a resource to monitor, make certain that all pre-requisites are in place and if a ServicePilot Agent is required, that it is communicating correctly with the ServicePilot Manager. Resources can be added to ServicePilot configuration in a number of ways:

Add resource using Views Configuration web interface

  1. As an administrative user of ServicePilot, open the ServicePilot web interface.
  2. Navigate to Administration. The Configuration > Views web page will open.
  3. Click on the view in which to place the new resource in the Views hierarchy on the left of the interface. The View editor section will show the existing view contents.
  4. From the Packages list on the right of the interface, click and drag the network-citrix-netscaler-mpx package into the View editor and let go.
  5. The Package properties dialog box will open to allow resource configuration.
  6. Click OK to close the Package properties dialog box. Note that the dialog box will not close if required parameters are not set.
  7. Click Save to apply the new resource to ServicePilot configuration.

Add resource by changing servicepilot.conf configuration file

Resources can be added to ServicePilot configuration by directly editing the servicepilot.conf or other included YAML configuration files. The ServicePilot web interface can be used to make these changes and apply them to the running configuration.

  1. As an administrative user of ServicePilot, open the ServicePilot web interface.
  2. Navigate to Administration.
  3. Navigate to Configuration > Edit configuration.
  4. Expand the configuration to find the provisioning: and then packages: section of the view in which the new resource will be placed.
  5. Add the example package configuration line below.
  6. Click on the green - package: word to open then Package properties dialog box to allow resource configuration.
  7. Click OK to close the Package properties dialog box. Note that the dialog box will not close if required parameters are not set.
  8. Click Save to apply the new resource to ServicePilot configuration.

Example:

- package: "network-citrix-netscaler-mpx;;;;;;;;RESOURCENAME;POLICIES;IPADD;ICMP;SystemEnable;InterfaceEnable;DiskEnable;HaEnable;AclEnable;PrbEnable;AaaEnable;IPv6Enable;VPNSSLEnable;NATEnable;RNATEnable;RNAT_IP_Addr_Ignored;RNAT_IP_Addr_Allowed;FirewallEnable;PerProfileEnable;Profiles_Ignored;Profiles_Allowed;LLDPEnable;LLDP_Ports_Ignored;LLDP_Ports_Allowed;VserverEnable;vServers_Ignored;vServers_Allowed"

Key field notes

  1. In General tab, use Policies to specify SNMP parameters and thresholds

  2. Basic Parameters tab:

    1. IP address: Specify the IP address, host name or FQDN for the Citrix NetScaler Appliance, as resolvable by the machine on which ServicePilot Manager is running
  3. System Options tab:

    1. ICMP: Set it on to get Ping status.
    2. SystemEnable: Set it on to get statistics for system performance.
    3. InterfaceEnable: Set it on to get details about interfaces.
    4. DiskEnable: Set it on to get details about disks.
    5. HaEnable: Set it on to get statistics for high-availability feature.
    6. AclEnable: Set it on to get statistics for ACL feature.
    7. PrbEnable: Set it on to get statistics for PRB feature.
    8. AaaEnable: Set it on to get statistics for AAA feature.
    9. IPv6Enable: Set it on to get statistics for IPv6 feature.
    10. VPNSSLEnable: Set it on to get statistics for VPN SSL feature.
    11. NATEnable: Set it on to get statistics for NAT feature.
    12. VPNSSLEnable: Set it on to get statistics for VPN SSL feature.
  4. Feature Options tab:

    1. AclEnable: Set it on to get statistics for ACL feature.
    2. PrbEnable: Set it on to get statistics for PRB feature.
    3. FirewallEnable: Set it on to get statistics for firewall feature.
    4. VserverEnable: Set it on to get statistics for all vServers.

Notes

MIBs Used:

  • NS-ROOT-MIB
  • RFC1213-MIB2