https://github.com/cybcon/docker.snmp2mqtt
Read device information via SNMP and publish them in a MQTT topic as json formatted string.
https://github.com/cybcon/docker.snmp2mqtt
docker-compose docker-image mqtt-client python3 snmp
Last synced: 2 months ago
JSON representation
Read device information via SNMP and publish them in a MQTT topic as json formatted string.
- Host: GitHub
- URL: https://github.com/cybcon/docker.snmp2mqtt
- Owner: cybcon
- License: mit
- Created: 2023-10-31T16:20:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-28T18:25:33.000Z (6 months ago)
- Last Synced: 2025-12-31T09:21:22.036Z (6 months ago)
- Topics: docker-compose, docker-image, mqtt-client, python3, snmp
- Language: Python
- Homepage: https://www.oberdorf-itc.de/
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Quick reference
Maintained by: [Michael Oberdorf IT-Consulting](https://www.oberdorf-itc.de/)
Source code: [GitHub](https://github.com/cybcon/docker.snmp2mqtt)
Container image: [DockerHub](https://hub.docker.com/r/oitc/snmp2mqtt)
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]
[![][github-release-shield]][github-release-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-stars-shield]][github-stars-link]
[![][github-forks-shield]][github-forks-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
[![][docker-release-shield]][docker-release-link]
[![][docker-pulls-shield]][docker-pulls-link]
[![][docker-stars-shield]][docker-stars-link]
[![][docker-size-shield]][docker-size-link]
# Supported tags and respective `Dockerfile` links
* [`latest`, `1.1.2`](https://github.com/cybcon/docker.snmp2mqtt/blob/v1.1.2/Dockerfile)
* [`1.1.1`](https://github.com/cybcon/docker.snmp2mqtt/blob/v1.1.1/Dockerfile)
* [`1.0.4`](https://github.com/cybcon/docker.snmp2mqtt/blob/v1.0.4/Dockerfile)
* [`1.0.3`](https://github.com/cybcon/docker.snmp2mqtt/blob/v1.0.3/Dockerfile)
* [`1.0.2`](https://github.com/cybcon/docker.snmp2mqtt/blob/v1.0.2/Dockerfile)
* [`1.0.1`](https://github.com/cybcon/docker.snmp2mqtt/blob/v1.0.1/Dockerfile)
* [`1.0.0`](https://github.com/cybcon/docker.snmp2mqtt/blob/v1.0.0/Dockerfile)
# Summary
The container image is based on Alpine Linux with python3 interpreter.
The tool is written in python and connects to a MQTT server. After that, it loops over the configured SNMP endpoints and graps the configured OIDs.
The collected SNMP data will be transformed as a json object and published to the given MQTT topic.
# Configuration
## Container configuration
The container reads some configuration via environment variables.
| Environment variable name | Description | Required | Default value |
|------------------------------|------------------------------------------------------------------------------------------------|--------------|---------------------------|
| `CONFIG_FILE` | The configuration file that contains the connection parameters to MQTT and the SNMP endpoints. | **OPTIONAL** | `/app/etc/snmp2mqtt.json` |
## Configuration file
The path and filename to the general configuration file can be set via environment variable `CONFIG_FILE`. By default, the script will use `/app/etc/snmp2mqtt.json`.
Inside this file we need to configure the MQTT server connection parameters and the SNMP endpoint connection parameters.
### Example
```json
{
"DEBUG": true,
"devices": [
"EXAMPLE"
],
"mqtt": {
"client_id": "snmp2mqtt",
"user": "snmp2mqtt",
"password": "myMQTTPassword",
"server": "test.mosquitto.org",
"port": 1883,
"tls": false,
"retain": true,
"hostname_validation": false,
"protocol_version": 3
},
"EXAMPLE": {
"server": "127.0.0.1",
"port": 161,
"snmpCredentials": {
"user": "snmpUser",
"password": "snmpPassword",
"algorithm": "MD5"
},
"snmpEncryption": {
"password": "snmpEncryptionKey",
"algorithm": "DES"
},
"snmpOID2Attribute": {
"1.3.6.1.4.1.2021.4.3.0": "memTotalSwap"
},
"mqttTopic": "de/oberdorf-itc/devices/EXAMPLE"
}
}
```
### Field description
| Field | Type | Description |
|--------------------------------------------|---------|------------------------------------------------------------------------------------------------------------|
| `DEBUG` | Boolean | Enable debug output on stdout |
| `devices` | Array | A List of names that represent SNMP endpoints. These keywords are later used inside the configuation file. |
| `mqtt` | Object | Contains MQTT specific configuration parameters. |
| `mqtt.client_id` | String | The MQTT client identifier. |
| `mqtt.user` | String | The username to authenticate to the MQTT server. |
| `mqtt.password` | String | The password to authenticate to the MQTT server. |
| `mqtt.server` | String | IP address or FQDN of the MQTT server. |
| `mqtt.port` | String | The TCP port number of the MQTT server. |
| `mqtt.tls` | Boolean | If a TLS encrpted communication should be established or not. |
| `mqtt.hostname_validation` | Boolean | Validate the hostname from the servercertificate or not. |
| `mqtt.protocol_version` | Integer | The MQTT protocol version. Can be 3 (for MQTTv311) or 5 (for MQTTv5). |
| *\* | Object | Contains the SNMP endpoint specific configuration parametes. |
| *\*.`server` | String | IP address or FQDN of the SNMP endpoint. |
| *\*.`port` | Integer | The TCP port number of the SNMP endpoint. |
| *\*.`snmpCredentials` | Object | The SNMP endpoint credentials for authentication. |
| *\*.`snmpCredentials.user` | String | The username to authenticate to the SNMP endpoint. |
| *\*.`snmpCredentials.password` | String | The password to authenticate to the SNMP endpoint. |
| *\*.`snmpCredentials.algorithm` | String | The algorithm to use when authenticating to the SNMP endpoint (supported: `MD5`, `SHA`, `SHA224`, `SHA256`, `SHA384`, `SHA512`). |
| *\*.`snmpEncryption` | Object | The SNMP endpoint data encrption parameters. |
| *\*.`snmpEncryption.password` | String | The SNMP data encrption password. |
| *\*.`snmpEncryption.algorithm` | String | The SNMP data encrption algorithm (supported: `DES`, `3DES`, `AES128`, `AES192`, `AES256`). |
| *\*.`snmpOID2Attribute` | Object | List of SNMP OIDs and a human readable name. |
| *\*.`snmpOID2Attribute`.*\* | String | A human readable translation of the given OID. |
| *\*.`mqttTopic` | String | the MQTT topic to publish the colected device data. |
# Running the container image
```
docker run --rm -v ./myConfig.json:/app/etc/snmp2mqtt.json:ro oitc/snmp2mqtt:latest
```
# Docker compose configuration
```yaml
services:
snmp2mqtt:
container_name: snmp2mqtt
image: oitc/snmp2mqtt:1.0.0
restart: "no"
user: 3917:3917
volumes:
- /srv/docker/snmp2mqtt/etc/snmp2mqtt.json:/app/etc/snmp2mqtt.json:ro
```
# Donate
I would appreciate a small donation to support the further development of my open source projects.
# License
Copyright (c) 2023-2025 Michael Oberdorf IT-Consulting
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[docker-pulls-link]: https://hub.docker.com/r/oitc/snmp2mqtt
[docker-pulls-shield]: https://img.shields.io/docker/pulls/oitc/snmp2mqtt?color=45cc11&labelColor=black&style=flat-square
[docker-release-link]: https://hub.docker.com/r/oitc/snmp2mqtt
[docker-release-shield]: https://img.shields.io/docker/v/oitc/snmp2mqtt?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square
[docker-size-link]: https://hub.docker.com/r/oitc/snmp2mqtt
[docker-size-shield]: https://img.shields.io/docker/image-size/oitc/snmp2mqtt?color=369eff&labelColor=black&style=flat-square
[docker-stars-link]: https://hub.docker.com/r/oitc/snmp2mqtt
[docker-stars-shield]: https://img.shields.io/docker/stars/oitc/snmp2mqtt?color=45cc11&labelColor=black&style=flat-square
[github-action-release-link]: https://github.com/cybcon/docker.snmp2mqtt/actions/workflows/release-from-label.yaml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/cybcon/docker.snmp2mqtt/release-from-label.yaml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/cybcon/docker.snmp2mqtt/actions/workflows/container-image-build-validation.yaml
[github-action-test-shield-original]: https://github.com/cybcon/docker.snmp2mqtt/actions/workflows/container-image-build-validation.yaml/badge.svg
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/cybcon/docker.snmp2mqtt/container-image-build-validation.yaml?label=tests&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-forks-link]: https://github.com/cybcon/docker.snmp2mqtt/network/members
[github-forks-shield]: https://img.shields.io/github/forks/cybcon/docker.snmp2mqtt?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/cybcon/docker.snmp2mqtt/issues
[github-issues-shield]: https://img.shields.io/github/issues/cybcon/docker.snmp2mqtt?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/cybcon/docker.snmp2mqtt/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/badge/license-MIT-blue?labelColor=black&style=flat-square
[github-release-link]: https://github.com/cybcon/docker.snmp2mqtt/releases
[github-release-shield]: https://img.shields.io/github/v/release/cybcon/docker.snmp2mqtt?color=369eff&labelColor=black&logo=github&style=flat-square
[github-releasedate-link]: https://github.com/cybcon/docker.snmp2mqtt/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/cybcon/docker.snmp2mqtt?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/cybcon/docker.snmp2mqtt
[github-stars-shield]: https://img.shields.io/github/stars/cybcon/docker.snmp2mqtt?color=ffcb47&labelColor=black&style=flat-square