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

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

Project details


Download files

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

Source Distribution

qnapstats-0.4.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

qnapstats-0.4.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file qnapstats-0.4.0.tar.gz.

File metadata

  • Download URL: qnapstats-0.4.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for qnapstats-0.4.0.tar.gz
Algorithm Hash digest
SHA256 67df28dd56c69d42fa373e6a68c8a171b074ccad3e36b5ff701fd436c38ac070
MD5 a7931e316d0202b0d0200ff176d1163f
BLAKE2b-256 121c2cf54f392dbbb321de80d2aa858e5c2820f52fd7afe41f2c24eb1bb165ac

See more details on using hashes here.

File details

Details for the file qnapstats-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: qnapstats-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for qnapstats-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f1924d9749f727abfee73abd61a31b4681a8b17976d7e20fe089c3242e73549
MD5 d8ec684498c42a40480562007db5df90
BLAKE2b-256 c126d3bb3dd0c235a345a3f2301ed31def858a8e75ac436363a8ba4c64e814b0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page