Home Assistant Home Assistant

QNAP

This qnap sensor allows getting various statistics from your QNAP NAS.

Configuration

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

# Example configuration.yaml entry
sensor:
  - platform: qnap
    host: IP_ADDRESS_OF_QNAP_NAS
    username: USERNAME
    password: PASSWORD
    monitored_conditions:
      - status
      - cpu_usage
      - memory_percent_used
      - network_tx
      - volume_percentage_used

Configuration Variables

Looking for your configuration file?
host string Required

The IP address of the QNAP NAS to monitor, i.e., 192.168.8.12.

port integer (Optional, default: 8080)

The port number on which the QNAP NAS web interface is reachable.

ssl boolean (Optional, default: false)

Whether to connect via https. You might need to configure port (i.e., 443) and verify_ssl (i.e., false) accordingly.

verify_ssl boolean (Optional, default: true)

Whether SSL certificates should be validated. Set to false if you use the default, self-signed QNap certificate.

timeout integer (Optional, default: 10)

How long (in seconds) to wait for a response from the QNAP device before giving up.

username string Required

An administration user to connect to the QNAP NAS. This user must be a member of the administration group and MFA must be disabled for that account.

password string Required

The password of the user to connect to the QNAP NAS.

drives list (Optional, default: all drives)

Array of drives to monitor (ex: 0:1).

volumes list (Optional, default: all volumes)

Array of volumes to monitor (ex: DataVol1).

nics list (Optional, default: all NICs)

Array of network interfaces to monitor (ex: eth0).

monitored_conditions list Required

Defines the stats to monitor as sensors.

status

Displays overall system health.

system_temp

Displays the overall system temperature.

cpu_temp

Displays the CPU’s temperature.

cpu_usage

Displays the CPU’s utilization as a percentage.

memory_free

Displays the size of available RAM in GB.

memory_used

Displays the size of used RAM in GB.

memory_percent_used

Displays the size of used RAM as a percentage of total RAM.

network_link_status

Displays whether the network interfaces is up (creates a new entry for each interface).

network_tx

Displays the upload speed of a network interface in MB/s (creates a new entry for each interface).

network_rx

Displays the download speed of a network interface in MB/s (creates a new entry for each interface).

drive_smart_status

Displays the S.M.A.R.T. status of the drive (creates a new entry for each drive).

drive_temp

Displays the temperature of the drive (creates a new entry for each drive).

volume_size_free

Displays the available space of the volume in GB (creates a new entry for each volume).

volume_size_used

Displays the used space of the volume in GB (creates a new entry for each volume).

volume_percentage_used

Displays the used space of the volume as a percentage (creates a new entry for each volume).

SSL and Self-signed certificates

If your QNAP device uses self-signed certificates, set the verify_ssl option to false. If you configured your device to accept SSL-only connections, please also check that you set port accordingly, or you might get an SSL: WRONG_VERSION_NUMBER error.

QNAP device support

This integration works with most (but not all) QNAP devices. A complete, up-to-date list of compatible devices can be found here.

If your QNAP device is running QTS 5, make sure you log into the device’s web interface (with the same account you’ve configured in Home Assistant) and complete any agreements, warnings, wizards, setup, etc. as the QNAP API may block requests until those are completed.