Command-line SNMP tools
-----------------------
[](https://pypi.org/project/snmpclitools)
[](https://pypi.python.org/pypi/snmpclitools/)
[](https://pypi.org/project/snmpclitools/)
[](https://raw.githubusercontent.com/lextudio/snmpclitools/master/LICENSE.rst)
This is a collection of command-line SNMP tools written in pure-Python.
The tools mimic their famous [Net-SNMP](https://sourceforge.net/projects/net-snmp/)
counterparts.
In the past this project was known as *pysnmp-apps*.
Features
--------
* Complete SNMPv1/v2c and SNMPv3 support
* Interface compatible (almost) with Net-SNMP's snmp\* tools.
* SNMPv3 USM supports MD5/SHA/SHA-224/SHA-256/SHA-384/SHA-512 auth and
DES/3-DES/AES-128/AES-192/AES-256 privacy crypto algorithms
* Automatically downloads required MIBs from the Internet
* Runs over IPv4 and/or IPv6 transports
* Cross-platform: works on Linux, Windows and macOS.
* 100% Python, works with Python 3.8+
Download
--------
The snmpclitools package is distributed under terms and conditions of 2-clause
BSD [license](https://www.pysnmp.com/snmpclitools/license.html). Source code is freely
available as a Github [repo](https://github.com/lextudio/snmpclitools).
Installation
------------
Download snmpclitools from [PyPI](https://pypi.org/project/snmpclitools) or just run:
```bash
$ pip install snmpclitools
```
How to use the tools
--------------------
The most of pysnmp command-line tools could be run in a similar way as their Net-SNMP counterparts. For example:
```bash
$ snmpbulkwalk -v3 -u usr-md5-des -l authPriv -A authkey1 -X privkey1 demo.pysnmp.com system
SNMPv2-MIB::sysDescr.0 = DisplayString: Linux grommit 3.5.11.1 #2 PREEMPT Tue Mar 1 14:03:24 MSD 2016 i686 unknown unknown GNU/Linux
SNMPv2-MIB::sysObjectID.0 = ObjectIdentifier: iso.org.dod.internet.private.enterprises.8072.3.2.101.3.6.1.4.1.8072.3.2.10
SNMPv2-MIB::sysUpTime.0 = TimeTicks: 43 days 1:55:47.85372214785
[ skipped ]
SNMPv2-MIB::sysORUpTime."8" = TimeStamp: 0 days 0:0:0.77
SNMPv2-MIB::sysORUpTime."9" = TimeStamp: 0 days 0:0:0.77
$ snmpget -v3 -u usr-sha-aes -l authPriv -A authkey1 -X privkey1 demo.pysnmp.com IP-MIB::ipAdEntBcastAddr.\"127.0.0.1\"
IP-MIB::ipAdEntBcastAddr."127.0.0.1" = Integer32: 1
$ snmpset -v2c -c public demo.pysnmp.com SNMPv2-MIB::sysDescr.0 = my-new-descr
notWritable(17)
```
For more information, please, run any of these tools with `--help` option.
You can play with different security protocols against the publicly available SNMP
agent like [this one @www.pysnmp.com](https://www.pysnmp.com/snmpsim/public-snmp-agent-simulator.html).
Getting help
------------
If something does not work as expected, please open up a
[GitHub issue](https://github.com/lextudio/pysnmp/issues/new) or post
your question [to Stack Overflow](https://stackoverflow.com/questions/ask).
Feedback and collaboration
--------------------------
Your pull requests are very welcome!
Copyright (c) 2005-2019, [Ilya Etingof](mailto:etingof@gmail.com).
Copyright (c) 2022-2024, [LeXtudio Inc.](mailto:support@lextudio.com).
All rights reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/lextudio/snmpclitools",
"name": "snmpclitools",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Ilya Etingof",
"author_email": "etingof@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b7/64/947b1cad405ba175c03385a4936b930b1fda7ce65e9da5bef5d64a5439fb/snmpclitools-0.7.2.tar.gz",
"platform": null,
"description": "\nCommand-line SNMP tools\n-----------------------\n\n[](https://pypi.org/project/snmpclitools)\n[](https://pypi.python.org/pypi/snmpclitools/)\n[](https://pypi.org/project/snmpclitools/)\n[](https://raw.githubusercontent.com/lextudio/snmpclitools/master/LICENSE.rst)\n\nThis is a collection of command-line SNMP tools written in pure-Python.\nThe tools mimic their famous [Net-SNMP](https://sourceforge.net/projects/net-snmp/)\ncounterparts.\n\nIn the past this project was known as *pysnmp-apps*.\n\nFeatures\n--------\n\n* Complete SNMPv1/v2c and SNMPv3 support\n* Interface compatible (almost) with Net-SNMP's snmp\\* tools.\n* SNMPv3 USM supports MD5/SHA/SHA-224/SHA-256/SHA-384/SHA-512 auth and\n DES/3-DES/AES-128/AES-192/AES-256 privacy crypto algorithms\n* Automatically downloads required MIBs from the Internet\n* Runs over IPv4 and/or IPv6 transports\n* Cross-platform: works on Linux, Windows and macOS.\n* 100% Python, works with Python 3.8+\n\nDownload\n--------\n\nThe snmpclitools package is distributed under terms and conditions of 2-clause\nBSD [license](https://www.pysnmp.com/snmpclitools/license.html). Source code is freely\navailable as a Github [repo](https://github.com/lextudio/snmpclitools).\n\nInstallation\n------------\n\nDownload snmpclitools from [PyPI](https://pypi.org/project/snmpclitools) or just run:\n\n```bash\n$ pip install snmpclitools\n```\n\nHow to use the tools\n--------------------\n\nThe most of pysnmp command-line tools could be run in a similar way as their Net-SNMP counterparts. For example:\n\n```bash\n$ snmpbulkwalk -v3 -u usr-md5-des -l authPriv -A authkey1 -X privkey1 demo.pysnmp.com system\nSNMPv2-MIB::sysDescr.0 = DisplayString: Linux grommit 3.5.11.1 #2 PREEMPT Tue Mar 1 14:03:24 MSD 2016 i686 unknown unknown GNU/Linux\nSNMPv2-MIB::sysObjectID.0 = ObjectIdentifier: iso.org.dod.internet.private.enterprises.8072.3.2.101.3.6.1.4.1.8072.3.2.10\nSNMPv2-MIB::sysUpTime.0 = TimeTicks: 43 days 1:55:47.85372214785\n[ skipped ]\nSNMPv2-MIB::sysORUpTime.\"8\" = TimeStamp: 0 days 0:0:0.77\nSNMPv2-MIB::sysORUpTime.\"9\" = TimeStamp: 0 days 0:0:0.77\n\n$ snmpget -v3 -u usr-sha-aes -l authPriv -A authkey1 -X privkey1 demo.pysnmp.com IP-MIB::ipAdEntBcastAddr.\\\"127.0.0.1\\\"\nIP-MIB::ipAdEntBcastAddr.\"127.0.0.1\" = Integer32: 1\n\n$ snmpset -v2c -c public demo.pysnmp.com SNMPv2-MIB::sysDescr.0 = my-new-descr\nnotWritable(17)\n```\n\nFor more information, please, run any of these tools with `--help` option.\n\nYou can play with different security protocols against the publicly available SNMP\nagent like [this one @www.pysnmp.com](https://www.pysnmp.com/snmpsim/public-snmp-agent-simulator.html).\n\nGetting help\n------------\n\nIf something does not work as expected, please open up a\n[GitHub issue](https://github.com/lextudio/pysnmp/issues/new) or post\nyour question [to Stack Overflow](https://stackoverflow.com/questions/ask).\n\nFeedback and collaboration\n--------------------------\n\nYour pull requests are very welcome!\n\nCopyright (c) 2005-2019, [Ilya Etingof](mailto:etingof@gmail.com).\nCopyright (c) 2022-2024, [LeXtudio Inc.](mailto:support@lextudio.com).\nAll rights reserved.\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "A collection of command-line tools for SNMP management purposes built on top of PySNMP package.",
"version": "0.7.2",
"project_urls": {
"Homepage": "https://github.com/lextudio/snmpclitools",
"Repository": "https://github.com/lextudio/snmpclitools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc0b19023f1b276a48329654d3205e219c9f6b3d44deb21debc8a9acc30eba6e",
"md5": "cad8567f78983b9fa12ed4723cfe05a1",
"sha256": "16af688cd085cb11d31cfde0c8c595ea8b7923eda3bfcd5377a461518da684e7"
},
"downloads": -1,
"filename": "snmpclitools-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cad8567f78983b9fa12ed4723cfe05a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 36880,
"upload_time": "2024-08-25T03:25:18",
"upload_time_iso_8601": "2024-08-25T03:25:18.267783Z",
"url": "https://files.pythonhosted.org/packages/bc/0b/19023f1b276a48329654d3205e219c9f6b3d44deb21debc8a9acc30eba6e/snmpclitools-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b764947b1cad405ba175c03385a4936b930b1fda7ce65e9da5bef5d64a5439fb",
"md5": "5284f7f6015696d0312172601832783c",
"sha256": "c54977a588bfc4beba83ec77f6294957128de27bb3b86c05f488cbd3d0977b15"
},
"downloads": -1,
"filename": "snmpclitools-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "5284f7f6015696d0312172601832783c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 59948,
"upload_time": "2024-08-25T03:25:19",
"upload_time_iso_8601": "2024-08-25T03:25:19.667596Z",
"url": "https://files.pythonhosted.org/packages/b7/64/947b1cad405ba175c03385a4936b930b1fda7ce65e9da5bef5d64a5439fb/snmpclitools-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 03:25:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lextudio",
"github_project": "snmpclitools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "snmpclitools"
}
JSON
