TRAP/INFORM notification

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

Creates a generator to send SNMP notification.

When iterator gets advanced by asyncio main loop, SNMP TRAP or INFORM notification is send (RFC 1905#section-4.2.6). The iterator yields asyncio.Future which gets done whenever response arrives or error occurs.

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 places rigid requirement on the ordering of the variable-bindings.

    Mandatory variable-bindings:

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

    Optional variable-bindings (applicable to SNMP v1 TRAP):

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

    Informational variable-bindings:

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

**options –

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

Examples

>>> import asyncio
>>> from pysnmp.hlapi.asyncio import *
>>>
>>> @asyncio.coroutine
... def run():
...     errorIndication, errorStatus, errorIndex, varBinds = yield from sendNotification(
...         SnmpEngine(),
...         CommunityData('public'),
...         UdpTransportTarget(('demo.snmplabs.com', 162)),
...         ContextData(),
...         'trap',
...         NotificationType(ObjectIdentity('IF-MIB', 'linkDown')))
...     print(errorIndication, errorStatus, errorIndex, varBinds)
...
>>> asyncio.get_event_loop().run_until_complete(run())
(None, 0, 0, [])
>>>