SNMP with Python

Welcome to the snmp library documentation! This library focuses on making the Simple Network Management Protocol as simple-to-use as possible. If you are new to snmp, you can see the basic usage in the examples below. For an explanation of these examples, see the Getting Started section.

To learn about advanced features and options, consult the Library Reference.

Installation

The simplest way to install snmp is with pip:

pip install snmp

See the Installation section for advanced options.

Examples

SNMPv3 Example

Note

This code will run out of the box on an Ubuntu machine with just a few simple setup steps (as the root user). First, install the snmp daemon with apt install snmpd. Then open /etc/snmp/snmpd.conf, and uncomment the line that says createuser authPrivUser SHA-512 myauthphrase AES myprivphrase (or add it, if it’s not there). Save and exit that file, and then run systemctl restart snmpd.

from snmp import Engine
from snmp.security.usm.auth import HmacSha512
from snmp.security.usm.priv import AesCfb128

engine = Engine()
engine.addUser(
    "authPrivUser",
    authProtocol=HmacSha512,
    authSecret=b"myauthphrase",
    privProtocol=AesCfb128,
    privSecret=b"myprivphrase",
)

localhost = engine.Manager("127.0.0.1")
response = localhost.get("1.3.6.1.2.1.1.4.0", "1.3.6.1.2.1.1.6.0")
print(response)

The output of this example should look like this:

1.3.6.1.2.1.1.4.0: OctetString(b'Me <me@example.org>')
1.3.6.1.2.1.1.6.0: OctetString(b'Sitting on the Dock of the Bay')

This example can also be written in the async/await style, using an AsyncEngine.

import asyncio

from snmp.async_engine import AsyncEngine
from snmp.security.usm.auth import HmacSha512
from snmp.security.usm.priv import AesCfb128

engine = AsyncEngine()
engine.addUser(
    "authPrivUser",
    authProtocol=HmacSha512,
    authSecret=b"myauthphrase",
    privProtocol=AesCfb128,
    privSecret=b"myprivphrase",
)

async def main(manager):
    response = await manager.get("1.3.6.1.2.1.1.4.0", "1.3.6.1.2.1.1.6.0")
    print(response)

loop = asyncio.get_event_loop()
localhost = engine.Manager("127.0.0.1")
loop.run_until_complete(main(localhost))

SNMPv1/SNMPv2c Example

Note

This code will run out of the box on an Ubuntu machine. Simply install the snmp daemon with apt install snmpd.

from snmp import *

engine = Engine(SNMPv1)  # or SNMPv2c
localhost = engine.Manager("127.0.0.1", community=b"public")
response = localhost.get("1.3.6.1.2.1.1.4.0", "1.3.6.1.2.1.1.6.0")
print(response)

The expected output is the same as that of the SNMPv3 example:

1.3.6.1.2.1.1.4.0: OctetString(b'Me <me@example.org>')
1.3.6.1.2.1.1.6.0: OctetString(b'Sitting on the Dock of the Bay')

This example can also be written in the async/await style, using an AsyncEngine.

import asyncio

from snmp import *
from snmp.async_engine import AsyncEngine

async def main(manager):
    response = await manager.get("1.3.6.1.2.1.1.4.0", "1.3.6.1.2.1.1.6.0")
    print(response)

engine = AsyncEngine(SNMPv1)  # or SNMPv2c
localhost = engine.Manager("127.0.0.1", community=b"public")

loop = asyncio.get_event_loop()
loop.run_until_complete(main(localhost))