jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 05:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial snmp sensor docs (#538)

Browse Source
This commit is contained in:
Fabian Affolter 2016-06-09 07:58:46 +02:00
parent 464ded7d8b
commit 35b2c34c9d
1 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
source/_components/sensor.snmp.markdown Normal file
View File

@ -0,0 +1,54 @@
---
layout: page
title: "SNMP"
description: "Instructions how to integrate SNMP sensors within Home Assistant."
date: 2016-06-05 20:00
sidebar: true
comments: false
sharing: true
footer: true
logo: network-snmp.png
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: "0.21"
---
The `snmp` sensor platform simple displays the information which are available through the [Simple Network Management Protocol (SNMP)](https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol). SNMP uses a tree-like hierarchy where each node is an object.
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: snmp
name: Load
host: 192.168.1.32
port: 161
community: public
baseoid: 1.3.6.1.4.1.2021.10.1.3.1
unit_of_measurement: "%"
```
Configuration variables:
- **host** (*Required*): The IP address of your host, eg. 192.168.1.32.
- **port** (*Option*): The SNMP port of your host. Defaults to 161.
- **name** (*Optional*): Name of the SNMP sensor.
- **community** (*Optional*): The SNMP community which is set for the device. Most devices have a default community set to to `public` with read-only permission (which is sufficient).
- **baseoid** (*Required*): The OID where the information is located. It's advised to use the numerical notation.
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
The OIDs may vary on different system because they are vendor-specific. Beside the device's manual is the [OID Repository](http://www.oid-info.com/) a good place to start if you are looking for OIDs. The following OIDs are for the load of a Linux systems.
- 1 minute Load: 1.3.6.1.4.1.2021.10.1.3.1
- 5 minute Load: 1.3.6.1.4.1.2021.10.1.3.2
- 15 minute Load: 1.3.6.1.4.1.2021.10.1.3.3
There is a large amount of tools available to work with SNMP. `snmpwalk` let you easily retrieve the value of a OID.
```bash
$ snmpwalk -Os -c public -v 2c 192.168.1.32 1.3.6.1.4.1.2021.10.1.3.1
laLoad.1 = STRING: 0.19
```