LinuxCommandLibrary

synoupgrade

Upgrade the Synology DSM operating system

TLDR

Check if upgrades are available

$ sudo synoupgrade --check
copy

Check for patches without upgrading the DSM version
$ sudo synoupgrade --check-smallupdate
copy

Download the latest upgrade available (use --download-smallupdate for patches)
$ sudo synoupgrade --download
copy

Start the upgrade process
$ sudo synoupgrade --start
copy

Upgrade to the latest version automatically
$ sudo synoupgrade --auto
copy

Apply patches without upgrading the DSM version automatically
$ sudo synoupgrade --auto-smallupdate
copy

Upgrade the DSM using a patch file (should be an absolute path)
$ sudo synoupgrade --patch /[path/to/file.pat]
copy

Display help
$ synoupgrade
copy

SYNOPSIS

synoupgrade [-h]
synoupgrade [-p <.pat file>] [--no-reboot]
synoupgrade [--online | --online_download | --online_install]

PARAMETERS

-h
    Displays comprehensive help information and usage instructions for the command.

-p <.pat file>
    Specifies the absolute path to a DiskStation Manager Patch (.pat) file. This option initiates a manual, offline firmware upgrade using the provided package.

--no-reboot
    Prevents the Synology NAS system from automatically rebooting immediately after a successful firmware update installation. This allows administrators to perform other tasks or manually control the reboot time.

--online
    Checks Synology's online servers for the availability of new DSM updates. This option typically does not download or install any updates.

--online_download
    Downloads available online DSM updates to the Synology device's local storage. The update will be prepared for installation but not automatically applied.

--online_install
    Initiates the installation of previously downloaded or currently available online DSM updates. This command will proceed with the update process, which may include a system reboot.

DESCRIPTION

The synoupgrade command-line utility is an essential tool exclusive to Synology DiskStation Manager (DSM) devices, enabling the core operating system to be updated. It empowers administrators with precise control over the firmware upgrade process, serving as the underlying mechanism for both manual and automated DSM updates. Users can leverage synoupgrade to apply new DSM versions from a specified .pat file—Synology's proprietary firmware package—which is particularly useful for offline upgrades or specific version installations. Additionally, it supports managing online update workflows, including checking for, downloading, and initiating the installation of the latest DSM versions directly from Synology's servers. This command is crucial for maintaining the security, stability, and feature set of Synology NAS devices, offering a robust alternative or complement to the web-based update interface for advanced users, scripting, or troubleshooting scenarios.

CAVEATS

Synology Specific: This command is proprietary and exclusive to Synology NAS devices running DiskStation Manager (DSM). It is not part of standard Linux distributions.
Root Privileges: Execution of synoupgrade requires root privileges to ensure proper system access and modification rights.
Data Integrity Risk: Incorrect usage or any interruption during the upgrade process can potentially lead to system corruption, data loss, or render the device inoperable. It is imperative to back up all critical data before initiating any major system upgrade.
Firmware Format: The command exclusively handles .pat files, which are Synology's unique firmware packages, and will not accept other archive or installer formats.
Web UI Alternative: For most users, performing DSM updates through the graphical web interface is recommended due to its guided process and built-in safety mechanisms.

USAGE CONTEXT

synoupgrade is primarily executed via SSH or within shell scripts directly on the Synology NAS device. It operates at a lower level than the graphical DSM web interface, providing direct control over the update process.

DSM UPDATE ECOSYSTEM

While synoupgrade performs the core upgrade operation, it is part of a larger ecosystem of Synology update tools. The DSM web interface, for instance, often leverages this command or similar utilities internally to manage automatic and manual system updates.

SECURITY CONSIDERATIONS

Users must exercise extreme caution when using synoupgrade, particularly when providing a manual .pat file. Only official Synology firmware files should be used, downloaded directly from Synology's official website, to prevent system corruption, security vulnerabilities, or loss of data.

HISTORY

The synoupgrade utility is an integral component of the Synology DiskStation Manager (DSM) operating system, developed internally by Synology Inc. Its evolution has mirrored that of DSM itself, serving as the foundational command-line interface for applying system-wide updates. While the DSM web interface offers a user-friendly front-end for updates, synoupgrade was designed to provide a more direct, granular control over the update process. It is frequently utilized in scripting environments, for automated deployments, or by advanced users requiring specific upgrade procedures such as offline installations from .pat files or detailed troubleshooting. Over time, its core functionality has remained robust and consistent, adapting to support new DSM versions and evolving update mechanisms.

SEE ALSO

reboot(8), shutdown(8)

Copied to clipboard