Installation

This library requires xmltodict, so make sure you have that installed:

pip3 install xmltodict>=0.10.0

Then install this Python module:

pip3 install qnapstats

Usage Example

#!/usr/bin/env python3
from qnapstats import QNAPStats
from pprint import pprint

qnap = QNAPStats('192.168.1.3', 8080, 'admin', 'correcthorsebatterystaple')

pprint(qnap.get_system_stats())
pprint(qnap.get_system_health())
pprint(qnap.get_smart_disk_health())
pprint(qnap.get_volumes())
pprint(qnap.get_bandwidth())

Account

The account you connect with must have system monitoring permissions. The simplest option is to put it in the admin group; it doesn’t necessarily need to be THE “administrator” account, but you can use some account in the administrators group.

Alternatively you can configure a normal account and enable Delegated Administration in control panel, and activate “System Monitoring.”

Once the account is created, and/or you upgrade to a newer of like QTS 5, also be sure to log into your NAS and complete any agreements, warnings, wizards, etc. that may prevent this library from using the QNAP API.

MFA/2FA must also be disabled for that user for this library to work.

Device Support

This library has been tested against the following devices and firmwares:

⚠️ QuTS is not currently supported - see [issue #84](https://github.com/colinodell/python-qnapstats/issues/84)

Other QNAP devices using these QTS firmwares should probably work fine, as should the devices listed above on newer firmwares. If you encounter any compatibility issues, please let us know (or better yet, contribute a patch!)

Upgrading to QTS 5? Make sure the account you connect with meets the criteria listed earlier in this README. Also be sure to log into your NAS and complete any agreements, warnings, wizards, etc. that may prevent this library from using the QNAP API.