Update for QNAP config_flow (#24602)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
disforw 2023-06-27 12:27:26 -04:00 committed by GitHub
parent ce773e66d4
commit d12cda00ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,120 +6,26 @@ ha_category:
ha_release: 0.38
ha_iot_class: Local Polling
ha_domain: qnap
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
---
This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/).
The QNAP integration allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/).
## Configuration
{% include integrations/config_flow.md %}
To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file:
## Integration entities
```yaml
# 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 %}
host:
description: The IP address of the QNAP NAS to monitor, i.e., `192.168.8.12`.
required: true
type: string
port:
description: The port number on which the QNAP NAS web interface is reachable.
required: false
default: 8080
type: integer
ssl:
description: Whether to connect via `https`. You might need to configure `port` (i.e., `443`) and `verify_ssl` (i.e., `false`) accordingly.
required: false
default: false
type: boolean
verify_ssl:
description: Whether SSL certificates should be validated. Set to `false` if you use the default, self-signed QNap certificate.
required: false
default: true
type: boolean
timeout:
description: How long (in seconds) to wait for a response from the QNAP device before giving up.
required: false
default: 10
type: integer
username:
description: 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.
required: true
type: string
password:
description: The password of the user to connect to the QNAP NAS.
required: true
type: string
drives:
description: "Array of drives to monitor (ex: `0:1`)."
required: false
default: all drives
type: list
volumes:
description: "Array of volumes to monitor (ex: `DataVol1`)."
required: false
default: all volumes
type: list
nics:
description: "Array of network interfaces to monitor (ex: `eth0`)."
required: false
default: all NICs
type: list
monitored_conditions:
description: Defines the stats to monitor as sensors.
required: true
type: list
keys:
status:
description: Displays overall system health.
system_temp:
description: Displays the overall system temperature.
cpu_temp:
description: Displays the CPU's temperature.
cpu_usage:
description: Displays the CPU's utilization as a percentage.
memory_free:
description: Displays the size of available RAM in GB.
memory_used:
description: Displays the size of used RAM in GB.
memory_percent_used:
description: Displays the size of used RAM as a percentage of total RAM.
network_link_status:
description: Displays whether the network interfaces is up (creates a new entry for each interface).
network_tx:
description: Displays the upload speed of a network interface in MB/s (creates a new entry for each interface).
network_rx:
description: Displays the download speed of a network interface in MB/s (creates a new entry for each interface).
drive_smart_status:
description: Displays the S.M.A.R.T. status of the drive (creates a new entry for each drive).
drive_temp:
description: Displays the temperature of the drive (creates a new entry for each drive).
volume_size_free:
description: Displays the available space of the volume in GB (creates a new entry for each volume).
volume_size_used:
description: Displays the used space of the volume in GB (creates a new entry for each volume).
volume_percentage_used:
description: Displays the used space of the volume as a percentage (creates a new entry for each volume).
{% endconfiguration %}
### 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.
The QNAP integration will add the following sensors:
- System: status, system temperature
- CPU: usage, temperature
- Memory: usage, free, used, total
- Volume: usage, used
- Folders: usage, used
- Drives: smart status, usage
- Network: bandwidth, status
### QNAP device support