TRAP/INFORM notification

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

Sends SNMP notification.

Based on passed parameters, prepares SNMP TRAP or INFORM message (RFC 1905#section-4.2.6) and schedules its transmission by twisted I/O framework at a later point of time.

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 –

Request options:

  • lookupMib - load MIB and resolve response MIB variables at the cost of slightly reduced performance. Default is True.
Returns:

deferred (Deferred) – Twisted Deferred object representing work-in-progress. User is expected to attach his own success and error callback functions to the Deferred object though addCallbacks() method.
Raises:

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

Notes

User success callback is called with the following tuple as its first argument:

  • 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.

User error callback is called with errorIndication object wrapped in Failure object.

Examples

>>> from twisted.internet.task import react
>>> from pysnmp.hlapi.twisted import *
>>>
>>> def success(args):
...     (errorStatus, errorIndex, varBinds) = args
...     print(errorStatus, errorIndex, varBind)
...
>>> def failure(errorIndication):
...     print(errorIndication)
...
>>> def run(reactor):
...     d = sendNotification(SnmpEngine(),
...                          CommunityData('public'),
...                          UdpTransportTarget(('demo.snmplabs.com', 162)),
...                          ContextData(),
...                          'trap',
...                          NotificationType(ObjectIdentity('IF-MIB', 'linkDown')))
...     d.addCallback(success).addErrback(failure)
...     return d
...
>>> react(run)
(0, 0, [])