290 lines
16 KiB
HTML
290 lines
16 KiB
HTML
<!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>SynologyDSM Sensor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate the SynologyDSM sensor within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.synologydsm/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="SynologyDSM Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.synologydsm/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate the SynologyDSM sensor 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="SynologyDSM Sensor">
|
||
<meta name="twitter:description" content="Instructions how to integrate the SynologyDSM sensor 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">
|
||
SynologyDSM Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>This <code class="highlighter-rouge">synologydsm</code> sensor allows getting various statistics from your <a href="https://www.synology.com">Synology NAS</a>.</p>
|
||
<p>To use the <code class="highlighter-rouge">synologydsm</code> 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.yml 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">synologydsm</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS_OF_SYNOLOGY_NAS</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">USERNAME</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">PASSWORD</span>
|
||
<span class="s">monitored_conditions</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">cpu_total_load</span>
|
||
<span class="pi">-</span> <span class="s">memory_real_usage</span>
|
||
<span class="pi">-</span> <span class="s">network_up</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): The IP address of the Synology NAS to monitor</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): The port number on which the Synology NAS is reachable. Defaults to <code class="highlighter-rouge">5000</code>.</li>
|
||
<li><strong>username</strong> (<em>Required</em>): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).</li>
|
||
<li><strong>password</strong> (<em>Required</em>): The password of the user to connect to the Synology NAS.</li>
|
||
<li><strong>volumes</strong> (<em>Optional</em>): Array of volumes to monitor. Defaults to all volumes.</li>
|
||
<li><strong>disks</strong> (<em>Optional</em>): Array of disks to monitor. Defaults to all disks.</li>
|
||
<li><strong>monitored_conditions</strong> (<em>Required</em>): Defines a <a href="/topics/templating/">template</a> to extract a value from the payload.
|
||
<ul>
|
||
<li><strong>cpu_other_load</strong>: Displays unspecified load in percentage.</li>
|
||
<li><strong>cpu_user_load</strong>: Displays user load in percentage.</li>
|
||
<li><strong>cpu_system_load</strong>: Displays system load in percentage.</li>
|
||
<li><strong>cpu_total_load</strong>: Displays combined load in percentage.</li>
|
||
<li><strong>cpu_1min_load</strong>: Displays maximum load in past minute.</li>
|
||
<li><strong>cpu_5min_load</strong>: Displays maximum load in past 5 minutes.</li>
|
||
<li><strong>cpu_15min_load</strong>: Displays maximum load in past 15 minutes.</li>
|
||
<li><strong>memory_real_usage</strong>: Displays percentage of memory used.</li>
|
||
<li><strong>memory_size</strong>: Displays total size of memory in MB.</li>
|
||
<li><strong>memory_cached</strong>: Displays total size of cache in MB.</li>
|
||
<li><strong>memory_available_swap</strong>: Displays total size of available swap in MB.</li>
|
||
<li><strong>memory_available_real</strong>: Displays total size of memory used (based on real memory) in MB.</li>
|
||
<li><strong>memory_total_swap</strong>: Displays total size of actual memory in MB.</li>
|
||
<li><strong>memory_total_real</strong>: Displays total size of real memory in MB.</li>
|
||
<li><strong>network_up</strong>: Displays total up speed of network interfaces (combines all interfaces).</li>
|
||
<li><strong>network_down</strong>: Displays total down speed of network interfaces (combines all interfaces).</li>
|
||
<li><strong>disk_name</strong>: Displays the name of the hard disk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_device</strong>: Displays the path of the hard disk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_smart_status</strong>: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_status</strong>: Displays the status of the hard disk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_exceed_bad_sector_thr</strong>: Displays true / false to indicate if the hard disk exceeded the maximum bad sector threshold (creates a new entry for each disk).</li>
|
||
<li><strong>disk_below_remain_life_thr</strong>: Displays true / false to indicate if the hard disk dropped below the remain life threshold (creates a new entry for each disk).</li>
|
||
<li><strong>disk_temp</strong>: Displays the temperature of the hard disk (creates a new entry for each disk, uses the unit_system to display in C or F).</li>
|
||
<li><strong>volume_status</strong>: Displays the status of the volume (creates a new entry for each volume).</li>
|
||
<li><strong>volume_device_type</strong>: Displays the volume type (RAID, etc) (creates a new entry for each volume).</li>
|
||
<li><strong>volume_size_total</strong>: Displays the total size of the volume in GB’s (creates a new entry for each volume).</li>
|
||
<li><strong>volume_size_used</strong>: Displays the used space on this volume in GB’s (creates a new entry for each volume).</li>
|
||
<li><strong>volume_percentage_used</strong>: Displays the percentage used for this volume in GB’s (creates a new entry for each volume).</li>
|
||
<li><strong>volume_disk_temp_avg</strong>: Displays the average temperature of all disks in the volume (creates a new entry for each volume).</li>
|
||
<li><strong>volume_disk_temp_max</strong>: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="note">
|
||
After booting Home Assistant it can take up to 15 minutes for the sensors to show up. This is due to the fact that sensors are created after Home Assistant has fully been initialized.
|
||
</p>
|
||
<p class="note warning">
|
||
This sensor will wake up your Synology NAS if it’s in hibernation mode.
|
||
</p>
|
||
<h2><a class="title-link" name="separate-user-configuration" href="#separate-user-configuration"></a> Separate User Configuration</h2>
|
||
<p>Due to the nature of the Synology DSM API it is required to grant the user admin rights. This is related to the fact that utilization information is stored in the core module.</p>
|
||
<p>When creating the user it is possible to deny access to all locations and applications. By doing this the user will not be able to login to the web interface or view any of the files on the Synology NAS. It is still able to read the utilization and storage information using the API.</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.synologydsm.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/synology.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.32
|
||
</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>
|
||
<a href='/components/sensor.snmp/'>SNMP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.supervisord/'>Supervisord</a>
|
||
</li>
|
||
<li>
|
||
SynologyDSM Sensor
|
||
</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>
|