Skip to content

Update QNAP sensor docs with new features and information #2112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabaff merged 1 commit into from
Feb 23, 2017
Merged

Update QNAP sensor docs with new features and information #2112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions source/_components/sensor.qnap.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,15 @@ Configuration variables:
- **port** (*Optional*): The port number on which the QNAP NAS web interface is reachable. Defaults to `8080`.
- **ssl** (*Optional*): Whether to connect via `https`. Defaults to `false`.
- **verify_ssl** (*Optional*): Whether SSL certificates should be validated. Defaults to `true`.
- **timeout** (*Optional*): How long (in seconds) to wait for a response from the QNAP device before giving up. Defaults to `10`.
- **username** (*Required*): An user to connect to the QNAP NAS.
- **password** (*Required*): The password of the user to connect to the QNAP NAS.
- **drives** (*Optional*): Array of drives to monitor (ex: `0:1`). Defaults to all drives.
- **volumes** (*Optional*): Array of volumes to monitor (ex: `DataVol1`). Defaults to all volumes.
- **nics** (*Optional*): Array of network interfaces to monitor (ex: `eth0`). Defaults to all NICs.
- **monitored_conditions** (*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.
Expand All @@ -66,5 +68,10 @@ If your QNAP device uses self-signed certificates, set the `verify_ssl` option t

### QNAP device support:

This component has been tested on a TS-451 running QTS 4.2.2. Other QNAP NAS devices using similar firmware should work fine.
For more information about supported devices, or to report issues with your device, please visit the [qnapstats project](https://github.com/colinodell/python-qnapstats#device-support).
This component has been tested on the following devices:

- TS-410 (QTS 4.2.3)
- TS-451 (QTS 4.2.2)
- TS-639 (QTS 4.2.3)

Other QNAP NAS devices using similar firmware should work fine. For more information about supported devices, or to report issues with your device, please visit the [qnapstats project](https://github.com/colinodell/python-qnapstats#device-support).