mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-25 18:26:56 +00:00
Add config flow to Synology DSM (#12597)
* Add config flow to Synology DSM * Update source/_integrations/synology_dsm.markdown Co-Authored-By: Franck Nijhof <git@frenck.dev> * Update source/_integrations/synology_dsm.markdown Co-Authored-By: Franck Nijhof <git@frenck.dev> * Update source/_integrations/synology_dsm.markdown Co-Authored-By: Franck Nijhof <git@frenck.dev> * Update source/_integrations/synology_dsm.markdown Co-Authored-By: Franck Nijhof <git@frenck.dev> * Update source/_integrations/synology_dsm.markdown Co-Authored-By: Franck Nijhof <git@frenck.dev> * Add redirects Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Quentame
GitHub
parent
b6cae9ced9
commit
05064568aa
128
source/_integrations/synology_dsm.markdown
Normal file
128
source/_integrations/synology_dsm.markdown
Normal file
@ -0,0 +1,128 @@
|
||||
---
|
||||
title: Synology DSM
|
||||
description: Instructions on how to integrate the Synology DSM sensor within Home Assistant.
|
||||
ha_category:
|
||||
- System Monitor
|
||||
ha_release: 0.32
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: synology_dsm
|
||||
---
|
||||
|
||||
The `synology_dsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com).
|
||||
|
||||
## Configuration
|
||||
|
||||
There are two ways to integrate Synology DSM in Home Assistant.
|
||||
|
||||
### Via the frontend
|
||||
|
||||
Menu: *Configuration* -> *Integrations*. Search for "Synology DSM", fill the configuration form, click submit.
|
||||
|
||||
### Via the configuration file
|
||||
|
||||
Add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
synology_dsm:
|
||||
- host: IP_ADDRESS_OR_DNS_OF_SYNOLOGY_NAS
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name to use in the frontend for your Synology device.
|
||||
required: false
|
||||
default: Synology DSM
|
||||
type: string
|
||||
host:
|
||||
description: The IP address or DNS of the Synology NAS to monitor.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The port number on which the Synology NAS is reachable.
|
||||
required: false
|
||||
default: 5001 if `ssl` is true, 5000 if `ssl` is false
|
||||
type: integer
|
||||
ssl:
|
||||
description: Determine if HTTPS should be used.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
username:
|
||||
description: An user to connect to the Synology NAS (a separate account is advised, see the (Separate User Configuration)[#separate-user-configuration] section below for details).
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password of the user to connect to the Synology NAS.
|
||||
required: true
|
||||
type: string
|
||||
api_version:
|
||||
description: Define DSM version to allow backward compatibility with 5.x. Value can be `5` for DSM 5.x or `6` for DSM 6.x.
|
||||
required: false
|
||||
default: 6
|
||||
type: integer
|
||||
volumes:
|
||||
description: "Array of volumes to monitor. Defaults to all volumes. Replace any spaces in the volume name with underscores, e.g., `volume 1` with `volume_1`."
|
||||
required: false
|
||||
type: list
|
||||
disks:
|
||||
description: "Array of disks to monitor. Defaults to all disks. Use only disk names like `sda`, `sdb`, etc."
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
This sensor will wake up your Synology NAS if it's in hibernation mode.
|
||||
|
||||
</div>
|
||||
|
||||
## Separate User Configuration
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Using two-factor authentication is not supported. Please use a strong, randomly generated password.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
## Created sensors
|
||||
|
||||
Sensors are :
|
||||
- `cpu_other_load`: Displays unspecified load in percentage.
|
||||
- `cpu_user_load`: Displays user load in percentage.
|
||||
- `cpu_system_load`: Displays system load in percentage.
|
||||
- `cpu_total_load`: Displays combined load in percentage.
|
||||
- `cpu_1min_load`: Displays maximum load in past minute.
|
||||
- `cpu_5min_load`: Displays maximum load in past 5 minutes.
|
||||
- `cpu_15min_load`: Displays maximum load in past 15 minutes.
|
||||
- `memory_real_usage`: Displays percentage of memory used.
|
||||
- `memory_size`: Displays total size of memory in MB.
|
||||
- `memory_cached`: Displays total size of cache in MB.
|
||||
- `memory_available_swap`: Displays total size of available swap in MB.
|
||||
- `memory_available_real`: Displays total size of memory used (based on real memory) in MB.
|
||||
- `memory_total_swap`: Displays total size of actual memory in MB.
|
||||
- `memory_total_real`: Displays total size of real memory in MB.
|
||||
- `network_up`: Displays total up speed of network interfaces (combines all interfaces).
|
||||
- `network_down`: Displays total down speed of network interfaces (combines all interfaces).
|
||||
- `disk_name`: Displays the name of the hard disk (creates a new entry for each disk).
|
||||
- `disk_device`: Displays the path of the hard disk (creates a new entry for each disk).
|
||||
- `disk_smart_status`: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk).
|
||||
- `disk_status`: Displays the status of the hard disk (creates a new entry for each disk).
|
||||
- `disk_exceed_bad_sector_thr`: Displays true / false to indicate if the hard disk exceeded the maximum bad sector threshold (creates a new entry for each disk). (Does not work with DSM 5.x)
|
||||
- `disk_below_remain_life_thr`: Displays true / false to indicate if the hard disk dropped below the remain life threshold (creates a new entry for each disk). (Does not work with DSM 5.x)
|
||||
- `disk_temp`: Displays the temperature of the hard disk (creates a new entry for each disk, uses the unit_system to display in C or F).
|
||||
- `volume_status`: Displays the status of the volume (creates a new entry for each volume).
|
||||
- `volume_device_type`: Displays the volume type (RAID, etc) (creates a new entry for each volume).
|
||||
- `volume_size_total`: Displays the total size of the volume in GB's (creates a new entry for each volume).
|
||||
- `volume_size_used`: Displays the used space on this volume in GB's (creates a new entry for each volume).
|
||||
- `volume_percentage_used`: Displays the percentage used for this volume in GB's (creates a new entry for each volume).
|
||||
- `volume_disk_temp_avg`: Displays the average temperature of all disks in the volume (creates a new entry for each volume).
|
||||
- `volume_disk_temp_max`: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).
|
||||
@ -1,152 +0,0 @@
|
||||
---
|
||||
title: SynologyDSM
|
||||
description: Instructions on how to integrate the SynologyDSM sensor within Home Assistant.
|
||||
ha_category:
|
||||
- System Monitor
|
||||
ha_release: 0.32
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: synologydsm
|
||||
---
|
||||
|
||||
The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com).
|
||||
|
||||
## Configuration
|
||||
|
||||
To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: synologydsm
|
||||
host: IP_ADDRESS_OF_SYNOLOGY_NAS
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
monitored_conditions:
|
||||
- cpu_total_load
|
||||
- memory_real_usage
|
||||
- network_up
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name to use in the frontend for your Synology device.
|
||||
required: false
|
||||
default: Synology DSM
|
||||
type: string
|
||||
host:
|
||||
description: The IP address of the Synology NAS to monitor.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The port number on which the Synology NAS is reachable.
|
||||
required: false
|
||||
default: 5001
|
||||
type: integer
|
||||
username:
|
||||
description: An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password of the user to connect to the Synology NAS.
|
||||
required: true
|
||||
type: string
|
||||
api_version:
|
||||
description: Define DSM version to allow backward compatibility with 5.x. Value can be `5` for DSM 5.x or `6` for DSM 6.x or later.
|
||||
type: integer
|
||||
required: false
|
||||
ssl:
|
||||
description: Determine if HTTPS should be used.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
volumes:
|
||||
description: "Array of volumes to monitor. Defaults to all volumes. Replace any spaces in the volume name with underscores, e.g., `volume 1` with `volume_1`."
|
||||
required: false
|
||||
type: list
|
||||
disks:
|
||||
description: "Array of disks to monitor. Defaults to all disks. Use only disk names like `sda`, `sdb`, etc."
|
||||
required: false
|
||||
type: list
|
||||
monitored_conditions:
|
||||
description: Defines a [template](/topics/templating/) to extract a value from the payload.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
cpu_other_load:
|
||||
description: Displays unspecified load in percentage.
|
||||
cpu_user_load:
|
||||
description: Displays user load in percentage.
|
||||
cpu_system_load:
|
||||
description: Displays system load in percentage.
|
||||
cpu_total_load:
|
||||
description: Displays combined load in percentage.
|
||||
cpu_1min_load:
|
||||
description: Displays maximum load in past minute.
|
||||
cpu_5min_load:
|
||||
description: Displays maximum load in past 5 minutes.
|
||||
cpu_15min_load:
|
||||
description: Displays maximum load in past 15 minutes.
|
||||
memory_real_usage:
|
||||
description: Displays percentage of memory used.
|
||||
memory_size:
|
||||
description: Displays total size of memory in MB.
|
||||
memory_cached:
|
||||
description: Displays total size of cache in MB.
|
||||
memory_available_swap:
|
||||
description: Displays total size of available swap in MB.
|
||||
memory_available_real:
|
||||
description: Displays total size of memory used (based on real memory) in MB.
|
||||
memory_total_swap:
|
||||
description: Displays total size of actual memory in MB.
|
||||
memory_total_real:
|
||||
description: Displays total size of real memory in MB.
|
||||
network_up:
|
||||
description: Displays total up speed of network interfaces (combines all interfaces).
|
||||
network_down:
|
||||
description: Displays total down speed of network interfaces (combines all interfaces).
|
||||
disk_name:
|
||||
description: Displays the name of the hard disk (creates a new entry for each disk).
|
||||
disk_device:
|
||||
description: Displays the path of the hard disk (creates a new entry for each disk).
|
||||
disk_smart_status:
|
||||
description: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk).
|
||||
disk_status:
|
||||
description: Displays the status of the hard disk (creates a new entry for each disk).
|
||||
disk_exceed_bad_sector_thr:
|
||||
description: Displays true / false to indicate if the hard disk exceeded the maximum bad sector threshold (creates a new entry for each disk). (Does not work with DSM 5.x)
|
||||
disk_below_remain_life_thr:
|
||||
description: Displays true / false to indicate if the hard disk dropped below the remain life threshold (creates a new entry for each disk). (Does not work with DSM 5.x)
|
||||
disk_temp:
|
||||
description: Displays the temperature of the hard disk (creates a new entry for each disk, uses the unit_system to display in C or F).
|
||||
volume_status:
|
||||
description: Displays the status of the volume (creates a new entry for each volume).
|
||||
volume_device_type:
|
||||
description: Displays the volume type (RAID, etc) (creates a new entry for each volume).
|
||||
volume_size_total:
|
||||
description: Displays the total size of the volume in GB's (creates a new entry for each volume).
|
||||
volume_size_used:
|
||||
description: Displays the used space on this volume in GB's (creates a new entry for each volume).
|
||||
volume_percentage_used:
|
||||
description: Displays the percentage used for this volume in GB's (creates a new entry for each volume).
|
||||
volume_disk_temp_avg:
|
||||
description: Displays the average temperature of all disks in the volume (creates a new entry for each volume).
|
||||
volume_disk_temp_max:
|
||||
description: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
<div class='note warning'>
|
||||
This sensor will wake up your Synology NAS if it's in hibernation mode.
|
||||
</div>
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
If you set `ssl:` to `False`, you *have* to also explicitly set `port:` to **5000**.
|
||||
|
||||
</div>
|
||||
|
||||
## Separate User Configuration
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
@ -872,7 +872,7 @@
|
||||
/components/sensor.swiss_hydrological_data /integrations/swiss_hydrological_data
|
||||
/components/sensor.swiss_public_transport /integrations/swiss_public_transport
|
||||
/components/sensor.syncthru /integrations/syncthru
|
||||
/components/sensor.synologydsm /integrations/synologydsm
|
||||
/components/sensor.synologydsm /integrations/synology_dsm
|
||||
/components/sensor.systemmonitor /integrations/systemmonitor
|
||||
/components/sensor.sytadin /integrations/sytadin
|
||||
/components/sensor.tado /integrations/tado
|
||||
@ -1865,7 +1865,7 @@
|
||||
/components/synology /integrations/synology
|
||||
/components/synology_chat /integrations/synology_chat
|
||||
/components/synology_srm /integrations/synology_srm
|
||||
/components/synologydsm /integrations/synologydsm
|
||||
/components/synologydsm /integrations/synology_dsm
|
||||
/components/syslog /integrations/syslog
|
||||
/components/system_health /integrations/system_health
|
||||
/components/system_log /integrations/system_log
|
||||
@ -2030,6 +2030,7 @@
|
||||
|
||||
# Breaking changes
|
||||
/integrations/switch.pca /integrations/elv
|
||||
/integrations/synologydsm /integrations/synology_dsm
|
||||
/integrations/telegram_chatbot /integrations/telegram_bot
|
||||
|
||||
# Moved documentation
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user