Python API for communication with Synology DSM
Project description
Installation
[sudo] pip install python-synology
Usage
You can import the module as synology_dsm.
Constructor
SynologyDSM(
dsm_ip,
dsm_port,
username,
password,
use_https=False,
timeout=None,
device_token=None,
debugmode=False,
)
device_token should be added when using a two-step authentication account, otherwise DSM will ask to login with a One Time Password (OTP) and requests will fail (see the login section for more details).
Default timeout is 10 seconds.
Login
The library automatically login at first request, but you better use the login() function separately to authenticate.
It will return a boolean if it successed or faild to authenticate to DSM.
If your account need a two-step authentication (2SA), login() will raise SynologyDSMLogin2SARequiredException. Call the function again with a One Time Password (OTP) as parameter, like login("123456") (better to be a string to handle first zero). Store the device_token property so that you do not need to reconnect with password the next time you open a new SynologyDSM session.
Code exemple
from synology_dsm import SynologyDSM
print("Creating Valid API")
api = SynologyDSM("<SynologyIp>", "<SynologyPort>", "<Username>", "<Password>")
print("=== Information ===")
print("Model: " + str(api.information.model))
print("RAM: " + str(api.information.ram) + " MB")
print("Serial number: " + str(api.information.serial))
print("Temperature: " + str(api.information.temperature) + " °C")
print("Temp. warning: " + str(api.information.temperature_warn))
print("Uptime: " + str(api.information.uptime))
print("Full DSM version:" + str(api.information.version_string))
print("=== Utilisation ===")
print("CPU Load: " + str(api.utilisation.cpu_total_load) + " %")
print("Memory Use: " + str(api.utilisation.memory_real_usage) + " %")
print("Net Up: " + str(api.utilisation.network_up()))
print("Net Down: " + str(api.utilisation.network_down()))
print("=== Storage ===")
for volume_id in api.storage.volumes_ids:
print("ID: " + str(volume_id))
print("Status: " + str(api.storage.volume_status(volume_id)))
print("% Used: " + str(api.storage.volume_percentage_used(volume_id)) + " %")
for disk_id in api.storage.disks_ids:
print("ID: " + str(disk_id))
print("Name: " + str(api.storage.disk_name(disk_id)))
print("S-Status: " + str(api.storage.disk_smart_status(disk_id)))
print("Status: " + str(api.storage.disk_status(disk_id)))
print("Temp: " + str(api.storage.disk_temp(disk_id)))
Credits / Special Thanks
Found Synology API “documentation” on this repo : https://github.com/kwent/syno/tree/master/definitions
Official references
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_synology-0.8.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dff64bf89e4497951d21f214d6a14f8b8c49af2529bf40a68d7fff23ec73f59a |
|
MD5 | 60aabc571161a78d12ddb43e11e5276d |
|
BLAKE2b-256 | 74ea5e3fa102b2867585da66a6321087fd949cba3a294ca29898df32ee846ba3 |