Software Upgrade/Rollback (Single Node)

Owned by Kelli Higdon
Last updated: Apr 01, 2024
7 min read

 

 

The procedure below is a template which describes the software upgrade or downgrade process used on the IMG 2020. The example below describes the steps required to upgrade the system software and license files utilizing just the SD card, a linux server running BootP/FTP, or a combination of both. If the server running the BootP/FTP services is something other than linux, the procedure below can be used as a template but it is up to the administrator of the network to know and execute the commands and processes needed to upgrade software for their operating system.

When upgrading to a new point release such as going from software release 2.2 to 2.3 the current 2.2 license file will need to be removed and archived and a new 2.3 license must be loaded. Failure to load a new license could result in the IMG 2020 not configuring after the upgrade has completed.

Time Requirements

Time required to execute upgrade

Approximately 30 minutes

Call processing downtime

Approximately 10 minutes 

Preliminary

Prior to upgrading the software observe the following:

  • Status of each of the items listed below. Items that were not in service before the upgrade should not be expected to be in service after the upgrade. 

    • Nodes

    • Spans

    • Channels

    • ISDN D-Channels

    • SS7 Links

    • Network Interfaces

    • Web GUI users logged in. Notify them of the pending upgrade and have them logoff.

Obtain Software and Backup Existing Files

Follow the steps below to first obtain the updated version of system software.

  • Obtain the latest version of software from the Sangoma BBS (Bulletin Board System).

    • Download the latest 2020 IMG released software file (.zip). Within this zipped file is the system software needed. The example below displays an example of the system software file.

    • System Software

bdn2020_ver230xxx_id0201.bin (xxx=build number)

Backup Software, Licenses, and Configuration Files

Backup all older versions of software, licenses, and Configuration Files. Follow procedure below.

  • Before starting the actual upgrade process, save and backup the configuration. The file can be saved through the Configuration Tab in the Web GUI. Click on the Save ICON. A Save File dialog box will appear. In the File Name: field enter a name that will identify the file being saved. Click on the Save button to save the file.

  • Using sFTP, transfer the file just saved (.dat extension) to another directory (Preferably to a local machine where the files cannot be lost). This will be the backup configuration file that can be used in the event the original configuration file gets corrupted.

If transferring the file using sFTP, the sFTP functionality must first be enabled on the IMG 2020. Refer to the SFTP Server topic for information on this.

  • Using sFTP, transfer the license file to the same directory. This will also be a backup in the event the original license file gets corrupt.

  • Using sFTP transfer the old system software file bdn2020_ver230xxx_id0201.bin to the same directory.

Important Note for Upgrading from Software Release 2.2 to 2.3!!!!

This section only applies to an upgrade of software where the upgrade is going from 2.2 to 2.3. If you are not upgrading from software 2.2 to 2.3, disregard this section and move on to the Transfer Files section below. In the 2.3 release, because of the added functionality, the manner in which some of the objects are configured had been reworked. Because of this, the objects will not work correctly in the 2.3 release and must first be deleted before executing the upgrade. Below is a list of the objects that have been reworked:

  • DNS Clients

    • DNS Servers

    • ENUM Server Sets

If any of these objects are included in your configuration, follow the procedure below.

  • From the Web GUI, delete all DNS Client objects.

  • From the Web GUI, delete all DNS Server objects.

  • From the Web GUI, delete all ENUM Server Set objects.

  • Save the current configuration by clicking on the Save ICON. A Save File dialog box will appear. In the field labeled File Name, enter a name that will identify the updated file being saved for the 2.2 software upgrade. Click on the Save button to save the file. One thing to note is the latest save just initiated will not include the objects displayed above.

  • Continue on with the upgrade process as described in the sections below. Once the upgrade has completed, the files that were deleted can now be re-added using the updated format. Refer to the DNS Servers, DNS Clients and ENUM Server topics for information on configuring these objects.

Transfer Files

Using an sFTP utility, SD card reader/writer, or a combination of both, transfer the new system software file to the IMG 2020 (Example File: bdn2020_ver230xxx_id0201.bin).

Method 1 - (Using SD Card Reader/Writer)

  • If using an SD card reader/writer, first remove the SD card from the front of the IMG 2020 chassis and insert it into the SD reader/writer. Copy and paste or drag and drop the new binary file to the SD card.

  • Edit the file=bdn2020_ver230xxx_id0201.bin line in the bootup.cfg file so the new software build version number is displayed in the "xxx" section of that line.

  • If a new license file is being loaded, copy the license file to the directory on the SD card that contains the system software file.

  • Remove the SD card from the SD reader/writer and reinsert into the IMG 2020.

  • Restart the IMG 2020 by either power cycling the IMG 2020 or clicking on the Reset IMG 2020 button on the IMG 2020 physical node object.

  • After the IMG 2020 has been reset it will go through a series of diagnostics and the LEDs on the front panel will blink in a specific sequence to indicate it is in the loading process. Refer to the Software Install - SD Card for additional LED and software loading information.

  • Once software has downloaded, the IMG 2020 will utilize the .dat file to re-configure the IMG 2020 with the newer software.

  • Open up a browser and enter the IP address used to connect to the IMG 2020. Enter the logon credentials when prompted.

  • Once the Web GUI has opened, verify the correct version of software is loaded by clicking on the IMG 2020 physical node object and verify the build of software displayed in the Software Version field is the updated version.

  • Verify all spans that were in service prior to upgrade return to in-service state.

  • Verify calls are being processed to all trunk groups.

Method 2 - (Using a Combination of FTP and SD Card)

  • Using sFTP, transfer the new software file to the FTP server. The software file must be transferred in binary mode.

  • Edit the naming of the file just transferred to equal the name given to the file in the bootup.cfg file. If the Software Loading installation procedures in this documentation were followed, modify the file naming to the following below:
    bdn2020_id0201.bin

  • If a new license file is being loaded, ftp the license file to the folder that contains the system software file.

  • Restart the IMG 2020 by either power cycling the IMG 2020 or clicking on the Reset IMG 2020 button on the IMG 2020 node object.

  • After the IMG 2020 has been reset it will go through a series of diagnostics and the LEDs on the front panel will blink in a specific sequence to indicate it is in the loading process. Refer to the Software Install - FTP/SD Card for additional LED and software loading information.

  • Once software has downloaded, the IMG 2020 will use the .dat file to re-configure the IMG 2020 with the newer software.

  • Open up a browser and enter the IP address used to connect to the IMG 2020. Once the Web GUI has opened, verify the correct version of software is loaded by clicking on the IMG 2020 physical node object and verify the build of software displayed in the Software Version field is the updated version.

  • Verify all spans that were in service prior to upgrade return to in-service state.

  • Verify calls are being processed to all trunk groups.

Method 3 - (Using FTP and DHCP Services on a Single Server)

  • Using sFTP, transfer the new software file to the FTP server. The software file must be transferred in binary mode.

  • If a new license file is being loaded, sftp the license file to the folder that contains the system software file.

  • Once the system software file has been loaded onto the server it can be modified to equal the naming convention used in the filename line of the dhcpd.conf file. If the Configure server topic in this WebHelp was used during the software installation process, the file needs to be modified to the following:
    bdn2020_id0201.bin

  • It may be necessary to restart the dhcpd service on the server running the dhcpd service. The service can be restarted by root user only. The commands below will restart the dhcpd service.
    # /sbin/service dhcpd restart

  • Restart the IMG 2020 by either power cycling the IMG 2020 or clicking on the Reset IMG 2020 button on the IMG 2020 node object in the Web GUI.

  • After the IMG 2020 has been reset it will go through a series of diagnostics and the LEDs on the front panel will blink in a specific sequence to indicate it is in the loading process. Refer to the topic for additional LED and software loading information.

  • Once software has downloaded, the IMG 2020 will use the .dat file to re-configure the IMG 2020 with the newer software.

  • Open up a browser and enter the IP address used to connect to the IMG 2020. Once the Web GUI has opened, verify the correct version of software is loaded by clicking on the IMG 2020 physical node object and verify the build of software displayed in the Software Version field is the updated version.

  • Verify all spans that were in service prior to upgrade return to in-service state.

  • Verify calls are being processed to all trunk groups.

Post-Installation

Once the system has come back into service and all functionality has been restored, it is good practice to move all the old software, configuration, license, and log files into a common directory. Rename the configuration file to reflect which software build the file was originally configured on.

Downgrading System Software (Single Node)

The steps performed when upgrading or downgrading the system software are the same. When performing a downgrade of the system software verify the following:

  • Depending on which software the IMG 2020 is being downgraded from, and which software it is being downgraded to, in some instances an older license file may be required.

  • After the upgrade process, if for any reason the software needs to be downgraded back to its original build, the configuration files, software builds, and license files have all been copied into a set directory as explained in the upgrade procedure above. These files can be used in this scenario.After the downgrade of software, verify all functionality that existed before the upgrade still exists after the downgrade.

Return to Documentation Home I Return to Sangoma Support