A comprehensive Home Assistant custom integration for Synology NAS, exposing
all DSM subsystems as sensors, binary sensors, switches, and services —
powered by synology-api.
All sensors, binary sensors, and switches are dynamically discovered
from your NAS via the synology-api
library — no hardcoded entities.
- System: model, DSM version, serial, RAM, CPU temperature, uptime
- Performance: CPU utilization, memory utilization
- Health: system health status, overall status, DSM update available
- Security: security advisor rating and general info
- Docker: container count (total)
- Downloads: active download count
- File Station: service status
- Storage: volume info, per-disk temperature, SMART status
- Network: interface details, firewall, DDNS, QuickConnect
- Docker: per-container stats, images, resources
- Security Advisor: scan results, login activity, checklist
- Audio Station, Photos, VPN, Virtualization, Cloud Sync, DHCP, LDAP
- Log Center, Snapshots, Backup, Certificates, Users, Shares, Groups
- USB Copy, Note Station, Drive Admin Console, and more
synology_pro.create_snapshot— Create a share snapshotsynology_pro.delete_snapshot— Delete a share snapshotsynology_pro.restart_container— Restart a Docker containersynology_pro.update_container— Pull latest image & recreatesynology_pro.run_security_scan— Trigger Security Advisor scan
- Click the badge above (or go to HACS → Integrations → ⋮ → Custom repositories)
- Add
https://github.com/N4S4/homeassistant-synology-proas an Integration type - Search for "Synology Pro" and install
- Restart Home Assistant
- Go to Settings → Devices & Services → Add Integration → search "Synology Pro"
cd /path/to/homeassistant/config/custom_components
git clone https://github.com/N4S4/homeassistant-synology-pro.git synology_proThen restart HA and add the integration via the UI.
The integration uses the Home Assistant config flow (UI):
| Field | Description | Default |
|---|---|---|
| Host | NAS IP address or hostname | — |
| Port | DSM port | 5001 |
| Username | DSM account with admin rights | — |
| Password | DSM password | — |
| Use SSL | Enable HTTPS | ✅ On |
| Verify SSL | Validate certificate | ❌ Off |
| DSM Version | 6 or 7 | 7 |
| Poll Interval | Sensor refresh (seconds) | 60 |
# Alert when NAS CPU temperature gets too high
- alias: "NAS Temperature Alert"
trigger:
- platform: numeric_state
entity_id: sensor.synology_nas_192_168_1_2_core_sys_info_dsm_info_temperature
above: 55
action:
- service: notify.telegram
data:
message: >-
🔥 NAS is at
{{ states('sensor.synology_nas_192_168_1_2_core_sys_info_dsm_info_temperature') }}°C!
# Get notified when a DSM update is available
- alias: "DSM Update Available"
trigger:
- platform: state
entity_id: sensor.synology_nas_192_168_1_2_core_sys_info_upgrade_status_available_version
action:
- service: notify.telegram
data:
message: >-
📦 DSM {{ states('sensor.synology_nas_192_168_1_2_core_sys_info_upgrade_status_available_version') }}
is available!
# Create daily snapshots at 3 AM
- alias: "Daily NAS Snapshot"
trigger:
- platform: time
at: "03:00:00"
action:
- service: synology_pro.create_snapshot
data:
share: "Documents"
description: "Daily auto-snapshot"All entities are dynamically discovered from your NAS via the
synology-api Python library —
every available API endpoint is probed and its data exposed as sensors.
The integration scans 25+ DSM modules (System Info, Docker, Download Station, File Station, Security Advisor, Audio Station, VPN, Virtualization, Log Center, Snapshots, Photos, Cloud Sync, DHCP, LDAP, OAuth, USB Copy, Note Station, and more). Depending on your NAS configuration and account permissions, this can produce 2,000+ entities.
Only ~20 entities start enabled. Everything else is disabled by default and won't clutter your dashboard. You enable the ones you need manually.
Entities are named dynamically based on the API response:
sensor.synology_nas_<ip>_<module>_<method>_<field>
binary_sensor.synology_nas_<ip>_<module>_<method>_<field>
Examples:
sensor.synology_nas_192_168_1_2_core_sys_info_dsm_info_model→DS218+sensor.synology_nas_192_168_1_2_core_sys_info_dsm_info_temperature→42sensor.synology_nas_192_168_1_2_core_sys_info_get_cpu_utilization_system_load→5.2binary_sensor.synology_nas_192_168_1_2_core_sys_info_dsm_info_temperature_warn→off
Only the most useful sensors start active:
| Group | Methods | What you see |
|---|---|---|
| System | dsm_info |
Model, serial, DSM version, RAM, temperature, uptime |
| Performance | cpu_utilization, memory_utilization |
CPU load, RAM usage |
| Health | system_health, sys_status, upgrade_status |
Overall health, update available |
| Security | security_advisor.general_info |
Security rating |
| Docker | containers.count |
Total container count |
| Downloads | tasks_list.count |
Active download count |
| File Station | get_info |
File Station status |
- Go to Settings → Devices & Services → Synology NAS → N entities disabled
- Browse the disabled entities grouped by module
- Enable the ones you want with one click
Tip for admin accounts: if you use a DSM administrator account, the number of discovered entities grows significantly (2,000+). The curated default keeps your dashboard clean — enable only what you need.
The number of entities depends on your DSM account's privileges:
| Account Type | Typical Entities | Modules Available |
|---|---|---|
| User | ~500 | File Station, Download Station, basic info |
| Admin | ~2,000+ | All modules including Docker, Security Advisor, Logs, VPN, etc. |
Use a restricted account for a leaner integration, or an admin account for full visibility.
- Home Assistant 2024.1+
- Python 3.9+
synology-apilibrary (auto-installed)
Pull requests welcome! See CONTRIBUTING.md.
GPL-3.0 — see LICENSE.
- synology-api — Python wrapper for Synology DSM APIs
- synology-dashboard — Web dashboard for NAS management
- synology-api-recipes — Cookbook of ready-to-use scripts
© 2026 Renato Visaggio. Licensed under GPL-3.0.