TRAP/INFORM Operation#
- async pysnmp.hlapi.v3arch.asyncio.sendNotification(snmpEngine: SnmpEngine, authData: CommunityData | UsmUserData, transportTarget: AbstractTransportTarget, contextData: ContextData, notifyType: str, *varBinds: NotificationType, **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 yieldsasyncio.get_running_loop().create_future()
which gets done whenever response arrives or error occurs.- Parameters:
snmpEngine (
SnmpEngine
) – Class instance representing SNMP engine.authData (
CommunityData
orUsmUserData
) – Class instance representing SNMP credentials.transportTarget (
UdpTransportTarget
orUdp6TransportTarget
) – 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 orObjectType
orNotificationType
) – One or more objects representing MIB variables to place into SNMP notification. It could be tuples of OID-values orObjectType
class instances ofNotificationType
objects.SNMP Notification PDU places rigid requirement on the ordering of the variable-bindings.
Mandatory variable-bindings:
SNMPv2-MIB::sysUpTime.0 = <agent uptime>
SNMPv2-SMI::snmpTrapOID.0 = {SNMPv2-MIB::coldStart, …}
Optional variable-bindings (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>
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 (
ErrorIndication
) – 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.v3arch.asyncio import * >>> >>> async def run(): ... errorIndication, errorStatus, errorIndex, varBinds = await sendNotification( ... SnmpEngine(), ... CommunityData('public'), ... await UdpTransportTarget.create(('demo.pysnmp.com', 162)), ... ContextData(), ... 'trap', ... NotificationType(ObjectIdentity('IF-MIB', 'linkDown'))) ... print(errorIndication, errorStatus, errorIndex, varBinds) ... >>> asyncio.run(run()) (None, 0, 0, []) >>>