In this section:

Related articles:

These instructions include the procedure for upgrading the SBC SWe Edge to the latest software release for the following platforms:

  • SBC SWe Edge - Azure Deployment
  • SBC SWe Edge - AWS Deployment
  • SBC SWe Edge - On-Premises Deployment

Prerequisites

General Recommendations
  • Software upgrades should be performed during off-peak hours.
  • Before upgrading or staging an upgrade, Ribbon recommends setting all logging to Error level unless advised by Ribbon support. For details about logging, refer to Working with Logging.
STOP
Read the current Release Notes for important information about the latest software release that may be relevant to your SBC SWe Edge configuration. A newer version of SBC SWe Edge may have different requirements than the previous version.

Comply with the following Prerequisites: 

Contact Ribbon Support for any problems you encounter during the software upgrade that you cannot resolve.

Performing the Upgrade - For Public Cloud Deployments

The Public Cloud deployment (Azure and AWS) instances of SBC SWe Edge are initially acquired and deployed via Azure Marketplace or Amazon Web Services (AWS).  For a subsequent upgrades to the SBC SWe Edge, go to the Ribbon Support Portal - Download Center to download the latest compressed software image bundle (.zip ) that contains the upgrade file and upload it onto the SBC SWe Edge. Software upgrades are available for Ribbon customers current on maintenance. (This upgrade offering is established upon initial license purchase from Ribbon.)

Ensure all Prerequisites are complete before attempting an upgrade.

Follow these steps for upgrading to the latest Azure instance of SBC SWe Edge:

Upgrade for Microsoft Azure Deployments

StepAction
1

For Azure

From the Ribbon Support Portal request and download the latest compressed software bundle for Microsoft Hyper-V: (SWeLite-Hyperv-release.X.x.xbuildxxx.zip, where X is the major software release number and additional x'es further detail the software release and build number). For software request and download instructions, refer to the Ribbon Support Portal.

For Azure, upgrades are offered for SBC SWe Edge Release 8.0.1 and later.

Example filename for an SBC SWe Edge compressed software image bundle that is compatible with an Azure-based instance: SWeLite-Hyperv-release-8.0.1build181.zip.

For AWS

From the Ribbon Support Portal request and download the latest compressed software bundle for KVM: (SWeLite-KVM-release.X.x.xbuildxxx.zip, where X is the major software release number and additional x'es further detail the software release and build number). For software request and download instructions, refer to the Ribbon Support Portal.

For AWS, upgrades are offered for SBC SWe Edge Release 9.0.0 and later.

Example filename for an SBC SWe Edge compressed software image bundle that is compatible with an Azure-based instance: SWeLite-KVM-release-9.0.0build181.zip.

NOTE: For detailed information on SBC SWe Edge latest releases, refer to the Release Notes.

2

To extract the actual image file within the compressed software bundle file:

  • Uncompress the software bundle file using a .zip file utility application, such as 7-Zip.
  • Navigate to the Update folder.
  • Retrieve the actual upgrade image file (ends with ".img.gz").

For Azure: An example image file SBCSWeLite-hyperv-release-8.0.1.build181.img.gz. This aforementioned image file is found inside the SWeLite-Hyperv-release-8.0.1build181.zip compressed software bundle file.

For AWS: An example image file is SBCSWeLite-kvm-release-9.0.0.build181.img.gz. This aforementioned image file is found inside the SWeLite-kvm-release-9.0.0build181.zip compressed software bundle file.

3

Perform one of the upgrade methods available: 


USE OF KVM, VMWARE, AND PRE-8.0 HYPER-V IMAGES IN AZURE WILL CAUSE A SOFTWARE UPLOAD FAILURE!

Do not upgrade an Azure-based SBC SWe Edge instance with any image with the "kvm" or "esxi" characters in the filename. Images that include these characters in the filename do not operate in an Azure-based SBC SWe Edge instance and will result in SBC failure. Only use Hyper-V images that are labeled with the 8.0.1 release or later.

NOTE: Hyper-V releases earlier than 8.0.1 (such as 7.0.x) cause faulty SBC operation, and are not supported by Ribbon in an Azure context.


Performing the Upgrade - For On-Premises Deployments

Ensure all Prerequisites are complete before attempting an upgrade.

Follow these steps for upgrading an SBC SWe Edge deployed via KVM, VMware ESXi, or Microsoft Hyper-V.

Upgrade for On Premises Deployments

StepAction
1

From the Ribbon Support Portal, request and download the latest compressed software image bundle:(SWeLite-<PlatformName>-release.X.x.x.buildxxx.zip, where <PlatformName> is the on-premises hypervisor type, X is the major software release number, and additional x'es further detail the software release and build number). For software request and download instructions, refer to the Ribbon Support Portal. 

NOTE: Ensure you download the appropriate file for your hypervisor.

Examples of SBC SWe Edge compressed software bundle files for upgrade purposes:

For Hyper-V: SWeLite-Hyperv-release.9.0.0build181.zip

For VMware: SWeLite-VMware-release.9.0.0build181.zip

For KVM: SWeLite-KVM-release.9.0.0build181.zip

2

 To extract the actual image file within the compressed software bundle file:

  • Uncompress the software bundle file using a .zip file utility application, such as 7-Zip.
  • Navigate to the Update folder.
  • Retrieve the actual upgrade image file (ends with .img.gz).


3

Perform one of the upgrade methods available: 


One-Step Upgrade

The One-Step Upgrade method automatically upgrades the currently inactive partition, makes it active, and boots the SBC from the newly upgraded partition in a single step. Upon completion, the system is automatically redirected to the Login screen. Verify that you are booting from the new partition either by checking the active partition, or by Viewing the Software Version.

  1. In the WebUI, click the Tasks tab.

  2. In the left navigation pane, click System > Software Upgrade.

    Upload Software


  3. Enter an optional Passphrase (refer to Using the Custom Passphrase).

  4. Click Backup.                                                   

  5. Under Select File, click the Browse button and select the SBC SWe Edge image file you extracted from the downloaded software bundle.

    Select File


  6. Click Upgrade. 

  7. Click OK to upload the new software. Do not close or navigate away from the browser window, or you may receive partial results. Throughout the upload process, the web interface displays update messages to indicate the progression of the upgrade, (sample screen displayed below). Once the upgrade is complete, the system automatically reboots.

    Sample - Upload Progress Screen


    Upon completion, the system automatically redirects to the Login screen.



  8. Verify the system is booting from the new partition: check the active partition or view the software Version.

    Ensure the SBC SWe Edge has upgraded by verifying the running software version.

Upgrading the Inactive Partition

The Upgrading the Inactive Partition method upgrades and activates the new version without rebooting the SBC SWe Edge or interrupting active call services during maintenance hours.

  1. In the WebUI, click the Settings tab.

  2. In the left navigation pane, go to System > Software Management > Application Partitions.

    Partitions Table




  3. Make note of the inactive partition number to which you are upgrading the software (the table entry listed without a tick mark under the Active Partition column). This will be important towards the end when verifying the last upload status of the inactive partition.

  4. Click Upload Software, located on the left side of the pane.

  5. Under Select File, click Browse and select the SBC SWe Edge image file you extracted from the downloaded software bundle.

    Select File




  6. Click OK. Do not close or navigate away from the browser window or you may receive partial results.

    Throughout the upload process, the web interface displays update messages to indicate the progression of the upgrade of the inactive partition. Under normal conditions, a typical upgrade takes about 5 minutes. When complete, the inactive partition is upgraded to the new software without rebooting the SBC SWe Edge and without interrupting active call services.

  7. Once the upgrade has completed, click the X in the corner of the box to dismiss the popup window.

  8. On the partition page, verify the Last Upload Status associated with the inactive partition is listed as Success.

    Last Upload Status - Success

     


    To set as the active partition, refer to Setting the Active Partition.

    To verify a successful upgrade, verify the running software version.

Post-Upgrade Checklist - All Deployments

StepAction
1

Clear the web browser cache before logging into the SBC SWe Edge.

2
Perform a backup on the new SBC SWe Edge version. Ribbon recommends renaming the backup filename to indicate the current software version and build number.
3Verify no new alarms were generated following the upgrade. In the event of new alarms, refer to Acting on Displayed Alarms.