gufo-snmp 0.12.0

The accelerated Python SNMP client library

Gufo SNMP

The accelerated Python SNMP client library.

---

Documentation: https://docs.gufolabs.com/gufo_snmp/

Source Code: https://github.com/gufolabs/gufo_snmp/

---

Gufo SNMP is the accelerated Python SNMP client library supporting both async and synchronous mode. It consists of a clean Python API for high-efficient BER parser and socket IO, implemented in the Rust language with PyO3 wrapper.

The querying of the single MIB key is a simple task:

from gufo.snmp import SnmpSession

async with SnmpSession(addr="127.0.0.1", community="public") as session:
    r = await session.get("1.3.6.1.2.1.1.3.0")

And the blocking mode shares virtually the same API:

from gufo.snmp.sync_client import SnmpSession

with SnmpSession(addr="127.0.0.1", community="public") as session:
    r = session.get("1.3.6.1.2.1.1.3.0")

Multiple keys can be queried by one request too:

async with SnmpSession(addr="127.0.0.1", community="public") as session:
    r = await session.get_many(["1.3.6.1.2.1.1.3.0", "1.3.6.1.2.1.1.2.0"])

The querying of the MIB parts is also available with GetNext request:

async with SnmpSession(addr="127.0.0.1", community="public") as session:
    async for oid, value in  session.getnext("1.3.6.1.2.1.1"):
        ...

And with GetBulk request:

async with SnmpSession(addr="127.0.0.1", community="public") as session:
    async for oid, value in  session.getbulk("1.3.6.1.2.1.1"):
        ...

The .fetch() method allows to choose between .getnext() and .getbulk() automatically:

async with SnmpSession(addr="127.0.0.1", community="public") as session:
    async for oid, value in  session.fetch("1.3.6.1.2.1.1"):
        ...

SNMPv3 shares same API and semantics:

async with SnmpSession(
    addr="127.0.0.1",
    user=User(
        "user1",
        auth_key=Sha1Key(b"12345678"),
        priv_key=Aes128Key(b"87654321")
    )
) as session:
    r = await session.get("1.3.6.1.2.1.1.3.0")

Gufo SNMP also allows to limit rate of outgoing requests to protect equipment from overloading:

async with SnmpSession(addr="127.0.0.1", community="public", limit_rps=10) as session:
    async for oid, value in  session.fetch("1.3.6.1.2.1.1"):
        ...

Gufo SNMP offers various tools for developers, including a wrapper to run a local instance of SNMP daemon:

async with Snmpd(), SnmpSession(addr="127.0.0.1", port=10161) as session:
    r = await session.get("1.3.6.1.2.1.1.3.0")

The gufo-snmp command-line utility, closely resembling the Net-SNMP tools, is also provided.

gufo-snmp -v2c -c public 127.0.0.1 1.3.6.1.2.1.1.6.0
1.3.6.1.2.1.1.6.0 = Gufo SNMP Test

Features

• Clean async and blocking API.
• SNMP v1/v2c/v3 support.
• SNMP v3 User Security Model:
  • Authentication: HMAC-MD5-96, HMAC-SHA-96.
  • Privacy: DES, AES128.
  • Engine ID discovery.
• Command-line utility which resembles Net-SNMP's get* commands.
• High-performance.
• Built with security in mind.
• Zero-copy BER parsing.
• Query rate limiting.
• Full Python typing support.
• Editor completion.
• Well-tested, battle-proven code.
• Thoroughly check compatibility with various network equipment.

Further Roadmap

• SHA2 family of hashes.
• AES256 encryption.
• SNMP Trap and Inform collector.
• Incorporation of the NOC's Compiled MIB infrastructure.

On Gufo Stack

This product is a part of Gufo Stack - the collaborative effort led by Gufo Labs. Our goal is to create a robust and flexible set of tools to create network management software and automate routine administration tasks.

To do this, we extract the key technologies that have proven themselves in the NOC and bring them as separate packages. Then we work on API, performance tuning, documentation, and testing. The NOC uses the final result as the external dependencies.

Gufo Stack makes the NOC better, and this is our primary task. But other products can benefit from Gufo Stack too. So we believe that our effort will make the other network management products better.