English (US) Italiano
Follow

Migration from Version 5.x to 6.x

Applies to platform: All supported UTM 5.x models (see below)
Updated on: 24th Oct 2022

This document provides the official migration instructions for upgrading a supported UTM appliance from EndianOS 5.x to the latest 6.x version. Please read this document carefully and in its entirety to fully understand the requirements, warnings and migration process details.

IMPORTANT WARNINGS

  • THE UPGRADE BUTTON IS ONLY DISPLAYED IF THE APPLIANCE IS UP TO DATE
  • If you have an appliance with a Switchboard module and are wanting to upgrade, please contact Endian support.
  • If you have a 5.x HA cluster, please follow the special instructions provided below

Supported Models

The following models (only) are supported for EndianOS 6.x:

Endian UTM Macro:

  • Endian UTM Macro (2022 Edition)
  • Endian UTM Macro (2021 Edition) 
  • Endian UTM Macro 250 (2020 Edition)
  • Endian UTM Macro 500 (2020 Edition)
  • Endian UTM Macro Plus
  • Endian UTM Macro 250
  • Endian UTM Macro 500
  • Endian UTM Macro 1000
  • Endian UTM Macro 2500

Endian UTM Mercury:

  • Endian UTM Mercury (2021 Edition)
  • Endian UTM Mercury 50 (2018 Edition)
  • Endian UTM Mercury 50 WiFi
  • Endian UTM Mercury 100

Endian UTM Mini:

  • Endian UTM Mini (2022 Edition)
  • Endian UTM Mini 25 (2017 Edition)
  • Endian UTM Mini 25 WiFi (2017 Edition)
  • Endian UTM Mini 10 
  • Endian UTM Mini 10 WiFi

Endian UTM Software and Virtual:

  • Endian UTM Software Appliance
  • Endian UTM Software Appliance UEFI 
  • Endian UTM Virtual Appliance 
  • Endian UTM Virtual Appliance UEFI

Known Issues

The following are the most important known issues with EndianOS 6.x:

  • Only English language is complete (Italian/German will be completed in a future update)
  • Network monitoring (NTOP) has been replaced with the all new Network Awareness feature
  • SPAM Training feature is currently not available

HA Migration Procedure

Note

The HA system on EndianOS UTM 6.x is very different from the one on EndianOS UTM 5.x and so it's recommended to setup from scratch in order to upgrade your appliances. This will require some downtime in order to complete the process for multiple systems. In addition, with EndianOS UTM 6.x you can now cluster up to (maximum) 3 appliances in the HA cluster to provide even greater redundancy.

If you currently have a 5.x HA cluster and wish to upgrade your devices, please follow these steps FIRST:

  • Before backing up the master appliance:
    • Disconnect it from the network, and let the slave takeover in order to avoid downtime.
    • Run the following command in SSH on the master:
      root@endian:~# ha-purge
    • Create a backup and export it.
  • Reinstall the master with version 6.x and import the version 5.x backup.
  • Power off the slave and power on the master, connect it back to the network.
  • Reinstall the slave with version 6.x and register it on Endian Network (without importing any backup).
  • Recreate the HA system acting from Master HA configuration page only (enabling and configuring the HA from the master and then adding the slave from the master only)

Hardware Migration Procedure

The procedure is only applicable for upgrading supported Endian UTM hardware appliances.

Prerequisites:

  • You must fully update your appliance (instructions) to the most current version of EndianOS UTM 5.x
  • It is recommended to have a 2GB or larger bootable USB stick 
  • (Optional) Serial console cable with adapters if required to connect a computer to the Endian appliance

Step 1:  Create two different backups of your current Endian 5.x appliance using this article (ignore the option about saving to USB checkbox).

Step 1a: We recommend first doing a full backup with all options included (see below) which should be archived to a safe location (computer, network share, etc):

image2022-10-13_10-59-34.png

Step 1b: We next recommend doing a configuration backup (only) to use for the actual restore process. This can be saved to your local computer.

image2022-10-13_11-8-8.png

Step 2:  Complete the upgrade process for your appliance in Endian Network using the following steps:

Step 2a:  Login to Endian Network

Step 2b:  Locate your UTM appliance in the list and click the Reinstall as 6.x button

Note

If you do not see the Reinstall as 6.x button, this is most likely due to your system not being fully up-to-date. Please follow these instructions to update your system.

image2022-10-24_8-50-49.png

Step 2c:  You will be asked to confirm your upgrade selection (ensure the correct system was selected). Click OK to continue to final confirmation (a new tab will open with migration instructions).

image2022-10-24_8-54-3.png

Click Upgrade NOW button to complete the process.

image2022-11-3_13-51-26.png

Step 3:  Download the EndianOS UTM 6.x image that corresponds to your exact appliance you wish to upgrade. Once downloaded, write the image onto the USB drive following these instructions.

Step 4:  Install your 6.x image onto your appliance by:

  • Plug in the imaged USB stick (from Step 3) into the appliance.
  • Start the appliance and install the system. Before the system starts the installation, you will hear 10 quick, short "beeps" followed by a long one: this is the countdown that precedes the installation.
  • Wait for the installation to complete, which is suggested by three quick beeps followed by a longer one.
  • Afterwards the appliance will turn itself off, if it does not, you need to forcefully power it off and remove the USB stick.
  • The final step is to power back on the device.

Step 5: Restore a backup on the Appliance.

  • During the initial wizard, you will be provided an option to Restore from backup.
  • Select this option and continue to follow the instructions to restore the backup file created from Step 1b.
  • The system should automatically reboot after the restore process is completed.

At this point the upgrade process is complete and you should have the new Endian OS UTM 6.x system running successfully. Congratulations and enjoy!

 

Software/Virtual Migration Procedures

The procedure is only applicable for upgrading existing Endian UTM software/virtual appliances.

Prerequisites:

  • You must fully update your appliance (instructions) to the most current version of EndianOS UTM 5.x

Step 1:  Create two different backups of your current Endian 5.x appliance using this article (ignore the option about saving to USB checkbox).

Step 1a: We recommend first doing a full backup with all options included (see below) which should be archived to a safe location (computer, network share, etc):

Note

For Software/Virtual appliances, we do NOT recommend including the hardware data so make sure you uncheck the Include hardware data checkbox

image2022-10-24_9-42-10.png

Step 1b: We next recommend doing a configuration backup (only) to use for the actual restore process. This can be saved to your local computer.

Note

For Software/Virtual appliances, we do NOT recommend including the hardware data so make sure you uncheck the Include hardware data checkbox
image2022-10-24_9-42-46.png

Step 2:  Complete the upgrade process for your appliance in Endian Network using the following steps:

Step 2a:  Login to Endian Network

Step 2b:  Locate your UTM appliance in the list and click the Reinstall as 6.x button

Note

If you do not see the Reinstall as 6.x button, this is most likely due to your system not being fully up-to-date. Please follow these instructions to update your system.

image2022-10-24_8-50-49.png

Step 2c:  You will be asked to confirm your upgrade selection (ensure the correct system was selected). Click OK to continue to final confirmation (a new tab will open with migration instructions).

image2022-10-24_8-54-3.png

Click Upgrade NOW button to complete the process.

image2022-11-3_13-51-26.png

Step 3:  Download the EndianOS UTM 6.x image for your virtual/software appliance by modifying the URL below with your appliance activation code (found under System > Endian Network)

http://download.endian.com/your-activation-code-here

Step 4:  Install your 6.x image onto your appliance by following the instructions in the corresponding Endian Quickstarter document below.  For Virtual appliances, you may also consult the README files which are located inside the zip file you receive.

Note

If you have a virtual appliance, the procedure is very similar to a normal operating system installation on a VM. Inside the virtual appliance ZIP file you downloaded in Step 3, you will find both the ISO file that you can import into virtual CD drive of your blank VM to start the installation, or all the already prepared virtual appliances files for different hypervisors. Based on the hypervisors you will need, you can refer to related TXT file inside virtual appliance ZIP file for the installation steps.

Step 5: Restore a backup on the Appliance.

  • During the initial wizard, you will be provided an option to Restore from backup.
  • Select this option and continue to follow the instructions to restore the backup file created from Step 1b.
  • The system should automatically reboot after the restore process is completed.

At this point the upgrade process is complete and you should have the new Endian OS UTM 6.x system running successfully. Congratulations and enjoy!

If You Use HTTP Proxy with Active Directory Authentication?

You will need to rejoin the new Endian 6.x appliance to the AD domain by going to HTTP Proxy > Authentication (tab) and ensure accurate information and click Join ADS.

Having trouble with the new interface?

In order to get familiar with the system you can access our reference manual at http://docs.endian.com/6.5/utm/index.html

What Should I do If Something Goes Wrong?

Should you encounter any technical issues, please contact Endian Support.

Have more questions? Submit a request

Comments