Skip to main content

SysInfo

warning

This API is not documented yet.

Overview​

Core System Information API implementation for Synology NAS.

This class provides methods to retrieve and manage system, network, hardware, service, and package information from a Synology NAS.

Methods​

fileserv_smb​

Get SMB file service status.

Internal API​

SYNO.Core.FileServ.SMB

Returns​

dict[str, object] or str
SMB file service status.

fileserv_afp​

Get AFP file service status.

Internal API​

SYNO.Core.FileServ.AFP

Returns​

dict[str, object] or str
AFP file service status.

fileserv_nfs​

Get NFS file service status.

Internal API​

SYNO.Core.FileServ.NFS

Returns​

dict[str, object] or str
NFS file service status.

fileserv_ftp​

Get FTP file service status.

Internal API​

SYNO.Core.FileServ.FTP

Returns​

dict[str, object] or str
FTP file service status.

fileserv_sftp​

Get SFTP file service status.

Internal API​

SYNO.Core.FileServ.FTP.SFTP

Returns​

dict[str, object] or str
SFTP file service status.

network_backup_info​

Get network backup service information.

Internal API​

SYNO.Backup.Service.NetworkBackup

Returns​

dict[str, object] or str
Network backup service information.

bandwidth_control_protocol​

Get bandwidth control protocol information.

Internal API​

SYNO.Core.BandwidthControl.Protocol

Returns​

dict[str, object] or str
Bandwidth control protocol information.

shared_folders_info​

Get shared folders information.

Internal API​

SYNO.Core.Share

Returns​

dict[str, object] or str
Shared folders information.

services_status​

Get status of core services.

Internal API​

SYNO.Core.Service

Returns​

dict[str, object] or str
Status of core services.

services_discovery​

Get service discovery information.

Internal API​

SYNO.Core.FileServ.ServiceDiscovery

Returns​

dict[str, object] or str
Service discovery information.

file_transfer_status​

Get file transfer status.

Internal API​

SYNO.Core.SyslogClient.FileTransfer

Returns​

dict[str, object] or str
File transfer status.

network_status​

Get network status.

Internal API​

SYNO.Core.Network

Returns​

dict[str, object] or str
Network status.

web_status​

Get DSM web status.

Internal API​

SYNO.Core.Web.DSM

Returns​

dict[str, object] or str
DSM web status.

current_connection​

Get current connection information.

Internal API​

SYNO.Core.CurrentConnection

Returns​

dict[str, object] or str
Current connection information.

bandwidth_control_status​

Get bandwidth control status.

Internal API​

SYNO.Core.BandwidthControl.Status

Returns​

dict[str, object] or str
Bandwidth control status.

sys_status​

Get system status.

Internal API​

SYNO.Core.System.Status

Returns​

dict[str, object] or str
System status.

latest_logs​

Get latest system logs.

Internal API​

SYNO.Core.SyslogClient.Status

Returns​

dict[str, object] or str
Latest system logs.

client_notify_settings_status​

Get client notification settings status.

Internal API​

SYNO.Core.SyslogClient.Setting.Notify

Returns​

dict[str, object] or str
Client notification settings status.

get_security_scan_info​

Get security scan configuration.

Internal API​

SYNO.Core.SecurityScan.Conf

Returns​

dict[str, object] or str
Security scan configuration.

get_security_scan_rules​

Get security scan rules.

Internal API​

SYNO.Core.SecurityScan.Status

Returns​

dict[str, object] or str
Security scan rules.

get_security_scan_status​

Get security scan status.

Internal API​

SYNO.Core.SecurityScan.Status

Returns​

dict[str, object] or str
Security scan status.

get_user_list​

Get user list.

Internal API​

SYNO.Core.User

Returns​

dict[str, object] or str
User list.

quickconnect_info​

Get QuickConnect configuration.

Internal API​

SYNO.Core.QuickConnect

Returns​

dict[str, object] or str
QuickConnect configuration.

quickconnect_permissions​

Get QuickConnect permissions.

Internal API​

SYNO.Core.QuickConnect.Permission

Returns​

dict[str, object] or str
QuickConnect permissions.

network_topology​

Get network topology.

Internal API​

SYNO.Core.Network.Router.Topology

Returns​

dict[str, object] or str
Network topology.

network_wifi_client​

Get WiFi client information.

Internal API​

SYNO.Core.Network.Wifi.Client

Returns​

dict[str, object] or str
WiFi client information.

network_bond​

Get network bond information.

Internal API​

SYNO.Core.Network.Bond

Returns​

dict[str, object] or str
Network bond information.

network_bridge​

Get network bridge information.

Internal API​

SYNO.Core.Network.Bridge

Returns​

dict[str, object] or str
Network bridge information.

network_ethernet​

Get network ethernet information.

Internal API​

SYNO.Core.Network.Ethernet

Returns​

dict[str, object] or str
Network ethernet information.

network_local_bridge​

Get local network bridge information.

Internal API​

SYNO.Core.Network.LocalBridge

Returns​

dict[str, object] or str
Local network bridge information.

network_usb_modem​

Get USB modem information.

Internal API​

SYNO.Core.Network.USBModem

Returns​

dict[str, object] or str
USB modem information.

network_pppoe​

Get PPPoE information.

Internal API​

SYNO.Core.Network.PPPoE

Returns​

dict[str, object] or str
PPPoE information.

network_ipv6tunnel​

Get IPv6 tunnel information.

Internal API​

SYNO.Core.Network.IPv6Tunnel

Returns​

dict[str, object] or str
IPv6 tunnel information.

network_vpn_pptp​

Get VPN PPTP information.

Internal API​

SYNO.Core.Network.VPN.PPTP

Returns​

dict[str, object] or str
VPN PPTP information.

network_openvpn​

Get OpenVPN information.

Internal API​

SYNO.Core.Network.VPN.OpenVPN

Returns​

dict[str, object] or str
OpenVPN information.

network_vpn_l2tp​

Get VPN L2TP information.

Internal API​

SYNO.Core.Network.VPN.L2TP

Returns​

dict[str, object] or str
VPN L2TP information.

domain_schedule​

Get domain schedule.

Internal API​

SYNO.Core.Directory.Domain.Schedule

Returns​

dict[str, object] or str
Domain schedule.

client_ldap​

Get LDAP client information.

Internal API​

SYNO.Core.Directory.LDAP

Returns​

dict[str, object] or str
LDAP client information.

client_sso​

Get SSO client information.

Internal API​

SYNO.Core.Directory.SSO

Returns​

dict[str, object] or str
SSO client information.

sys_upgrade_check​

Check for system upgrades.

Internal API​

SYNO.Core.Upgrade.Server

Returns​

dict[str, object] or str
System upgrade check result.

sys_upgrade_download​

Get system upgrade download progress.

Internal API​

SYNO.Core.Upgrade.Server.Download

Returns​

dict[str, object] or str
System upgrade download progress.

sys_upgrade_setting​

Get system upgrade settings.

Internal API​

SYNO.Core.Upgrade.Setting

Returns​

dict[str, object] or str
System upgrade settings.

notification_sms_conf​

Get SMS notification configuration.

Internal API​

SYNO.Core.Notification.SMS.Conf

Returns​

dict[str, object] or str
SMS notification configuration.

notification_mail_conf​

Get mail notification configuration.

Internal API​

SYNO.Core.Notification.Mail.Conf

Returns​

dict[str, object] or str
Mail notification configuration.

notification_push_mail​

Get push mail notification configuration.

Internal API​

SYNO.Core.Notification.Push.Mail

Returns​

dict[str, object] or str
Push mail notification configuration.

notification_push_conf​

Get push notification configuration.

Internal API​

SYNO.Core.Notification.Push.Conf

Returns​

dict[str, object] or str
Push notification configuration.

hardware_beep_control​

Get hardware beep control status.

Internal API​

SYNO.Core.Hardware.BeepControl

Returns​

dict[str, object] or str
Hardware beep control status.

hardware_fan_speed​

Get hardware fan speed.

Internal API​

SYNO.Core.Hardware.FanSpeed

Returns​

dict[str, object] or str
Hardware fan speed.

set_fan_speed​

Set hardware fan speed.

Internal API​

SYNO.Core.Hardware.FanSpeed

Parameters​

fan_speed str
Fan speed mode (e.g., 'quietfan', 'coolfan', 'fullfan'). Defaults to 'quietfan'.

Returns​

dict[str, object] or str
API response.

enable_zram​

Enable or disable ZRAM.

Internal API​

SYNO.Core.Hardware.ZRAM

Parameters​

enable_zram bool
Enable ZRAM if True, disable if False. Defaults to True.

Returns​

dict[str, object] or str
API response.

enable_power_recovery​

Enable power recovery options.

Internal API​

SYNO.Core.Hardware.PowerRecovery

Parameters​

restart_auto_after_issue bool
Restart automatically after issue. Defaults to True.

wake_on_lan bool
Enable Wake-on-LAN. Defaults to False.

Returns​

dict[str, object] or str
API response.

enable_beep_control​

Enable or disable beep control options.

Internal API​

SYNO.Core.Hardware.BeepControl

Parameters​

fan_fail bool
Enable beep on fan failure.

volume_crash bool
Enable beep on volume crash.

poweron_beep bool
Enable beep on power on.

poweroff_beep bool
Enable beep on power off.

Returns​

dict[str, object] or str
API response.

set_led_control​

Set LED brightness.

Internal API​

SYNO.Core.Led.Brightness

Parameters​

led_brightness int
LED brightness level. Defaults to 2.

Returns​

dict[str, object] or str
API response.

set_hibernation​

Set hibernation times.

Internal API​

SYNO.Core.Hardware.Hibernation

Parameters​

internal_hd_idletime int
Idle time for internal hard drives. Defaults to 0.

usb_idletime int
Idle time for USB devices. Defaults to 0.

Returns​

dict[str, object] or str
API response.

enable_external_ups​

Enable or configure external UPS.

Internal API​

SYNO.Core.ExternalDevice.UPS

Parameters​

enable bool
Enable external UPS. Defaults to False.

mode str
UPS mode. Defaults to 'SLAVE'.

delay_time int
Delay time. Defaults to 1.

snmp_auth_key_dirty bool
SNMP auth key dirty flag. Defaults to False.

snmp_privacy_key_dirty bool
SNMP privacy key dirty flag. Defaults to False.

Returns​

dict[str, object] or str
API response.

get_system_info​

Get system information.

Internal API​

SYNO.Core.System

Returns​

dict[str, object] or str
System information.

get_cpu_temp​

Get CPU temperature.

Internal API​

SYNO.Core.System

Returns​

str
CPU temperature.

get_all_system_utilization​

Get all system utilization statistics.

Internal API​

SYNO.Core.System.Utilization

Returns​

str
System utilization statistics.

get_cpu_utilization​

Get CPU utilization statistics.

Internal API​

SYNO.Core.System.Utilization

Returns​

str
CPU utilization statistics.

get_disk_utilization​

Get disk utilization statistics.

Internal API​

SYNO.Core.System.Utilization

Returns​

str
Disk utilization statistics.

get_memory_utilization​

Get memory utilization statistics.

Internal API​

SYNO.Core.System.Utilization

Returns​

str
Memory utilization statistics.

shutdown​

Shutdown the system.

Internal API​

SYNO.Core.System

Parameters​

version str
API version to use. Defaults to None.

Returns​

dict[str, object] or str
API response.

reboot​

Reboot the system.

Internal API​

SYNO.Core.System

Returns​

dict[str, object] or str
API response.

dsm_info​

Get DSM information.

Internal API​

SYNO.DSM.Info

Returns​

dict[str, object] or str
DSM information.

get_network_info​

Get network information.

Internal API​

SYNO.Core.System

Returns​

dict[str, object] or str
Network information.

get_volume_info​

Get volume information.

Internal API​

SYNO.Core.System

Returns​

dict[str, object] or str
Volume information.

hardware_hibernation​

Get hardware hibernation status.

Internal API​

SYNO.Core.Hardware.Hibernation

Returns​

dict[str, object] or str
Hardware hibernation status.

hardware_ups​

Get hardware UPS status.

Internal API​

SYNO.Core.ExternalDevice.UPS

Returns​

dict[str, object] or str
Hardware UPS status.

terminal_info​

Get terminal information.

Internal API​

SYNO.Core.Terminal

Returns​

dict[str, object] or str
Terminal information.

snmp_info​

Get SNMP information.

Internal API​

SYNO.Core.SNMP

Returns​

dict[str, object] or str
SNMP information.

process​

Get system process information.

Internal API​

SYNO.Core.System.Process

Returns​

dict[str, object] or str
System process information.

storage​

Get storage information.

Internal API​

SYNO.Storage.CGI.Storage

Returns​

dict[str, object] or str
Storage information.

external_device_storage_usb​

Get USB storage device information.

Internal API​

SYNO.Core.ExternalDevice.Storage.USB

Returns​

dict[str, object] or str
USB storage device information.

external_device_storage_esata​

Get eSATA storage device information.

Internal API​

SYNO.Core.ExternalDevice.Storage.eSATA

Returns​

dict[str, object] or str
eSATA storage device information.

file_index_resource​

Get file indexing status.

Internal API​

SYNO.Finder.FileIndexing.Status

Returns​

dict[str, object] or str
File indexing status.

cms_info​

Get CMS information.

Internal API​

SYNO.Core.CMS.Info

Returns​

dict[str, object] or str
CMS information.

port_forwarding_rules​

Get port forwarding rules.

Internal API​

SYNO.Core.PortForwarding.Rules

Returns​

dict[str, object] or str
Port forwarding rules.

port_forwarding_router_conf​

Get port forwarding router configuration.

Internal API​

SYNO.Core.PortForwarding.RouterConf

Returns​

dict[str, object] or str
Port forwarding router configuration.

disk_list​

Get disk list.

Internal API​

SYNO.Core.Polling.Data

Returns​

dict[str, object] or str
Disk list.

ddns_provider_info​

Get DDNS provider information.

Internal API​

SYNO.Core.DDNS.Provider

Returns​

dict[str, object] or str
DDNS provider information.

ddns_record_info​

Get DDNS record information.

Internal API​

SYNO.Core.DDNS.Record

Returns​

dict[str, object] or str
DDNS record information.

ddns_external_ip​

Get DDNS external IP.

Internal API​

SYNO.Core.DDNS.ExtIP

Returns​

dict[str, object] or str
DDNS external IP.

ddns_synology​

Get Synology DDNS information.

Internal API​

SYNO.Core.DDNS.Synology

Returns​

dict[str, object] or str
Synology DDNS information.

iscsi_lun_info​

Get iSCSI LUN information.

Internal API​

SYNO.Core.ISCSI.LUN

Returns​

dict[str, object] or str
iSCSI LUN information.

hddman​

Get HDD manager information.

Internal API​

SYNO.Storage.CGI.HddMan

Returns​

dict[str, object] or str
HDD manager information.

ftp_security_info​

Get FTP security information.

Internal API​

SYNO.Core.FileServ.FTP.Security

Returns​

dict[str, object] or str
FTP security information.

bandwidth_control_info​

Get bandwidth control information.

Internal API​

SYNO.Core.BandwidthControl.Protocol

Returns​

dict[str, object] or str
Bandwidth control information.

directory_domain_info​

Get directory domain information.

Internal API​

SYNO.Core.Directory.Domain

Returns​

dict[str, object] or str
Directory domain information.

ws_transfer_info​

Get WS transfer information.

Internal API​

SYNO.Core.FileServ.ServiceDiscovery.WSTransfer

Returns​

dict[str, object] or str
WS transfer information.

Get reflink copy information.

Internal API​

SYNO.Core.FileServ.ReflinkCopy

Returns​

dict[str, object] or str
Reflink copy information.

bonjour_service_info​

Get Bonjour service information.

Internal API​

SYNO.Core.ExternalDevice.Printer.BonjourSharing

Returns​

dict[str, object] or str
Bonjour service information.

personal_photo_enable​

Get personal photo enable status.

Internal API​

SYNO.Core.User.Home

Returns​

dict[str, object] or str
Personal photo enable status.

ftp_chroot_user​

Get FTP chroot user information.

Internal API​

SYNO.Core.FileServ.FTP.ChrootUser

Returns​

dict[str, object] or str
FTP chroot user information.

server_pair​

Get server pair information.

Internal API​

SYNO.S2S.Server.Pair

Returns​

dict[str, object] or str
Server pair information.

groups_info​

Get groups information.

Internal API​

SYNO.Core.Group

Parameters​

offset int
Offset for pagination. Defaults to 0.

limit int
Maximum number of groups to retrieve. Defaults to -1.

name_only bool
If True, returns only group names. Defaults to False.

Returns​

dict[str, object] or str
Groups information.

ldap_info​

Get LDAP information.

Internal API​

SYNO.Core.Directory.LDAP

Returns​

dict[str, object] or str
LDAP information.

sso_iwa_info​

Get SSO IWA information.

Internal API​

SYNO.Core.Directory.SSO.IWA

Returns​

dict[str, object] or str
SSO IWA information.

sso_info​

Get SSO information.

Internal API​

SYNO.Core.Directory.SSO

Returns​

dict[str, object] or str
SSO information.

network_interface_info​

Get network interface information.

Internal API​

SYNO.Core.Network.Interface

Returns​

dict[str, object] or str
Network interface information.

proxy_info​

Get proxy information.

Internal API​

SYNO.Core.Network.Proxy

Returns​

dict[str, object] or str
Proxy information.

gateway_list​

Get gateway list.

Internal API​

SYNO.Core.Network.Router.Gateway.List

Parameters​

ip_type str
IP type (e.g., 'ipv4', 'ipv6'). Defaults to 'ipv4'.

type str
Gateway type (e.g., 'wan'). Defaults to 'wan'.

Returns​

dict[str, object] or str
Gateway list.

firewall_info​

Get firewall information.

Internal API​

SYNO.Core.Security.Firewall.Profile

Returns​

dict[str, object] or str
Firewall information.

auto_upgrade_status​

Get auto upgrade status.

Internal API​

SYNO.Core.Upgrade.AutoUpgrade

Returns​

dict[str, object] or str
Auto upgrade status.

upgrade_server_check​

Check upgrade server.

Internal API​

SYNO.Core.Upgrade.Server

Returns​

dict[str, object] or str
Upgrade server check result.

alarm_rules_logs​

Get alarm rules logs.

Internal API​

SYNO.ResourceMonitor.Log

Returns​

dict[str, object] or str
Alarm rules logs.

alarm_rules_list​

Get alarm rules list.

Internal API​

SYNO.ResourceMonitor.EventRule

Returns​

dict[str, object] or str
Alarm rules list.

resource_monitor_settings_list​

Get resource monitor settings.

Internal API​

SYNO.ResourceMonitor.Setting

Returns​

dict[str, object] or str
Resource monitor settings.

file_handling_access​

Get file handling access information.

Internal API​

SYNO.Core.FileHandle

Parameters​

sort_direction str
Sort direction ('ASC' or 'DESC'). Defaults to 'ASC'.

sort_by str
Field to sort by. Defaults to 'service'.

limit int
Maximum number of results. Defaults to 50.

offset int
Offset for pagination. Defaults to 0.

Returns​

dict[str, object] or str
File handling access information.

list_service_group​

Get service group list.

Internal API​

SYNO.Core.System.ProcessGroup

Parameters​

interval int
Interval for statistics. Defaults to 0.

Returns​

dict[str, object] or str
Service group list.

list_process_group​

Get process group list.

Internal API​

SYNO.Core.System.Process

Returns​

dict[str, object] or str
Process group list.

installed_package_list​

Get installed package list.

Internal API​

SYNO.Core.Package

Returns​

dict[str, object] or str
Installed package list.

active_notifications​

Get active notifications.

Internal API​

SYNO.Core.DSMNotify

Returns​

dict[str, object] or str
Active notifications.

get_system_health​

Get system health information.

Internal API​

SYNO.Core.System.SystemHealth

Returns​

dict[str, object] or str
System health information.

upgrade_status​

Get upgrade status.

Internal API​

SYNO.Core.Upgrade

Returns​

dict[str, object] or str
Upgrade status.