CoreServiceHW
This API is partially documented or under construction.
Overview​
Core hardware/media/package: Group, Hardware, ISCSI, Media, OAuth, Package, PortFwd.
Methods​
group_extra_admin_get​
Get extra admin group settings.
Internal API​
SYNO.Core.Group.ExtraAdmin
Returns​
dict[str, object] or str
Result of the group extra admin get operation.
group_member_list​
List members of a group.
Internal API​
SYNO.Core.Group.Member
Parameters​
group str
The group value.
Returns​
dict[str, object] or str
Result of the group member list operation.
group_valid_local_admin_get​
Get valid local admin information.
Internal API​
SYNO.Core.Group.ValidLocalAdmin
Returns​
dict[str, object] or str
Result of the group valid local admin get operation.
hardware_lcm_get​
Get LCD monitor panel settings.
Internal API​
SYNO.Core.Hardware.LCM
Returns​
dict[str, object] or str
Result of the hardware lcm get operation.
hardware_led_brightness_get​
Get LED brightness settings.
Internal API​
SYNO.Core.Hardware.Led.Brightness
Returns​
dict[str, object] or str
Result of the hardware led brightness get operation.
hardware_led_brightness_set​
Set LED brightness level.
Internal API​
SYNO.Core.Hardware.Led.Brightness
Parameters​
brightness int
The brightness value.
Returns​
dict[str, object] or str
Result of the hardware led brightness set operation.
hardware_memory_layout_get​
Get memory layout information.
Internal API​
SYNO.Core.Hardware.MemoryLayout
Returns​
dict[str, object] or str
Result of the hardware memory layout get operation.
hardware_need_reboot_get​
Check if a reboot is required.
Internal API​
SYNO.Core.Hardware.NeedReboot
Returns​
dict[str, object] or str
Result of the hardware need reboot get operation.
hardware_oob_management_get​
Get out-of-band management (IPMI/BMC) settings.
Internal API​
SYNO.Core.Hardware.OOBManagement
Returns​
dict[str, object] or str
Result of the hardware oob management get operation.
hardware_remote_fan_status_get​
Get remote fan status.
Internal API​
SYNO.Core.Hardware.RemoteFanStatus
Returns​
dict[str, object] or str
Result of the hardware remote fan status get operation.
hardware_spectre_meltdown_get​
Get Spectre/Meltdown mitigation status.
Internal API​
SYNO.Core.Hardware.SpectreMeltdown
Returns​
dict[str, object] or str
Result of the hardware spectre meltdown get operation.
hardware_video_transcoding_get​
Get hardware video transcoding capability.
Internal API​
SYNO.Core.Hardware.VideoTranscoding
Returns​
dict[str, object] or str
Result of the hardware video transcoding get operation.
iscsi_fc_target_get​
Get Fibre Channel target settings.
Internal API​
SYNO.Core.ISCSI.FCTarget
Returns​
dict[str, object] or str
Result of the iscsi fc target get operation.
iscsi_host_get​
Get iSCSI host settings.
Internal API​
SYNO.Core.ISCSI.Host
Returns​
dict[str, object] or str
Result of the iscsi host get operation.
iscsi_lunbkp_get​
Get iSCSI LUN backup settings.
Internal API​
SYNO.Core.ISCSI.Lunbkp
Returns​
dict[str, object] or str
Result of the iscsi lunbkp get operation.
iscsi_node_get​
Get iSCSI node information.
Internal API​
SYNO.Core.ISCSI.Node
Returns​
dict[str, object] or str
Result of the iscsi node get operation.
iscsi_replication_get​
Get iSCSI replication settings.
Internal API​
SYNO.Core.ISCSI.Replication
Returns​
dict[str, object] or str
Result of the iscsi replication get operation.
iscsi_vmware_get​
Get iSCSI VMware integration settings.
Internal API​
SYNO.Core.ISCSI.VMware
Returns​
dict[str, object] or str
Result of the iscsi vmware get operation.
media_indexing_get​
Get media indexing settings.
Internal API​
SYNO.Core.MediaIndexing
Returns​
dict[str, object] or str
Result of the media indexing get operation.
media_indexing_set​
Set media indexing settings.
Internal API​
SYNO.Core.MediaIndexing
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the media indexing set operation.
media_indexing_index_folder_get​
Get indexed folder list.
Internal API​
SYNO.Core.MediaIndexing.IndexFolder
Returns​
dict[str, object] or str
Result of the media indexing index folder get operation.
media_indexing_media_converter_get​
Get media converter settings.
Internal API​
SYNO.Core.MediaIndexing.MediaConverter
Returns​
dict[str, object] or str
Result of the media indexing media converter get operation.
media_indexing_scheduler_get​
Get media indexing scheduler settings.
Internal API​
SYNO.Core.MediaIndexing.Scheduler
Returns​
dict[str, object] or str
Result of the media indexing scheduler get operation.
media_indexing_thumbnail_quality_get​
Get thumbnail quality settings.
Internal API​
SYNO.Core.MediaIndexing.ThumbnailQuality
Returns​
dict[str, object] or str
Result of the media indexing thumbnail quality get operation.
mydscenter_get​
Get MyDS Center settings.
Internal API​
SYNO.Core.MyDSCenter
Returns​
dict[str, object] or str
Result of the mydscenter get operation.
mydscenter_account_get​
Get MyDS Center account information.
Internal API​
SYNO.Core.MyDSCenter.Account
Returns​
dict[str, object] or str
Result of the mydscenter account get operation.
mydscenter_login​
Login to MyDS Center.
Internal API​
SYNO.Core.MyDSCenter.Login
Parameters​
username str
The username value.
password str
The password value.
Returns​
dict[str, object] or str
Result of the mydscenter login operation.
mydscenter_logout​
Logout from MyDS Center.
Internal API​
SYNO.Core.MyDSCenter.Logout
Returns​
dict[str, object] or str
Result of the mydscenter logout operation.
mydscenter_purchase_get​
Get MyDS Center purchase information.
Internal API​
SYNO.Core.MyDSCenter.Purchase
Returns​
dict[str, object] or str
Result of the mydscenter purchase get operation.
normal_user_get​
Get normal user settings.
Internal API​
SYNO.Core.NormalUser
Returns​
dict[str, object] or str
Result of the normal user get operation.
normal_user_login_notify_get​
Get normal user login notification settings.
Internal API​
SYNO.Core.NormalUser.LoginNotify
Returns​
dict[str, object] or str
Result of the normal user login notify get operation.
oauth_scope_get​
Get OAuth scope settings.
Internal API​
SYNO.Core.OAuth.Scope
Returns​
dict[str, object] or str
Result of the oauth scope get operation.
oauth_server_get​
Get OAuth server settings.
Internal API​
SYNO.Core.OAuth.Server
Returns​
dict[str, object] or str
Result of the oauth server get operation.
oauth_server_set​
Set OAuth server settings.
Internal API​
SYNO.Core.OAuth.Server
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the oauth server set operation.
package_auto_upgrade_progress_get​
Get package auto-upgrade progress.
Internal API​
SYNO.Core.Package.AutoUpgrade.Progress
Returns​
dict[str, object] or str
Result of the package auto upgrade progress get operation.
package_control​
Control a package (start/stop).
Internal API​
SYNO.Core.Package.Control
Parameters​
package_id str
The package id value.
action str
The action value.
Returns​
dict[str, object] or str
Result of the package control operation.
package_fake_iframe_get​
Get package fake iframe info.
Internal API​
SYNO.Core.Package.FakeIFrame
Returns​
dict[str, object] or str
Result of the package fake iframe get operation.
package_feed_list​
List package feeds.
Internal API​
SYNO.Core.Package.Feed
Returns​
dict[str, object] or str
Result of the package feed list operation.
package_feed_set​
Set package feed settings.
Internal API​
SYNO.Core.Package.Feed
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the package feed set operation.
package_legal_prerelease_get​
Get package pre-release legal agreement status.
Internal API​
SYNO.Core.Package.Legal.PreRelease
Returns​
dict[str, object] or str
Result of the package legal prerelease get operation.
package_log_get​
Get package log entries.
Internal API​
SYNO.Core.Package.Log
Parameters​
package_id str
The package id value.
Returns​
dict[str, object] or str
Result of the package log get operation.
package_myds_get​
Get MyDS package info.
Internal API​
SYNO.Core.Package.MyDS
Returns​
dict[str, object] or str
Result of the package myds get operation.
package_myds_purchase_get​
Get MyDS package purchase info.
Internal API​
SYNO.Core.Package.MyDS.Purchase
Returns​
dict[str, object] or str
Result of the package myds purchase get operation.
package_progress_get​
Get package installation/upgrade progress.
Internal API​
SYNO.Core.Package.Progress
Parameters​
task_id str
The task id value.
Returns​
dict[str, object] or str
Result of the package progress get operation.
package_screenshot_get​
Get package screenshots.
Internal API​
SYNO.Core.Package.Screenshot
Parameters​
package_id str
The package id value.
Returns​
dict[str, object] or str
Result of the package screenshot get operation.
package_screenshot_server_get​
Get package screenshot from server.
Internal API​
SYNO.Core.Package.Screenshot.Server
Parameters​
package_id str
The package id value.
Returns​
dict[str, object] or str
Result of the package screenshot server get operation.
package_setting_update_get​
Get package update settings.
Internal API​
SYNO.Core.Package.Setting.Update
Returns​
dict[str, object] or str
Result of the package setting update get operation.
package_thumb_get​
Get package thumbnail.
Internal API​
SYNO.Core.Package.Thumb
Parameters​
package_id str
The package id value.
Returns​
dict[str, object] or str
Result of the package thumb get operation.
package_thumb_server_get​
Get package thumbnail from server.
Internal API​
SYNO.Core.Package.Thumb.Server
Parameters​
package_id str
The package id value.
Returns​
dict[str, object] or str
Result of the package thumb server get operation.
personal_notification_device_get​
Get personal notification device settings.
Internal API​
SYNO.Core.PersonalNotification.Device
Returns​
dict[str, object] or str
Result of the personal notification device get operation.
personal_notification_event_get​
Get personal notification events.
Internal API​
SYNO.Core.PersonalNotification.Event
Returns​
dict[str, object] or str
Result of the personal notification event get operation.
personal_notification_filter_get​
Get personal notification filter settings.
Internal API​
SYNO.Core.PersonalNotification.Filter
Returns​
dict[str, object] or str
Result of the personal notification filter get operation.
personal_notification_filter_set​
Set personal notification filter settings.
Internal API​
SYNO.Core.PersonalNotification.Filter
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the personal notification filter set operation.
personal_notification_mobile_get​
Get personal notification mobile settings.
Internal API​
SYNO.Core.PersonalNotification.Mobile
Returns​
dict[str, object] or str
Result of the personal notification mobile get operation.
personal_notification_settings_get​
Get personal notification settings.
Internal API​
SYNO.Core.PersonalNotification.Settings
Returns​
dict[str, object] or str
Result of the personal notification settings get operation.
personal_notification_settings_set​
Set personal notification settings.
Internal API​
SYNO.Core.PersonalNotification.Settings
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the personal notification settings set operation.
photo_viewer_get​
Get photo viewer settings.
Internal API​
SYNO.Core.PhotoViewer
Returns​
dict[str, object] or str
Result of the photo viewer get operation.
port_forwarding_get​
Get port forwarding settings.
Internal API​
SYNO.Core.PortForwarding
Returns​
dict[str, object] or str
Result of the port forwarding get operation.
port_forwarding_compatibility_get​
Get port forwarding compatibility status.
Internal API​
SYNO.Core.PortForwarding.Compatibility
Returns​
dict[str, object] or str
Result of the port forwarding compatibility get operation.
port_forwarding_router_info_get​
Get router information for port forwarding.
Internal API​
SYNO.Core.PortForwarding.RouterInfo
Returns​
dict[str, object] or str
Result of the port forwarding router info get operation.
port_forwarding_router_list​
List detected routers.
Internal API​
SYNO.Core.PortForwarding.RouterList
Returns​
dict[str, object] or str
Result of the port forwarding router list operation.
port_forwarding_rules_serv_get​
Get service-based port forwarding rules.
Internal API​
SYNO.Core.PortForwarding.Rules.Serv
Returns​
dict[str, object] or str
Result of the port forwarding rules serv get operation.