Awesome

SNMP Library for Python

This is a pure-Python, open source and free implementation of v1/v2c/v3 SNMP engine distributed under 2-clause BSD license.

The PySNMP project was initially sponsored by a PSF grant. Thank you!

This repo is derived from Ilya Etingof's project etingof/pysnmp, but LeXtudio Inc. has taken over the entire PySNMP ecosystem, including the library, documentation, and the website.

Ilya sadly passed away on 10-Aug-2022. Announcement here. His work is still of great use to the Python community and he will be missed.

Features

Complete SNMPv1/v2c and SNMPv3 support
SMI framework for resolving MIB information and implementing SMI Managed Objects
Complete SNMP entity implementation
USM Extended Security Options support (3DES, 192/256-bit AES encryption)
Extensible network transports framework (UDP/IPv4, UDP/IPv6)
Asynchronous socket-based IO API support
Asyncio integration
PySMI integration for dynamic MIB compilation
Built-in instrumentation exposing protocol engine operations
Python eggs and py2exe friendly
100% Python, works with Python 3.8+
MT-safe (if SnmpEngine is thread-local)

Features, specific to SNMPv3 model include:

USM authentication (MD5/SHA-1/SHA-2) and privacy (DES/AES) protocols (RFC3414, RFC7860)
View-based access control to use with any SNMP model (RFC3415)
Built-in SNMP proxy PDU converter for building multi-lingual SNMP entities (RFC2576)
Remote SNMP engine configuration
Optional SNMP engine discovery
Shipped with standard SNMP applications (RFC3413)

Download & Install

The PySNMP software is freely available for download from PyPI and GitHub.

Just run:

$ pip install pysnmp

To download and install PySNMP along with its dependencies:

PyASN1
PySMI (required for MIB services only)
If cryptography package presents strong SNMPv3 encryption is enabled

Make sure you check out other sibling projects of PySNMP on the home page.

Examples

PySNMP is designed in a layered fashion. Top-level and easiest to use API is known as hlapi. Here's a quick example on how to SNMP GET:

from pysnmp.hlapi.v1arch.asyncio import *

import asyncio


async def run():
    with Slim(1) as slim:
        errorIndication, errorStatus, errorIndex, varBinds = await slim.get(
            'public',
            'demo.pysnmp.com',
            161,
            ObjectType(ObjectIdentity("SNMPv2-MIB", "sysDescr", 0)),
        )

        if errorIndication:
            print(errorIndication)
        elif errorStatus:
            print(
                "{} at {}".format(
                    errorStatus.prettyPrint(),
                    errorIndex and varBinds[int(errorIndex) - 1][0] or "?",
                )
            )
        else:
            for varBind in varBinds:
                print(" = ".join([x.prettyPrint() for x in varBind]))

asyncio.run(run())

This is how to send SNMP TRAP:

from pysnmp.hlapi.v3arch.asyncio import *

import asyncio


async def run():
    snmpEngine = SnmpEngine()
    errorIndication, errorStatus, errorIndex, varBinds = await sendNotification(
        snmpEngine,
        CommunityData('public', mpModel=0),
        await UdpTransportTarget.create(('demo.pysnmp.com', 162)),
        ContextData(),
        "trap",
        NotificationType(ObjectIdentity("1.3.6.1.6.3.1.1.5.2")).addVarBinds(
            ("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")),
        ),
    )

    if errorIndication:
        print(errorIndication)

    snmpEngine.closeDispatcher()

asyncio.run(run())

We maintain publicly available SNMP Agent and TRAP sink at demo.pysnmp.com. You are welcome to use it while experimenting with whatever SNMP software you deal with.

Other than that, PySNMP is capable to automatically fetch and use required MIBs from HTTP sites or local directories. You could configure any MIB source available to you (including this one) for that purpose.

For more sample scripts please refer to examples section at PySNMP web site.

Documentation

Library documentation can be found at the PySNMP docs site.

If something does not work as expected, please learn the support options.

Pull requests are appreciated! ;-)