TRAP/INFORM notification

pysnmp.hlapi.sendNotification(snmpEngine, authData, transportTarget, contextData, notifyType, *varBinds, **options)

Creates a generator to send one or more SNMP notifications.

On each iteration, new SNMP TRAP or INFORM notification is send (RFC 1905#section-4,2,6). The iterator blocks waiting for INFORM acknowledgement to arrive or error to occur.

Parameters:

  • snmpEngine (SnmpEngine) – Class instance representing SNMP engine.

  • authData (CommunityData or UsmUserData) – Class instance representing SNMP credentials.

  • transportTarget (UdpTransportTarget or Udp6TransportTarget) – Class instance representing transport type along with SNMP peer address.

  • contextData (ContextData) – Class instance representing SNMP ContextEngineId and ContextName values.

  • notifyType (str) – Indicates type of notification to be sent. Recognized literal values are trap or inform.

  • *varBinds (tuple of OID-value pairs or ObjectType or NotificationType) – One or more objects representing MIB variables to place into SNMP notification. It could be tuples of OID-values or ObjectType class instances of NotificationType objects.

    SNMP Notification PDU includes some housekeeping items that are required for SNMP to function.

    Agent information:

    • SNMPv2-MIB::sysUpTime.0 = <agent uptime>
    • SNMPv2-SMI::snmpTrapOID.0 = {SNMPv2-MIB::coldStart, …}

    Applicable to SNMP v1 TRAP:

    • SNMP-COMMUNITY-MIB::snmpTrapAddress.0 = <agent-IP>
    • SNMP-COMMUNITY-MIB::snmpTrapCommunity.0 = <snmp-community-name>
    • SNMP-COMMUNITY-MIB::snmpTrapEnterprise.0 = <enterprise-OID>

    Note

    Unless user passes some of these variable-bindings, .sendNotification() call will fill in the missing items.

    User variable-bindings:

    • SNMPv2-SMI::NOTIFICATION-TYPE
    • SNMPv2-SMI::OBJECT-TYPE

    Note

    The NotificationType object ensures properly formed SNMP notification (to comply MIB definition). If you build notification PDU out of ObjectType objects or simple tuples of OID-value objects, it is your responsibility to provide well-formed notification payload.
Other Parameters:
 

**options –

  • lookupMib - load MIB and resolve response MIB variables at the cost of slightly reduced performance. Default is True.
Yields:
  • errorIndication (str) – True value indicates SNMP engine error.
  • errorStatus (str) – True value indicates SNMP PDU error.
  • errorIndex (int) – Non-zero value refers to varBinds[errorIndex-1]
  • varBinds (tuple) – A sequence of ObjectType class instances representing MIB variables returned in SNMP response.
Raises:

PySnmpError – Or its derivative indicating that an error occurred while performing SNMP operation.

Notes

The sendNotification generator will be exhausted immediately unless an instance of NotificationType class or a sequence of ObjectType varBinds are send back into running generator (supported since Python 2.6).

Examples

>>> from pysnmp.hlapi import *
>>> g = sendNotification(SnmpEngine(),
...                      CommunityData('public'),
...                      UdpTransportTarget(('demo.snmplabs.com', 162)),
...                      ContextData(),
...                      'trap',
...                      NotificationType(ObjectIdentity('IF-MIB', 'linkDown')))
>>> next(g)
(None, 0, 0, [])
>>>