Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 2.03 KB

sensor.snmp.markdown

File metadata and controls

54 lines (43 loc) · 2.03 KB
Raw
layout title description date sidebar comments sharing footer logo ha_category ha_iot_class ha_release
page
SNMP
Instructions how to integrate SNMP sensors within Home Assistant.
2016-06-05 20:00
true
false
true
true
network-snmp.png
Sensor
Local Polling
0.22

The snmp sensor platform simple displays the information which are available through the Simple Network Management Protocol (SNMP). 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:

# 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 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.

$ 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