How to use the command 'synoupgrade' (with examples)

The synoupgrade command is a tool used to manage the upgrade process of the Synology DiskStation Manager (DSM), the operating system in Synology NAS devices. It is a versatile command-line utility that offers several options for checking, downloading, and applying system updates, ensuring your NAS operates with the latest enhancements, security updates, and features. Utilizing synoupgrade can automate and streamline the update process, facilitating easy maintenance of NAS devices.

Use case 1: Checking if Upgrades are Available

Code:

sudo synoupgrade --check

Motivation:

Regularly checking for system upgrades is an essential maintenance task for any NAS device as it ensures that your DSM is equipped with the latest features and security patches. By checking for available upgrades, you can preemptively plan for any scheduled downtime required for updates, ensuring minimal disruption to your workflow.

Explanation:

• sudo: This command requires administrative privileges to execute, ensuring that only authorized users can make system-wide changes.
• synoupgrade: The main command that handles DSM upgrades.
• --check: This option specifically queries the Synology servers to see if there are any new DSM versions available for upgrade.

Example Output:

Checking for available upgrades...
No upgrades available at this time.

Or

Checking for available upgrades...
New DSM version available: DSM 7.1.1

Use case 2: Check for Patches Without Upgrading the DSM Version

Code:

sudo synoupgrade --check-smallupdate

Motivation:

Sometimes, critical patches are released to address vulnerabilities or bugs without changing the major version of the software. By checking specifically for patches, you can apply important system updates without embarking on a full version upgrade, which might involve more extensive changes and potential compatibility concerns.

Explanation:

• --check-smallupdate: This argument tells synoupgrade to focus on retrieving available patches rather than checking for major version upgrades.

Example Output:

Checking for small updates...
No patches available.

Or

Checking for small updates...
Patch available: DSM 7.1.1-50004

Use case 3: Downloading the Latest Upgrade

Code:

sudo synoupgrade --download

Motivation:

Downloading the latest upgrades ensures that you have the necessary files on your device before beginning the upgrade process. This is particularly useful if you have limited scheduling windows for applying upgrades or are in an environment with intermittent internet access. Preparing your system with the required files can streamline the actual upgrade process.

Explanation:

• --download: This option initiates the download of the latest DSM version available, allowing for a readiness checkpoint before proceeding to installation.

Example Output:

Downloading latest DSM version...
Download complete: DSM 7.1.1 ready to be installed.

Use case 4: Starting the Upgrade Process

Code:

sudo synoupgrade --start

Motivation:

Once you have verified and downloaded the necessary updates, the next step is to apply these upgrades to your system. Starting the upgrade ensures your system enjoys new features, enhancements, and maintained security standards, thus keeping your NAS hardware up to date.

Explanation:

• --start: This initiates the automated process whereby the system applies the downloaded updates to the DSM, bringing the system up to the current version as specified by the downloaded update package.

Example Output:

Starting DSM upgrade...
The system is now upgrading to DSM 7.1.1.
Upgrade completed successfully.

Use case 5: Automatically Upgrading to the Latest Version

Code:

sudo synoupgrade --auto

Motivation:

For users looking to automate the DSM upgrade process, the --auto option provides a convenient solution. It checks, downloads, and applies the latest DSM updates automatically, minimizing the necessity for manual intervention and ensuring that systems remain current with minimal effort.

Explanation:

• --auto: This switch combines checking for updates, downloading, and applying upgrades into a seamless automation process.

Example Output:

Automatically checking and upgrading DSM...
New version detected: DSM 7.1.1
Upgrading and applying changes...
Upgrade successful.

Use case 6: Automatically Applying Patches Without Upgrading the DSM Version

Code:

sudo synoupgrade --auto-smallupdate

Motivation:

Applying patches automatically while bypassing full version upgrades is an efficient way to maintain the security and reliability of your DSM installation. This command allows your NAS to get the latest minor updates or patches without significant system changes that version upgrades entail.

Explanation:

• --auto-smallupdate: Configures the tool to automatically download and apply smaller updates or patches without proceeding to a major version upgrade.

Example Output:

Automatically applying patches...
Patch download and installation successful.

Use case 7: Upgrading the DSM Using a Patch File

Code:

sudo synoupgrade --patch /path/to/file.pat

Motivation:

When updates or patches are not directly accessible from the Synology servers due to restrictions or specific policy requirements, manually applying a pre-downloaded patch file may be necessary. Using this method, administrators can deploy approved updates efficiently on numerous devices.

Explanation:

• --patch: This indicates that the command will apply a DSM upgrade via a local patch file.
• /path/to/file.pat: The full absolute path to the .pat file that contains the necessary updates for the DSM.

Example Output:

Applying patch from local file...
Local patch upgrade successful.

Use case 8: Displaying Help Information

Code:

synoupgrade

Motivation:

When using any command-line tool, it’s crucial to familiarize oneself with all available options and their proper usage. Calling the command without options typically displays a help menu, which acts as a valuable reference to users who may need clarification on how to use different commands and flags effectively.

Explanation:

• Simply calling synoupgrade without any arguments prompts the system to present helpful information regarding the command’s usage and available options.

Example Output:

synoupgrade: Tool for upgrading Synology DSM.
Usage:
  synoupgrade --check
  synoupgrade --download
  ...

Conclusion

The synoupgrade command serves as a powerful management tool that simplifies the task of keeping your Synology DSM up to date. Through a range of options, it affords administrators the flexibility to initiate upgrades manually or automate the process, ensuring that systems remain current, secure, and efficient. Adjusting to the specific use cases outlined above can enhance the operational excellence of network-attached storage by maintaining an updated ecosystem at all times.