Skip to main content

Python API for obtaining QNAP NAS system stats

Project description

Build Status Supported Python Versions

Library from obtaining system information from QNAP NAS devices.

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())

Note: The user you connect with must be in the admin group.

Device Support

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

Model QTS Firmware Versions Notes
TS-110 4.2.4  
TS-210 4.2.6 This device does not report CPU temps
TS-219P II 4.3.3 User-reported: no automated tests
TS-251B 4.4.3  
TS-253 Pro 4.5.2  
TS-269L 4.3.3 User-reported: no automated tests
TS-410 4.2.3 This device does not report CPU temps
TS-412 4.3.3 This device does not report CPU temps
TS-431P 4.3.4  
TS-451 4.2.2 - 4.2.4  
TS-453A 4.3.4  
TS-453Be 4.2.3  
TS-639 4.2.3  
TS-659 4.2.6 May report None for some disk temps
TS-1677XU-RP 4.5.2  
TS-EC1280U 4.5.2  

Other QNAP devices using these 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!)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qnapstats, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size qnapstats-0.3.1.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page