Skip to content
Back to top
View this page
Edit this page

# Common notifications

## SNMPv1 TRAP with defaults

Send SNMPv1 TRAP using the following options:

- SNMPv1

- with community name ‘public’

- over IPv4/UDP

- send TRAP notification

- with Generic Trap #1 (warmStart) and Specific Trap 0

- with default Uptime

- with default Agent Address

- with Enterprise OID 1.3.6.1.4.1.20408.4.1.1.2

- include managed object information ‘1.3.6.1.2.1.1.1.0’ = ‘my system’

Functionally similar to:

$ snmptrap -v1 -c public demo.pysnmp.com 1.3.6.1.4.1.20408.4.1.1.2 0.0.0.0 1 0 0 1.3.6.1.2.1.1.1.0 s “my system”

    import asyncio
    from pysnmp.hlapi.v1arch.asyncio import *

    async def run():
        with SnmpDispatcher() as snmpDispatcher:
            iterator = await send_notification(
                snmpDispatcher,
                CommunityData("public", mpModel=0),
                await UdpTransportTarget.create(("demo.pysnmp.com", 162)),
                "trap",
                NotificationType(ObjectIdentity("1.3.6.1.6.3.1.1.5.2"))
                .load_mibs("SNMPv2-MIB")
                .add_varbinds(
                    ("1.3.6.1.6.3.1.1.4.3.0", "1.3.6.1.4.1.20408.4.1.1.2"),
                    ("1.3.6.1.2.1.1.1.0", OctetString("my system")),
                ),
            )

            errorIndication, errorStatus, errorIndex, varBinds = iterator

            if errorIndication:
                print(errorIndication)

    asyncio.run(run())

`Download` script.

## SNMPv3 TRAP, auth: MD5, privacy: DES

Send SNMP TRAP notification using the following options:

- SNMPv3

- with user ‘usr-md5-des’, auth: MD5, priv DES

- over IPv4/UDP

- send TRAP notification

- to a Manager at 127.0.0.1:162

- with TRAP ID ‘warmStart’ specified as an OID

- include managed object information 1.3.6.1.2.1.1.5.0 = ‘system name’

Functionally similar to:

$ snmptrap -v3 -l authPriv -u usr-md5-des -A authkey1 -X privkey1 -e 8000000001020304 127.0.0.1:162 0 1.3.6.1.6.3.1.1.5.1 1.3.6.1.2.1.1.1.0 s “my system”

    from pysnmp.entity import engine, config
    from pysnmp.carrier.asyncio.dgram import udp
    from pysnmp.entity.rfc3413 import ntforg
    from pysnmp.proto.api import v2c

    # Create SNMP engine instance with specific (and locally unique)
    # SnmpEngineId -- it must also be known to the receiving party
    # and configured at its VACM users table.
    snmpEngine = engine.SnmpEngine(
        snmpEngineID=v2c.OctetString(hexValue="8000000001020304")
    )

    # Add USM user
    config.add_v3_user(
        snmpEngine,
        "usr-md5-des",
        config.USM_AUTH_HMAC96_MD5,
        "authkey1",
        config.USM_PRIV_CBC56_DES,
        "privkey1",
    )
    config.add_target_parameters(snmpEngine, "my-creds", "usr-md5-des", "authPriv")

    # Setup transport endpoint and bind it with security settings yielding
    # a target name
    config.add_transport(
        snmpEngine, udp.DOMAIN_NAME, udp.UdpAsyncioTransport().open_client_mode()
    )
    config.add_target_address(
        snmpEngine,
        "my-nms",
        udp.DOMAIN_NAME,
        ("127.0.0.1", 162),
        "my-creds",
        tagList="all-my-managers",
    )

    # Specify what kind of notification should be sent (TRAP or INFORM),
    # to what targets (chosen by tag) and what filter should apply to
    # the set of targets (selected by tag)
    config.add_notification_target(
        snmpEngine, "my-notification", "my-filter", "all-my-managers", "trap"
    )

    # Allow NOTIFY access to Agent's MIB by this SNMP model (3), securityLevel
    # and SecurityName
    config.add_context(snmpEngine, "")
    config.add_vacm_user(snmpEngine, 3, "usr-md5-des", "authPriv", (), (), (1, 3, 6))

    # *** SNMP engine configuration is complete by this line ***

    # Create Notification Originator App instance.
    ntfOrg = ntforg.NotificationOriginator()

    # Build and submit notification message to dispatcher
    ntfOrg.send_varbinds(
        snmpEngine,
        # Notification targets
        "my-notification",  # notification targets
        None,
        "",  # contextEngineId, contextName
        # var-binds
        [
            # SNMPv2-SMI::snmpTrapOID.0 = SNMPv2-MIB::coldStart
            (
                (1, 3, 6, 1, 6, 3, 1, 1, 4, 1, 0),
                v2c.ObjectIdentifier((1, 3, 6, 1, 6, 3, 1, 1, 5, 1)),
            ),
            # additional var-binds: ( (oid, value), ... )
            ((1, 3, 6, 1, 2, 1, 1, 5, 0), v2c.OctetString("Notificator Example")),
        ],
    )

    print("Notification is scheduled to be sent")

    # Run I/O dispatcher which would send pending message and process response
    snmpEngine.open_dispatcher()

`Download` script.

See also: library reference.