1f40fdb09d
* Initial snmp sensor docs (#538) * Fixed markdown and added logo (#551) * Added documentation for router operating mode for asuswrt (#545) * local_file camera component documenatation (#554) * Documenation for local_file camera component * Update camera.local_file.markdown * Added information about voltage sensor * Instructions for Pandora media player (#552) * Add release * Add pub_key * Add BT Home Hub docs * Markdown tweaks (#553) * Add docs about MySensors IR switch (#556) * Update sensor.mysensors docs, about moving V_IR_SEND type to switch platform. * Update switch.mysensors docs. Add section about the new service and additional example sketch for the IR switch device. * Update index.html * plex sensor (#526) * Add var descriptions * Adds documentation for the Local File Camera (#482) * Revert "Adds documentation for the Local File Camera" (#563) * Minor changes * Add Wink Rollershutter (#559) * Added example of using template in shell_command. (#547) * Add Documentation for Netatmo Welcome (#542) * Reorganize documentation for Netatmo As Netatmo is now a Hub component, documentations has been splitted in several parts betweent the hub, the sensors and the camera Signed-off-by: Hugo D. (jabesq) <jabesq@gmail.com> * Add configuration variables for Netatmo Welcome cameras * Add ha_release information on new documentation pages * Netatmo Weather Station is a weather sensor * Add blog post 0.22
54 lines
2 KiB
Markdown
54 lines
2 KiB
Markdown
---
|
|
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
|
|
```
|
|
|