In some support cases, the support team might ask you to install a so-called "Weekly"-Bugfix Firmware or even downgrade the unit. Additionally, you might face the situation that you have to perform a firmware upgrade without being on-site.
These two specific scenarios bear the potential that the device might have issues on reboot during the firmware upgrade. Reason for this is that sometimes applying the configuration file, some of the lines are misinterpreted by the unit as either critical error or warning. This, in turn, in the worst case, can lead to a full loss of the current configuration file and reload of the system-default-configuration!
Following the below guide will help to reduce the chances of these events happening drastically.
How can I avoid such thing from happening in the first place?
When applying a configuration, you usually are prompted with different rollback choices - in other words: The unit is asking "What shall I do in case I find out that the configuration you want to apply is somehow corrupted?":
By default, the unit will choose to "Immediately stop applying the configuration file and roll back to the previous configuration". Normally, this also works fine, but in a case for whatever reason this does not work, because the unit once again interprets some line as suspicious, it might be that the device, to save itself, rolls back to the system-default configuration!
So, usually, when performing such a configuration application, we recommend to choose the third roll-back option "Ignore errors and finish applying the configuration file" - here, the unit will interpret line by line, and leave outlines which cause problems and let you know about issues in the Monitor logs under
Monitor > Logs
However, on firmware upgrades, we have no chance to select the rollback options for applying the startup-configuration on reboot directly. However, we have a small script which will overtake the job for us - mostly by support quickly referred to as the "setenv-script".
Reason for this naming is the CLI-commands which it writes into the unit when applied:
The command in line 6 basically is the heart of this script. It sets, that when the unit starts up, that the "stop-on-error" parameter is off, hindering full-scale crashes of the USG or reversion to the system-default configuration file.
Where can I find the script, and how can I apply it?
In case you are prompted to upgrade or downgrade your unit, please prepare the following steps before performing the firmware-application:
- Download the setenv-script: https://www.dropbox.com/s/wwn3wdqqxmbq4bc/setenv.zip?dl=0 or, if the link is not valid, please check the attached file on this knowledge-base entry
- Upload and apply via
Maintenance > File Manager > Shell Script
- Backup your configuration locally and in the USG
- Apply the firmware of choice
Note: It is important to mention, that while we advise with confidence to safely use this, there still might be unexpected incidents which still cause your device to fail on applying firmware upgrades - this, however, would be highly unexpected and requires to be raised to our support organization for further investigation. The recommendation at all times is to be on-site whenever possible when performing firmware upgrades.