- Introduction
- In-Service Upgrades
- Units in Inventory on 11.X
- Operation with Intellifi
- Support for Issues with this process
Introduction
Due to the upgrade process in SmartOS 11.X, it was recently found that upgrading from a SmartOS 11.X build to a SmartOS 12.X build above 12.1.3.1 may cause an upgrade error (Internal Error or File Corrupted Error) due to the inability to validate the larger images in memory. This only affects the 841-t6, 834-5, and 834-v6 (It does not affect the 854-6 and 854-v6). This will also affect transitioning from any version of PlumeOS to SmartOS 12.5.X or above on those platforms.
This issue can be solved by upgrading (or transitioning) to SmartOS 12.1.3.1 first, and then upgrading to the preferred build. The following guide provides scripts and processes to run this upgrade manual or automatically depending on if the unit is in box or in service, or is planned to be used with Intellifi Cloud.
In-Service Upgrades
In service upgrades can be done via the GUI of the SmartOS unit, via an ACS, or via Intellifi. All builds can be found at https://supportcommunity.adtran.com/t5/SDG-8xx-and-86xx-SmartOS-Software/bd-p/sdg-800-8000-software .
Via SmartOS GUI
This is done by logging into the GUI of the unit via it's IP address, and going to admin-> update and uploading the file. Due to this needing to be a two step upgrade, you will upload the SmartOS 12.1.3.1 build first and complete this upgrade. Once the unit is upgraded to 12.1.3.1, you will then follow the same process to upgrade the unit to your final build.
Via ACS
To upgrade via ACS, there will need to be two separate upgrade jobs: the 1st to take the unit to SmartOS 12.1.3.1, then the second to take the unit to the final SmartOS build desired. This can be done in two separate steps on different days/nights, both done in the same night within two separate time slots, or can be done as part of a script chain via Initial Contact or Bulk Ops. The methods below are displayed for users of MOSAIC Device Manager.
Upgrading via Device Manager Bulk Ops
Once logged into MOSAIC Device Manager, a Bulk Operation can be set up under the Bulk Operations tab to upgrade the units. The below picture shows an example of a job for an upgrade to 12.1.3.1.
In the above photo, a job upgrading units to SmartOS 12.1.3.1 is displayed. This job is set to run 5/16 and 5/17 from 2AM to 5AM. The running schedule can be changed to be a recurring job within any days or times sought. Once the units are upgraded to 12.1.3.1, a similar job will need to be run to take the units to the final desired SmartOS build (latest is recommended).
Note that when using the filter for the devices being selected, it's recommended to ensure that you are only upgrading the devices to 12.1.3.1 that need to go through this path. Specifically you can use the following options:
- Model - "pick from a list" - select all 834-v6, 834-5, 841-t6 models
- Firmware - "not one of a list" - add in 12.1.3.1, and your final firmware build (for example, 12.5.3.1)
- Last inform date - "on or after" - Select a date 2-3 days prior to today's date. This is to filter out units that are not up or may be decommissioned.
This prevents units from being updated that do not need to be in this manner.
Upgrading via Script
If it is desired to complete the full 2 step upgrade in one attempt, it can be done by either scheduling 2 different bulk ops the same day (but at different times), or via using a script method. Scripts are provided and attached to this support forum article that can accomplish this. This consists of 4 scripts:
- Auto Upgrade SmartOS 2Step
- Upgrade on Discovery1
- Reboot Before Second Upgrade
- Upgrade on Discovery2
To set this up, these 4 scripts need to be created on the MOSAIC Device Manager instance. This is done by going to Administration -> Scripts and copy/pasting the full scripts in. The names of the scripts must match when they are created or else the script chain will not function properly. The events and bulk operations checkboxes also need to be checked.
This script chain will properly identify the units which need to be upgraded, will reboot them, upgrade to 12.1.3.1, and then reboot them again before upgrading to 12.4.6.1 (this final build can be changed to any desired build as seen below).
This is triggered by setting up a bulk ops similar to in the above section (Upgrading via Bulk Ops), but for the Action "Auto Upgrade SmartOS 2Step" will be selected:
The "Golden Firmware", or essentially the desired final SmartOS build can be changed by making the following changes:
- The Golden Firmware variable needs to be changed to the desired version in the 1st Script, Auto Upgrade SmartOS 2Step
- /////////////////////////////////////////////////////////////
// Change the Approved Auto-Upgrade Target Version
var GoldenImage = "12.4.6.1" < ------- Change this
///////////////////////////////////////////////////////////// - The URL for the upgrade will need to be changed to final URL within the 4th script Upgrade on Discovery2
- log.info("Upgrade initiated");
var url = "https://s3.amazonaws.com/ADTN_Product_Downloads/SRG/SmartOS12.x/SmartOS-MTARM64P-v12.4.6.1.img";
var fdr = new FileDownloadRef(url, 0, "", 0, "", "");
var response = downloadFirmware(fdr);
log.info("status:"+response.status+" started:"+response.started+" completed:"+response.completed);
device.labels.remove("UpgradeInProgress")
- log.info("Upgrade initiated");
- /////////////////////////////////////////////////////////////
Units in Inventory on 11.X
If units are in inventory waiting to be deployed on 11.X, the two step upgrade can be done on initial contact if desired. This method adds ~7 minutes to the installation. The key is to ensure that the device is given ample time to upgrade without network disturbance.
The first step is to create and manage the scripts as shown in the above section, Upgrading via Script. The second is to enable the script chain via the Initial Contact event. To do this, go to Administration->Events -> Initial Contact and add the first script as seen below:
If it's desired to not do this on initial contact, you can instead set up recurring Bulk Operations as in the above sections to do it periodically after install. The units will still generally function on 11.X, but should be upgraded if possible to avoid any old software issues.
Operation with Intellifi
A unit that is intended to be used with Intellifi cloud that is coming out of the box on 11.X with need to be upgraded to 12.1.3.1 before it will be able to be claimed. It is recommended however to complete the full two step upgrade before attempting to claim to Intellifi to make the experience the most smooth. The initial contact method mentioned above is the preferred method in this case.
Support for Issues with this process
If you have issues at any time with this process or handling the scripts and two step upgrade, please open a ticket with ADTRAN Product Support at www.adtran.com/support.
