CoreUpgrade
This API is partially documented or under construction.
Overview​
Extended Core Upgrade API implementation for Synology NAS.
This class provides methods for cluster-level upgrades, group upgrades, patch management, pre-checks, and remote upgrade actions.
Methods​
auto_upgrade_security_get​
Get auto-upgrade security settings.
Internal API​
SYNO.Core.Upgrade.AutoUpgrade.Security
Returns​
dict[str, object] or str
Security auto-upgrade configuration.
auto_upgrade_security_set​
Set auto-upgrade security settings.
Internal API​
SYNO.Core.Upgrade.AutoUpgrade.Security
Parameters​
enabled bool
Enable or disable security auto-upgrade. Defaults to True.
Returns​
dict[str, object] or str
API response.
cluster_patch_get​
Get cluster patch information.
Internal API​
SYNO.Core.Upgrade.Cluster.Patch
Returns​
dict[str, object] or str
Cluster patch status.
cluster_patch_list​
List available cluster patches.
Internal API​
SYNO.Core.Upgrade.Cluster.Patch
Returns​
dict[str, object] or str
List of cluster patches.
cluster_server_get​
Get cluster upgrade server information.
Internal API​
SYNO.Core.Upgrade.Cluster.Server
Returns​
dict[str, object] or str
Cluster upgrade server status.
cluster_server_list​
List cluster upgrade servers.
Internal API​
SYNO.Core.Upgrade.Cluster.Server
Returns​
dict[str, object] or str
List of cluster upgrade servers.
cluster_server_download_get​
Get cluster server download status.
Internal API​
SYNO.Core.Upgrade.Cluster.Server.Download
Returns​
dict[str, object] or str
Download status for cluster server upgrade.
cluster_server_download_start​
Start cluster server upgrade download.
Internal API​
SYNO.Core.Upgrade.Cluster.Server.Download
Returns​
dict[str, object] or str
API response.
upgrade_group_get​
Get upgrade group information.
Internal API​
SYNO.Core.Upgrade.Group
Returns​
dict[str, object] or str
Upgrade group status.
upgrade_group_list​
List upgrade groups.
Internal API​
SYNO.Core.Upgrade.Group
Returns​
dict[str, object] or str
List of upgrade groups.
upgrade_group_download_get​
Get group download status.
Internal API​
SYNO.Core.Upgrade.Group.Download
Returns​
dict[str, object] or str
Group upgrade download status.
upgrade_group_download_start​
Start group upgrade download.
Internal API​
SYNO.Core.Upgrade.Group.Download
Returns​
dict[str, object] or str
API response.
upgrade_group_setting_get​
Get group upgrade settings.
Internal API​
SYNO.Core.Upgrade.Group.Setting
Returns​
dict[str, object] or str
Group upgrade settings.
upgrade_group_setting_set​
Set group upgrade settings.
Internal API​
SYNO.Core.Upgrade.Group.Setting
Parameters​
enabled bool
Enable or disable group upgrade. Defaults to True.
Returns​
dict[str, object] or str
API response.
group_install_get​
Get group install status.
Internal API​
SYNO.Core.Upgrade.GroupInstall
Returns​
dict[str, object] or str
Group install status.
group_install_start​
Start a group install.
Internal API​
SYNO.Core.Upgrade.GroupInstall
Returns​
dict[str, object] or str
API response.
group_install_network_get​
Get group install network status.
Internal API​
SYNO.Core.Upgrade.GroupInstall.Network
Returns​
dict[str, object] or str
Network status for group install.
group_install_network_set​
Set group install network configuration.
Internal API​
SYNO.Core.Upgrade.GroupInstall.Network
Parameters​
_kwargs_** object
Network configuration key-value pairs.
Returns​
dict[str, object] or str
API response.
junior_mode_data_get​
Get junior mode data.
Internal API​
SYNO.Core.Upgrade.JuniorModeData
Returns​
dict[str, object] or str
Junior mode data.
junior_mode_data_set​
Set junior mode data.
Internal API​
SYNO.Core.Upgrade.JuniorModeData
Parameters​
_kwargs_** object
Junior mode configuration key-value pairs.
Returns​
dict[str, object] or str
API response.
upgrade_patch_get​
Get upgrade patch information.
Internal API​
SYNO.Core.Upgrade.Patch
Returns​
dict[str, object] or str
Upgrade patch status.
upgrade_patch_list​
List available upgrade patches.
Internal API​
SYNO.Core.Upgrade.Patch
Returns​
dict[str, object] or str
List of upgrade patches.
upgrade_precheck_get​
Get upgrade pre-check status.
Internal API​
SYNO.Core.Upgrade.PreCheck
Returns​
dict[str, object] or str
Pre-check results for pending upgrade.
upgrade_precheck_start​
Start an upgrade pre-check.
Internal API​
SYNO.Core.Upgrade.PreCheck
Returns​
dict[str, object] or str
API response.
remote_action_get​
Get remote upgrade action status.
Internal API​
SYNO.Core.Upgrade.RemoteAction
Returns​
dict[str, object] or str
Remote action status.
remote_action_set​
Set a remote upgrade action.
Internal API​
SYNO.Core.Upgrade.RemoteAction
Parameters​
action str
The remote action to perform (e.g., 'install', 'cancel').
_kwargs_** object
Additional action parameters.
Returns​
dict[str, object] or str
API response.