| Name | snmp-diode JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | A SNMP Interface to NetBoxLabs Diode |
| upload_time | 2024-08-09 21:56:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# snmp-diode
snmp-diode is a Python tool designed to gather device data using SNMP and push it to NetBoxLabs Diode.
## Features
- snmp-diode collects the following data using snmp:
| OID | NetBox Mapping |
| --- | ---- |
| 1.3.6.1.2.1.1.5.0 | Device Name |
| 1.3.6.1.2.1.1.2.0 | Manufacturer and Device Type |
| 1.3.6.1.2.1.1.6.0 | Site |
| 1.3.6.1.2.1.2.2.1.2 | Interface Name |
| 1.3.6.1.2.1.31.1.1.1.18 | Interface Description |
| 1.3.6.1.2.1.2.2.1.6 | Interface Mac Address |
| 1.3.6.1.2.1.2.2.1.7 | Interface Enabled Status |
| 1.3.6.1.2.1.4.20.1.2 | Interface IP Address |
| 1.3.6.1.2.1.4.20.1.3 | Interface Ip Address Mask |
## Installation
To install snmp-diode, follow these steps:
`$ pip install snmp-diode`
## Usage
```shell
usage: snmp-diode [-h] [-t HOST] [-n NETWORK] -v VERSION [-c COMMUNITY] [-u USERNAME] [-a AUTH] [-A {MD5,SHA}] [-x PRIVACY]
[-X PRIVACY_PROTOCOL] [-l {noAuthNoPriv,authNoPriv,authPriv}] [-d DIODE] [-k API_KEY] [--apply]
SNMP Discovery Tool for NetBoxLabs Diode
options:
-h, --help show this help message and exit
-t HOST, --host HOST Target Host Address
-n NETWORK, --network NETWORK
Target Network Address
-v VERSION, --version VERSION
SNMP Version
-c COMMUNITY, --community COMMUNITY
SNMP Community String
-u USERNAME, --username USERNAME
SNMPv3 Username
-a AUTH, --auth AUTH SNMPv3 Auth Password
-A {MD5,SHA}, --auth_protocol {MD5,SHA}
SNMPv3 Auth Protocol
-x PRIVACY, --privacy PRIVACY
SNMPv3 Privacy Password
-X PRIVACY_PROTOCOL, --privacy_protocol PRIVACY_PROTOCOL
SNMPv3 Privacy Protocol
-l {noAuthNoPriv,authNoPriv,authPriv}, --level {noAuthNoPriv,authNoPriv,authPriv}
SNMPv3 Security Level
-d DIODE, --diode DIODE
Diode Server
-k API_KEY, --api_key API_KEY
Diode API Key
--apply Apply the changes to NetBox
```
### Host mode
With -t flag snmp-diode discovers only the target host, usage sample:
```shell
$ export DIODE_API_KEY=1234567890098765432
$ snmp-diode -t 172.20.20.1 -v 2 -c public -d grpc://192.168.224.137:8081/diode --apply
```
### Network mode
With -n flag snmp-diode discovers the target network (CIDR format, i.e. 10.0.0.0/24 ) including the network address and mask, usage sample:
```shell
$ export DIODE_API_KEY=1234567890098765432
$ snmp-diode -n 172.20.20.0/24 -v 2 -c public -d grpc://192.168.224.137:8081/diode --apply
```
### Dry mode
Running snmp-diode without the --apply flag it gonna discover the target devices and print the Diode Entities.
```shell
$ snmp-diode -n 172.20.20.0/24 -v 2 -c public
```
## Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "snmp-diode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ea/ad/0fda225f88c09c2978dbffcdb8ff05888655db0b1d8da32df30e29a8e990/snmp_diode-0.0.3.tar.gz",
"platform": null,
"description": "# snmp-diode\n\nsnmp-diode is a Python tool designed to gather device data using SNMP and push it to NetBoxLabs Diode. \n\n## Features\n\n- snmp-diode collects the following data using snmp:\n\n| OID | NetBox Mapping |\n| --- | ---- |\n| 1.3.6.1.2.1.1.5.0 | Device Name |\n| 1.3.6.1.2.1.1.2.0 | Manufacturer and Device Type |\n| 1.3.6.1.2.1.1.6.0 | Site |\n| 1.3.6.1.2.1.2.2.1.2 | Interface Name |\n| 1.3.6.1.2.1.31.1.1.1.18 | Interface Description |\n| 1.3.6.1.2.1.2.2.1.6 | Interface Mac Address |\n| 1.3.6.1.2.1.2.2.1.7 | Interface Enabled Status |\n| 1.3.6.1.2.1.4.20.1.2 | Interface IP Address |\n| 1.3.6.1.2.1.4.20.1.3 | Interface Ip Address Mask |\n\n## Installation\n\nTo install snmp-diode, follow these steps:\n\n`$ pip install snmp-diode`\n\n## Usage\n\n\n```shell\nusage: snmp-diode [-h] [-t HOST] [-n NETWORK] -v VERSION [-c COMMUNITY] [-u USERNAME] [-a AUTH] [-A {MD5,SHA}] [-x PRIVACY]\n [-X PRIVACY_PROTOCOL] [-l {noAuthNoPriv,authNoPriv,authPriv}] [-d DIODE] [-k API_KEY] [--apply]\n\nSNMP Discovery Tool for NetBoxLabs Diode\n\noptions:\n -h, --help show this help message and exit\n -t HOST, --host HOST Target Host Address\n -n NETWORK, --network NETWORK\n Target Network Address\n -v VERSION, --version VERSION\n SNMP Version\n -c COMMUNITY, --community COMMUNITY\n SNMP Community String\n -u USERNAME, --username USERNAME\n SNMPv3 Username\n -a AUTH, --auth AUTH SNMPv3 Auth Password\n -A {MD5,SHA}, --auth_protocol {MD5,SHA}\n SNMPv3 Auth Protocol\n -x PRIVACY, --privacy PRIVACY\n SNMPv3 Privacy Password\n -X PRIVACY_PROTOCOL, --privacy_protocol PRIVACY_PROTOCOL\n SNMPv3 Privacy Protocol\n -l {noAuthNoPriv,authNoPriv,authPriv}, --level {noAuthNoPriv,authNoPriv,authPriv}\n SNMPv3 Security Level\n -d DIODE, --diode DIODE\n Diode Server\n -k API_KEY, --api_key API_KEY\n Diode API Key\n --apply Apply the changes to NetBox\n\n```\n\n### Host mode\n\nWith -t flag snmp-diode discovers only the target host, usage sample:\n\n```shell\n$ export DIODE_API_KEY=1234567890098765432\n$ snmp-diode -t 172.20.20.1 -v 2 -c public -d grpc://192.168.224.137:8081/diode --apply \n```\n### Network mode\n\nWith -n flag snmp-diode discovers the target network (CIDR format, i.e. 10.0.0.0/24 ) including the network address and mask, usage sample:\n\n```shell\n$ export DIODE_API_KEY=1234567890098765432\n$ snmp-diode -n 172.20.20.0/24 -v 2 -c public -d grpc://192.168.224.137:8081/diode --apply \n```\n\n### Dry mode\n\nRunning snmp-diode without the --apply flag it gonna discover the target devices and print the Diode Entities.\n\n```shell\n$ snmp-diode -n 172.20.20.0/24 -v 2 -c public\n```\n\n## Contributing\n\nContributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for more information.\n",
"bugtrack_url": null,
"license": null,
"summary": "A SNMP Interface to NetBoxLabs Diode",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/renatoalmeidaoliveira/snmp-diode/",
"Issues": "https://github.com/renatoalmeidaoliveira/snmp-diode/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "571ca04918fe5d2634899bee82940ce1304c1867051d65fcd8cc832112bff98c",
"md5": "54df4a7eec0ab54300e565756e67458d",
"sha256": "e113799cabb562360cd90aeb89e0d0e88af3328660ba8b77a370285fa811d0eb"
},
"downloads": -1,
"filename": "snmp_diode-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54df4a7eec0ab54300e565756e67458d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 926207,
"upload_time": "2024-08-09T21:56:11",
"upload_time_iso_8601": "2024-08-09T21:56:11.613984Z",
"url": "https://files.pythonhosted.org/packages/57/1c/a04918fe5d2634899bee82940ce1304c1867051d65fcd8cc832112bff98c/snmp_diode-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eaad0fda225f88c09c2978dbffcdb8ff05888655db0b1d8da32df30e29a8e990",
"md5": "c0b495c43001565ab4db8965a8ea7e58",
"sha256": "b38f141194fe2d1f5f3960ecd72f8b87a527740aef560ec9d9547dfb466bc351"
},
"downloads": -1,
"filename": "snmp_diode-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "c0b495c43001565ab4db8965a8ea7e58",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 914046,
"upload_time": "2024-08-09T21:56:13",
"upload_time_iso_8601": "2024-08-09T21:56:13.766468Z",
"url": "https://files.pythonhosted.org/packages/ea/ad/0fda225f88c09c2978dbffcdb8ff05888655db0b1d8da32df30e29a8e990/snmp_diode-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 21:56:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "renatoalmeidaoliveira",
"github_project": "snmp-diode",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "snmp-diode"
}
