The SNMP management information base (MIB) defines network data available for SNMP monitoring. The MIB file is located in the <pf_install>/pingfederate/SNMP directory. The MIB describes the object identifiers that PingFederate uses to communicate information through SNMP. These identifiers are globally unique and managed by the Internet Assigned Numbers Authority (IANA).

SNMP supports Gets and Traps.

Gets
A Get is a request for status information sent by a network-management console to an SNMP agent. Embedded within each PingFederate server is an SNMP agent that brokers the communication between the management console and the PingFederate runtime engine.
PingFederate responds to two SSO and SLO types of Get requests:
  • The total number of transactions that the server instance has processed since installation
  • The total number of failed transactions that the server instance has encountered since installation
In addition, because PingFederate is built within an existing Jetty framework, Gets include a variety of server information available via Jetty-standard Managed Beans (MBeans). A detailed list of this information is provided in the MIB file in the <pf_install>/pingfederate/SNMP directory. (For more information about MBeans, see Runtime monitoring using JMX).
Note:

If the host operating system does not allow the SNMP agent to bind to privileged ports (those below 1024), consult your operating system's documentation on how to work around this limitation or change the default port 161 to a port above 1023.

Traps
A Trap is a spontaneous communication from an agent to a network-management console. PingFederate generates a Trap at regular intervals, the server “heartbeat.” Each Trap contains the amount of time the server instance has been running since its most recent start-up.

Configure access to SNMP monitoring on the System > Runtime Reporting screen. As needed, you may configure both Gets and Traps.

  • Optional: Enable Gets.
    1. Select the Respond to Get Requests check box.
    2. Modify the Local Agent Port and the Community Name field values as needed.
  • Optional: Enable Traps.
    1. Select the Generate Traps check box.
    2. Provide the required information for your network-management console and modify the "Heartbeat" Interval field value as needed.
    3. Click Test SNMP Configuration to send a single Trap to your network-management console and verify the result.
  • To keep your changes, click Save.
  • To discard your changes, click Cancel.