Product Documentation

SNMP monitoring

You can enable SNMP monitoring in XenMobile Server to allow monitoring systems to query and obtain information on your XenMobile nodes. The queries use parameters, such as Processor Load, Load Average, Memory Usage, and Connectivity. For more information about SNMP v3, such as authentication and encryption specifications, see the official SNMP documentation for RFC 3414.

Note:

SNMP v3 monitoring is supported with XenMobile Server 10.8 and later.

You can use various monitoring applications that support SNMP monitoring, such as SCOM. For details about configuring SCOM, see this Citrix Support Knowledge Center article.

Prerequisites

Configure the following TCP ports:

  • Port 161 (UDP): Used for SNMP traffic using UDP protocol. The source is the SNMP manager and the destination is XenMobile.
  • Port 162 (UDP): Used for sending SNMP trap alerts to SNMP manager from XenMobile. The source is XenMobile and the destination is the SNMP Manager.

For more information about XenMobile ports configuration, see Port requirements.

To see an architectural diagram of an on-premises XenMobile deployment that includes SNMP, see Reference Architecture for On-Premises Deployments.

The general steps for setting up SNMP are as follows.

  1. Add users: The users inherit the permission to receive traps and monitor the XenMobile Server.
  2. Add an SNMP Manager to receive traps: Traps are alerts that XenMobile generates when your XenMobile node exceeds the maximum user-defined threshold.
  3. Configure the SNMP manager to interact with XenMobile: XenMobile Server uses certain management information bases (MIBs) to perform operations. You download the MIBs from the Settings > SNMP Configuration page in the XenMobile console. You then import the MIBs into the SNMP manager by using a MIB importer.

    Note:

    Every SNMP manager has its own MIB importer.

  4. Enable traps: You enable traps within the XenMobile console and define the intervals and thresholds based on your environment.
  5. View traps within the third-party SNMP manager: To view traps, check the SNMP manager. In some managers, however, you can configure settings to enable notifications outside of the manager. You can configure notifications to appear, for example, in email.

You can generate the following traps from XenMobile.

Trap name Monitoring object ID (OID) Description
Processor load .1.3.6.1.2.1.25.3.3.1.2 Monitors the CPU load of the system for the user-defined interval. If the load exceeds the custom threshold value, XenMobile generates the SNMP trap.
Load average for one minute .1.3.6.1.4.1.2021.10.1.5.1 Monitors the average system load over a period of one minute for the user-defined interval. If the load average exceeds the custom threshold value, XenMobile generates the SNMP trap.
Load average for five minutes .1.3.6.1.4.1.2021.10.1.5.2 Monitors the average system load over a period of five minutes for the user-defined interval. If the load average exceeds the custom threshold value, XenMobile generates the SNMP trap.
Load average for 15 minutes .1.3.6.1.4.1.2021.10.1.5.3 Monitors the average system load over a period of 15 minutes for every user-defined interval. If the load average exceeds the custom threshold value, XenMobile generates the SNMP trap.
Total available memory .1.3.6.1.4.1.2021.4.11 Monitors the available memory for every user-defined interval. If the available memory falls below the custom threshold value, XenMobile generates the SNMP trap. Note: The total available memory includes both RAM and swap memory (virtual memory). To retrieve total swap memory, you can query using SNMP OID .1.3.6.1.4.1.2021.4.3. To retrieve available swap memory, you can query using SNMP OID .1.3.6.1.4.1.2021.4.4
Total used disk storage .1.3.6.1.4.1.2021.9.1.9.1 Monitors the system disk storage for every user-defined interval. If disk storage exceeds the custom threshold value, XenMobile generates the SNMP trap.
Java heap memory usage .1.3.6.1.4.1.3845.5.1.2.4.0 Monitors the Java virtual machine (JVM) heap memory usage of XenMobile for every user-defined interval. If the usage exceeds the custom threshold value, XenMobile generates the SNMP trap.
Java metaspace usage .1.3.6.1.4.1.3845.5.1.2.5.0 Monitors the Java metaspace usage of XenMobile for every user-defined interval. If the usage exceeds the threshold value, XenMobile generates the SNMP trap.
LDAP connectivity .1.3.6.1.4.1.3845.5.1.1.18.1.0 Monitors the connectivity between LDAP server and the XenMobile node for every user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
DNS connectivity .1.3.6.1.4.1.3845.5.1.1.18.2.0 Monitors the connectivity between DNS server and the XenMobile node for every user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Google Store server connectivity .1.3.6.1.4.1.3845.5.1.1.18.3.0 Monitors the connectivity between Google Store server and the XenMobile node for every user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Windows Phone Store connectivity .1.3.6.1.4.1.3845.5.1.1.18.4.0 Monitors the connectivity between Windows Phone Store server and the XenMobile node for every user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Windows Tab Store connectivity .1.3.6.1.4.1.3845.5.1.1.18.5.0 Monitors the connectivity between Windows Tab Store server and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Windows Security Token server connectivity .1.3.6.1.4.1.3845.5.1.1.18.6.0 Monitors the connectivity between Windows Security Token server and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Windows Notification server connectivity .1.3.6.1.4.1.3845.5.1.1.18.7.0 Monitors the connectivity between Windows Notification server and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Apple Push Notification server (APNs) connectivity .1.3.6.1.4.1.3845.5.1.1.18.8.0 Monitors the connectivity between APNs and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Apple Feedback server connectivity .1.3.6.1.4.1.3845.5.1.1.18.9.0 Monitors the connectivity between Apple Feedback server and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Apple Store server connectivity .1.3.6.1.4.1.3845.5.1.1.18.10.0 Monitors the connectivity between Apple Store server and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
XenMobile database connectivity .1.3.6.1.4.1.3845.5.1.1.18.11.0 Monitors the connectivity between XenMobile Database and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Google Cloud Messaging server connectivity .1.3.6.1.4.1.3845.5.1.1.18.12.0 Monitors the connectivity between Google Cloud Messaging server and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
Citrix License Server connectivity .1.3.6.1.4.1.3845.5.1.1.18.13.0 Monitors the connectivity between Citrix License Server and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
NetScaler Gateway connectivity .1.3.6.1.4.1.3845.5.1.1.18.15.0 Monitors the connectivity between the NetScaler Gateway and XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
XenMobile inter-node connectivity .1.3.6.1.4.1.3845.5.1.1.18.16.0 Monitors the connectivity between the XenMobile cluster nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.
XenMobile Tomcat node service connectivity .1.3.6.1.4.1.3845.5.1.1.18.17.0 Monitors the connectivity between XenMobile Tomcat node service and the XenMobile nodes for the user-defined interval. If connectivity fails, XenMobile generates the SNMP trap.

For the best server performance when configuring SNMP thresholds, keep in mind the following factors:

  • Frequency of calls
  • Trap data to be collected and the threshold checks
  • The inter-node communication mechanism
  • Frequency of connectivity checks
  • Timeouts on any failure during the checks

To add SNMP users

SNMP users interact with SNMP managers and receive traps.

  1. In the XenMobile console, click the gear icon in the upper-right corner. The Settings page appears.

  2. Under Monitoring, click SNMP Configuration. The SNMP Configuration page appears.

    Image of SNMP Configuration

  3. Under SNMP Monitoring Users, click Add.

  4. In the Add SNMP Monitoring User dialog box, configure the following settings:

    Image of SNMP Configuration

    User Name: The user name used to log on to the SNMP manager. Although you can use alphanumeric characters, underscore and hyphens, you cannot use spaces and other special characters for your user name.

    Note:

    You cannot add the user name “xmsmonitor” because XenMobile reserves the name for internal use.

    Authentication Protocol:

    • SHA (Recommended)
    • MD5

    Authentication Password: Type an 8- to 18-character password. You can include alphanumeric and special characters.

    Privacy Protocol:

    • DES
    • AES 128 (Recommended)

    Privacy Password: Type an 8- to 18-character password. You can include alphanumeric and special characters.

To add an SNMP manager

  1. Under SNMP Managers, click Add.

  2. In the Add SNMP Manager dialog box, configure the following settings:

    Image of SNMP Configuration

    Server IP Address: Type the IP address of the SNMP manager.

    Port: Change the port number if needed. Default is 162.

    SNMP User Name: Select the name of a user with access to the manager.

To enable and configure SNMP traps

To help determine the appropriate trap settings for your environment, see Scalability and performance. For example, to monitor the XenMobile Load Average for one minute, you can enable Load Average for 1 Minute and provide a threshold value. If the XenMobile Server Load Average for 1 Minute exceeds the specified threshold, you receive a trap in the configured SNMP managers.

  1. To enable individual traps, do one of the following:

    • Select the check box next to the parameter and then, click Enable.
    • To enable all the traps in the list, select the check box at the top and then click Enable.
  2. To edit a trap, select the parameter and then click Edit.

  3. In the Edit SNMP Trap Details dialog box, you can edit the threshold values for individual traps.

    Image of SNMP Configuration

    Trap Name: The name of the trap. You cannot edit this field.

    Interval (in seconds): The range allowed is from 60 to 86400 (24 hours).

    Threshold: You can change the threshold only for the following traps:

    • Processor Load
    • Load Average for 1 Minute
    • Load Average for 5 Minutes
    • Load Average for 15 Minutes
    • Total Available Memory
    • Total Used Disk Storage
    • Java Heap Memory Usage
    • Java Metaspace Usage

    Status: Select ON to enable SNMP monitoring for the trap. Select OFF to disable monitoring.

    For more helpful information on monitoring XenMobile using SNMP, see this blog post.

SNMP monitoring