Skip to main content

python-qnapstats

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

D4 Pro

4.5.1

User-reported: no automated tests

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-251+

4.5.1

No information on dnsInfo

TS-253 Pro

4.5.2

TS-253D

4.5.3

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

TS-X53

4.5.4

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

Metadata

Release files for qnapstats 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qnapstats 0.4.0
File Size Uploaded
qnapstats-0.4.0.tar.gz 6.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qnapstats 0.4.0
File Interpreter ABI Platform
qnapstats-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 13.6 kB

Release files / qnapstats-0.4.0.tar.gz

Download URL qnapstats-0.4.0.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
67df28dd56c69d42fa373e6a68c8a171b074ccad3e36b5ff701fd436c38ac070
BLAKE2b-256 checksum
How to use checksums
121c2cf54f392dbbb321de80d2aa858e5c2820f52fd7afe41f2c24eb1bb165ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

Release files / qnapstats-0.4.0-py3-none-any.whl

Download URL qnapstats-0.4.0-py3-none-any.whl
Size 7.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3f1924d9749f727abfee73abd61a31b4681a8b17976d7e20fe089c3242e73549
BLAKE2b-256 checksum
How to use checksums
c126d3bb3dd0c235a345a3f2301ed31def858a8e75ac436363a8ba4c64e814b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.1

1 release file

0.3.0

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page