SynologyDSM Sensor


The synologydsm sensor platform allows getting various statistics from your Synology NAS.

Configuration

To use the synologydsm sensor in your installation, add the following to your configuration.yaml file:

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

host

(string)(Required)The IP address of the Synology NAS to monitor.

port

(integer)(Optional)The port number on which the Synology NAS is reachable.

Default value: 5001

username

(string)(Required)An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).

password

(string)(Required)The password of the user to connect to the Synology NAS.

ssl

(boolean)(Optional)Determine if HTTPS should be used.

Default value: true

volumes

(list)(Optional)Array of volumes to monitor. Defaults to all volumes.

disks

(list)(Optional)Array of disks to monitor. Defaults to all disks.

monitored_conditions

(list)(Required)Defines a template to extract a value from the payload.

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

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

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

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.

This sensor will wake up your Synology NAS if it’s in hibernation mode.

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.