jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sensor.snmp/index.html
Travis CI 5ec8b663ab Site updated at 2017-08-27 21:55:29 UTC
2017-08-27 21:55:29 +00:00

283 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>SNMP - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate SNMP sensors within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.snmp/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="SNMP">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.snmp/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate SNMP sensors within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="SNMP">
<meta name="twitter:description" content="Instructions how to integrate SNMP sensors within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
SNMP
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">snmp</code> sensor platform displays information available through the <a href="https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol">Simple Network Management Protocol (SNMP)</a>. SNMP uses a tree-like hierarchy where each node is an object, and is mainly supported by network-oriented devices such as routers, modems, and printers.</p>
<p>To enable this sensor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">snmp</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.32</span>
<span class="s">baseoid</span><span class="pi">:</span> <span class="s">1.3.6.1.4.1.2021.10.1.3.1</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your host, eg. <code class="highlighter-rouge">192.168.1.32</code>.</li>
<li><strong>baseoid</strong> (<em>Required</em>): The OID where the information is located. It’s advised to use the numerical notation.</li>
<li><strong>port</strong> (<em>Option</em>): The SNMP port of your host. Defaults to <code class="highlighter-rouge">161</code>.</li>
<li><strong>community</strong> (<em>Optional</em>): The SNMP community which is set for the device. Most devices have a default community set to to <code class="highlighter-rouge">public</code> with read-only permission (which is sufficient).</li>
<li><strong>version</strong> (<em>Optional</em>) version of SNMP protocol, <code class="highlighter-rouge">1</code> or <code class="highlighter-rouge">2c</code>. Defaults to <code class="highlighter-rouge">1</code>. Version <code class="highlighter-rouge">2c</code> is needed to read data from 64-bit counters.</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the SNMP sensor.</li>
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the unit of measurement of the sensor, if any.</li>
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/docs/configuration/templating/#processing-incoming-data">template</a> to parse the value.</li>
<li><strong>accept_errors</strong> (<em>Optional</em>): Determines whether the sensor should start and keep working even if the SNMP host is unreachable or not responding. This allows the sensor to be initialized properly even if, for example, your printer is not on when you start Home Assistant. Defaults to <code class="highlighter-rouge">false</code>.</li>
<li><strong>default_value</strong> (<em>Optional</em>): Determines what value the sensor should take if <code class="highlighter-rouge">accept_errors</code> is set and the host is unreachable or not responding. If not set, the sensor will have value <code class="highlighter-rouge">unknown</code> in case of errors.</li>
</ul>
<h2><a class="title-link" name="finding-oids" href="#finding-oids"></a> Finding OIDs</h2>
<p>OIDs may vary on different systems because they are vendor-specific. Beside the device’s manual, the <a href="http://www.oid-info.com/">OID Repository</a> is a good place to start if you are looking for OIDs. As an example, the following OIDs are for the load of a Linux systems.</p>
<ul>
<li>1 minute Load: <code class="highlighter-rouge">1.3.6.1.4.1.2021.10.1.3.1</code></li>
<li>5 minute Load: <code class="highlighter-rouge">1.3.6.1.4.1.2021.10.1.3.2</code></li>
<li>15 minute Load: <code class="highlighter-rouge">1.3.6.1.4.1.2021.10.1.3.3</code></li>
</ul>
<p>There is a large amount of tools available to work with SNMP. <code class="highlighter-rouge">snmpwalk</code> let you easily retrieve the value of a OID.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>snmpwalk -Os -c public -v 2c 192.168.1.32 1.3.6.1.4.1.2021.10.1.3.1
laLoad.1 <span class="o">=</span> STRING: 0.19
</code></pre>
</div>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<h3><a class="title-link" name="printer-uptime-minutes" href="#printer-uptime-minutes"></a> Printer uptime minutes</h3>
<p>According to the most common SNMP standard, the uptime of a device is accessible under OID <code class="highlighter-rouge">1.3.6.1.2.1.1.3.0</code>. The value represented using a format called <code class="highlighter-rouge">TimeTicks</code>, in units of hundredth of a second.</p>
<p>To create a sensor that displays the uptime for your printer in minutes, you can use this configuration:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">snmp</span>
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Printer</span><span class="nv"> </span><span class="s">uptime'</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.2.21</span>
<span class="s">baseoid</span><span class="pi">:</span> <span class="s">1.3.6.1.2.1.1.3.0</span>
<span class="s">accept_errors</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">minutes'</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{((value</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">int)</span><span class="nv"> </span><span class="s">/</span><span class="nv"> </span><span class="s">6000)</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">int}}'</span>
</code></pre>
</div>
<p>The <code class="highlighter-rouge">accept_errors</code> option will allow the sensor to work even if the printer is not on when Home Assistant is first started: the sensor will just display a <code class="highlighter-rouge">-</code> instead of a minute count.</p>
<p>The <code class="highlighter-rouge">value_template</code> option converts the original value to minutes.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.snmp.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/network-snmp.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.22
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/device_tracker.snmp/'>
SNMP
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category System Monitor</h1>
<ul class='divided'>
<li>
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
</li>
<li>
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.cups/'>CUPS Sensor</a>
</li>
<li>
<a href='/components/sensor.cert_expiry/'>Certificate Expiry</a>
</li>
<li>
<a href='/components/binary_sensor.digital_ocean/'>Digital Ocean Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.dovado/'>Dovado</a>
</li>
<li>
<a href='/components/sensor.fritzbox_callmonitor/'>FRITZ!Box Call Monitor</a>
</li>
<li>
<a href='/components/sensor.fritzbox_netmonitor/'>FRITZ!Box Net Monitor</a>
</li>
<li>
<a href='/components/sensor.fastdotcom/'>Fast.com</a>
</li>
<li>
<a href='/components/sensor.glances/'>Glances</a>
</li>
<li>
<a href='/components/sensor.google_wifi/'>Google Wifi</a>
</li>
<li>
<a href='/components/sensor.hddtemp/'>HDDTemp</a>
</li>
<li>
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
</li>
<li>
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
</li>
<li>
<a href='/components/sensor.nut/'>NUT Sensor</a>
</li>
<li>
<a href='/components/sensor.netdata/'>Netdata</a>
</li>
<li>
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
</li>
<li>
SNMP
</li>
<li>
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
</li>
<li>
<a href='/components/sensor.supervisord/'>Supervisord</a>
</li>
<li>
<a href='/components/sensor.synologydsm/'>SynologyDSM Sensor</a>
</li>
<li>
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
</li>
<li>
<a href='/components/zabbix/'>Zabbix</a>
</li>
<li>
<a href='/components/sensor.zabbix/'>Zabbix Sensor</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink