This article describes how to enable and configure Simple Network Management Protocol (SNMP) settings for the Horizon Cloud Connector appliance. This configuration allows you to monitor key Horizon Cloud Connector events through a network management system.

To use this feature, you must be running Horizon Cloud Connector 2.0 or later.

How SNMP Monitoring Works with Horizon Cloud Connector

Horizon Cloud Connector supports monitoring through the use of SNMP traps which originate from the appliance when certain events occur. These traps notify the network management system of the trigger event or condition.

Note: Horizon Cloud Connector functions only as a trap emitter and does not support other SNMP operations, such as receiving a GET, GETBULK, or GETNEXT operation.

By default, the SNMP service is deactivated for the Horizon Cloud Connector. To use SNMP traps, you must first enable and configure the SNMP service for the appliance, as described later in this article.

Management Information Base (MIB) files contain the trap definitions, which define the information that can be provided by managed devices. The MIB files define managed objects, described by object identifiers (OIDs) and variables arranged in a hierarchy. You can download the required MIB files by using the link provided later in this article.

Horizon Cloud Connector Events That You Can Monitor with SNMP Traps

After you enable and configure the SNMP service for the appliance, Horizon Cloud Connector supports SNMP traps for the following events:

  • Sync failure of the Horizon subscription license, also known as the Horizon Universal License
  • Life-cycle events affecting the Horizon Cloud Connector configuration, such as:
    • Configuration or reconfiguration of the appliance to pair it with a Horizon pod
    • Update to a new Horizon Cloud Connector software version
    • Unplugging of the appliance from the Horizon pod

Any of these events triggers the emitting of an SNMP trap from the appliance to the network management system.

How to Configure SNMP Monitoring for Horizon Cloud Connector

The SNMP configuration process consists of the following high-level steps:

  • Step 1: Download the VMware MIB files for use by the network management system.
  • Step 2: In your network management system, configure the Horizon Cloud Connector engine ID.
  • Step 3: Enable and configure the SNMP service in the Horizon Cloud Connector configuration portal.

See the following sections for the details of each step.

Step 1: Download the VMware MIB Files and OIDs

The RFC 2578 standard of structure of management information (SMI) is the syntax used to write Management Information Base (MIB) files for specific products and functions. These MIB files are versioned independently of product and can be used to identify event types and event data related information.

To download these MIB files, go to VMware Knowledge Base (KB) article 1013445.

To download the object identifiers (OIDs) used by the MIB files, go to VMware KB article 2054359.

Step 2: Configure the Horizon Cloud Connector Engine ID in the Management System

During the SNMP enablement process, the Horizon Cloud Connector automatically generates a unique SNMP engine ID for use by your network management system. The engine ID is used with a hashing function to generate keys for authentication and encryption of SNMP v3 messages.

  1. Launch the Horizon Cloud Connector configuration portal by pointing your browser to https://<appliance IP>, where <appliance IP> is the IP address or FQDN of the appliance node.
  2. In the configuration portal, find the SNMP engine ID that appears under the Horizon Cloud Connector configuration status list.

    The following example screenshot shows an auto-generated SNMP engine ID as it appears in the configuration portal.


    Detail of SNMP engine ID on Horizon Cloud Connector configuration portal
  3. In your network management system, add the SNMP engine ID to the appropriate configuration page.

Step 3: Enable and Configure the Horizon Cloud Connector SNMP Service

You can access settings for the SNMP service through the Horizon Cloud Connector configuration portal.

  1. Launch the Horizon Cloud Connector configuration portal by pointing your browser to https://<appliance IP>, where <appliance IP> is the IP address or FQDN of the appliance node.
  2. At the top of the configuration portal, click Configure SNMP.

    The dialog box for the SNMP configuration appears. The following screenshot shows an example of the dialog box as it initially appears.


    SNMP configuration details dialog box in its initial default state
  3. Turn on the Enable SNMP toggle.
  4. Specify settings for the SNMP version, user name, and security level as described in the following table.
    Setting Description
    SNMP Engine ID This read-only setting displays the auto-generated SNMP engine ID for the Horizon Cloud Connector.
    SNMP Version This setting allows you to specify the version of SNMP that you want to use. This release supports SNMP v3 only.
    SNMPv3 USM User Configure the SNMPv3 User-based Security Model (USM) user who can access the SNMP monitoring information. The user name must be from 8 through 31 characters long and contain letters and numbers only.
    SNMPv3 Security Level

    Specify whether to use an optional authentication algorithm, with or without a privacy algorithm, for the SNMP service. Authentication is used to ensure the identity of users. Privacy allows for encryption of SNMP v3 messages to ensure confidentiality of data.

    Both authentication and privacy are optional. However, you must enable authentication to enable privacy.

  5. (Optional) If you specified a security level that includes authentication, configure the authentication details as described in the following table.
    Setting Description
    SNMPv3 Auth Algorithm Specify the authentication algorithm used to establish the identity of SNMP users.
    SNMPv3 Auth Password Configure the password required by the authentication algorithm to establish the identity of users. The authentication password must be from 8 through 31 characters long.
    Confirm Auth Password Re-enter the authentication password.
  6. (Optional) If you specified the security level that includes both authentication and privacy, configure the privacy details as described in the following table.
    Setting Description
    SNMPv3 Privacy Algorithm Specify the privacy algorithm used to encrypt SNMP messages.
    SNMPv3 Privacy Password Configure the password required by the privacy algorithm to generate an encryption key. The privacy password must be from 8 through 31 characters long.
    Confirm Privacy Password Re-enter the privacy password.
  7. Specify the details of the network management system that can receive SNMP traps from Horizon Cloud Connector, as described in the following table.
    Setting Description
    Receiver IP Specify the IP address of the network management system that can receive the SNMP traps.
    Receiver Port Specify the port number used by the network management system to receive the traps.
    Receiver Community String Enter the community string used by the network management system to validate that the received traps originate from the Horizon Cloud Connector.

    The following screenshot shows an example of the SNMP details dialog box with the settings configured.


    SNMP configuration details dialog box with settings configured
  8. When you have finished configuring settings for the SNMP service, save your changes.

Whenever you modify the configuration of the SNMP service, a coldStart system trap is generated. Whenever a Horizon Cloud Connector framework service restarts, a warmStart trap is generated and sent to the network management system.