Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/lextudio/pysnmp

Python SNMP library
https://github.com/lextudio/pysnmp

Last synced: 3 months ago
JSON representation

Python SNMP library

Host: GitHub
URL: https://github.com/lextudio/pysnmp
Owner: lextudio
License: bsd-2-clause
Fork: true (etingof/pysnmp)
Created: 2022-11-07T07:00:39.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-11T23:50:55.000Z (3 months ago)
Last Synced: 2024-04-12T02:58:36.363Z (3 months ago)
Language: Python
Homepage: https://www.pysnmp.com/pysnmp/
Size: 4.4 MB
Stars: 52
Watchers: 6
Forks: 10
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE.rst

Lists

awesome-snmp - lextudio/pysnmp - commit/lextudio/pysnmp) (Libraries / Python)

README

        
SNMP Library for Python

-----------------------

[![Become a Sponsor](https://img.shields.io/badge/Become%20a%20Sponsor-lextudio-orange.svg?style=for-readme)](https://github.com/sponsors/lextudio)

[![PyPI](https://img.shields.io/pypi/v/pysnmp-lextudio.svg)](https://pypi.python.org/pypi/pysnmp-lextudio)

[![PyPI Downloads](https://img.shields.io/pypi/dd/pysnmp-lextudio)](https://pypi.python.org/pypi/pysnmp-lextudio/)

[![Python Versions](https://img.shields.io/pypi/pyversions/pysnmp-lextudio.svg)](https://pypi.python.org/pypi/pysnmp-lextudio/)

[![GitHub license](https://img.shields.io/badge/license-BSD-blue.svg)](https://raw.githubusercontent.com/lextudio/pysnmp/master/LICENSE.rst)

This is a pure-Python, open source and free implementation of v1/v2c/v3

SNMP engine distributed under 2-clause [BSD license](https://www.pysnmp.com/pysnmp/license.html).

The PySNMP project was initially sponsored by a [PSF](http://www.python.org/psf/) grant.

Thank you!

This repo is a fork of Ilya Etingof's project [etingof/pysnmp](https://github.com/etingof/pysnmp), but [LeXtudio Inc. is taking over the entire PySNMP ecosystem](https://github.com/etingof/pysnmp/issues/429), including the library, documentation, and the website.

Ilya sadly passed away on 10-Aug-2022. Announcement [here](https://lists.openstack.org/pipermail/openstack-discuss/2022-August/030062.html).  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](https://docs.python.org/3/library/asyncio.html) integration

* [PySMI](https://www.pysnmp.com/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](https://pypi.python.org/pypi/pysnmp-lextudio)

and [GitHub](https://github.com/lextudio/pysnmp.git).

Just run:

```bash

$ pip install pysnmp-lextudio

```

To download and install PySNMP along with its dependencies:

* [PyASN1](https://pyasn1.readthedocs.io)

* [PySMI](https://www.pysnmp.com/pysmi/) (required for MIB services only)

* Optional [pysnmpcrypto](https://github.com/etingof/pysnmpcrypto) package

  whenever strong SNMPv3 encryption is desired

Besides the library, command-line [SNMP utilities](https://github.com/lextudio/snmpclitools)

written in pure-Python could be installed via:

```bash

$ pip install snmpclitools-lextudio

```

and used in the very similar manner as conventional Net-SNMP tools:

```bash

$ snmpget.py -v3 -l authPriv -u usr-md5-des -A authkey1 -X privkey1 demo.pysnmp.com sysDescr.0

SNMPv2-MIB::sysDescr.0 = STRING: Linux zeus 4.8.6.5-smp #2 SMP Sun Nov 13 14:58:11 CDT 2016 i686

```

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:

```python

from pysnmp.hlapi import *

from pysnmp.smi.rfc1902 import ObjectIdentity, ObjectType

with Slim(1) as slim:

    errorIndication, errorStatus, errorIndex, varBinds = 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]))

```

This is how to send SNMP TRAP:

```python

from pysnmp.hlapi import *

snmpEngine = SnmpEngine()

errorIndication, errorStatus, errorIndex, varBinds = sendNotification(

    snmpEngine,

    CommunityData('public', mpModel=0),

    UdpTransportTarget(('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()

```

> We maintain publicly available SNMP Agent and TRAP sink at

> [demo.pysnmp.com](https://www.pysnmp.com/snmp-simulation-service). You are

> welcome to use it while experimenting with whatever SNMP software you deal with.

```bash

$ python3 examples/hlapi/asyncio/manager/cmdgen/usm-sha-aes128.py

SNMPv2-MIB::sysDescr.0 = SunOS zeus.pysnmp.com 4.1.3_U1 1 sun4m

$

$ python3 examples/hlapi/asyncio/agent/ntforg/v3-inform.py

SNMPv2-MIB::sysUpTime.0 = 0

SNMPv2-MIB::snmpTrapOID.0 = SNMPv2-MIB::warmStart

SNMPv2-MIB::sysName.0 = system name

```

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](https://mibs.pysnmp.com)) for that purpose.

For more sample scripts please refer to [examples section](https://www.pysnmp.com/pysnmp/examples/index.html#high-level-snmp)

at PySNMP web site.

Documentation

-------------

Library documentation and examples can be found at the [PySNMP docs site](https://www.pysnmp.com/pysnmp/).

If something does not work as expected, please

[open an issue](https://github.com/lextudio/pysnmp/issues) at GitHub or

post your question [on Stack Overflow](http://stackoverflow.com/questions/ask).

Bug reports and PRs are appreciated! ;-)

Copyright (c) 2005-2020, [Ilya Etingof](https://lists.openstack.org/pipermail/openstack-discuss/2022-August/030062.html).

Copyright (c) 2022-2024, [LeXtudio Inc](mailto:[email protected]).

All rights reserved.