Introduction

Gateway firmware updates are regularly published. These updates are for security patches, bug fixes, and new features. This document describes how to update gateway firmware.

There are two kinds of firmware updates:

• Minor updates are made during product releases and are published about every three months.
• Major updates are made when the underlying firmware operating system reaches end-of-life (EOL). Major updates are published about every 5 years.

Gateways running unsupported firmware cannot connect to the cloud so it is important to keep gateways updated. See the Gateway support policy for more information. Also, the gateway virtual appliance is designed to host only OpsRamp software and is disabled if you install non- OpsRamp software.

Use the UI for major and minor updates.

Minor Update

The following section provides detailed steps for performing a minor firmware update of the Classic Gateway.

Prerequisite

The gateway must be running and communicating with the cloud.

Permissions

The following permissions required to update the Classic Gateway from OpsRamp Portal:

Follow these steps to enable the above permission set:

1. Navigate to Setup > Account > Users and Permissions.
2. Click the Permissions Sets tab.
3. Click + ADD. The Add Permission page is displayed.
4. Under Permission Set Details screen, enter a Permission Set Name and short Description.
5. Select the above mentioned permissions and click Save.

Refer to the Permission Sets document for more details on obtaining the necessary permissions.

Minor Update Procedure

Follow the Steps below to update the Classic Gateway from the OpsRamp Portal:

1. Login to OpsRamp Portal.

2. Navigate to Setup > Accounts.

3. Click on Collector Profiles.

4. Select the management profile you want to update from the list, then click the Action button.
   
   

5. Choose one of the following actions to update the Gateway:

   • Update Now: Select the desired Gateway profile and click Update Now.
     This triggers an immediate update, and the profile will be updated within minutes.
   • Update on Schedule: Select the required Gateway profile and click Update on Schedule.
     The Gateway will check for updates every 6 hours and automatically apply any new versions available.
   • Do not Allow Update: Click this option to disable updates for the Gateway.
   • Reconnect Tunnel: Select this option if you need to re-establish a connection tunnel for the Gateway. This can help resolve connectivity issues or refresh the connection.

6. An update request will be sent to the Gateway and the Gateway will be update to the latest version.

Major Update

The following section provides detailed steps for performing a major firmware update of the Classic Gateway.

Prerequisites

Before you begin the upgrade process, ensure the following:

• Confirm your current Gateway appliance model is one of the supported types, such as:

  • ONGVMAU20
  • ONGVMAU22

• Verify that your gateway tunnel is in TLS mode before you start the migration process. The SSHD tunnel-based gateway does not support gateway migration.

Save the resource configuration information for the existing gateway virtual appliance:

• Number of CPU cores
• Memory allocated
• Disk size and data store name in use
• Number of virtual networks on Virtual Appliance
• Details of vSwitches that are connected to the virtual appliance

Major Update Procedure

1. Get the current gateway configuration data

1. In a web browser, enter the gateway URL. For example: https://<Gateway IP address>:5480.

2. Log in using your username and password. Contact Support for default login credentials.

3. In the Administration Menu, note the following configuration setup data, which you need to configure the new gateway:

   • IP Address
   • Network Configuration
   • Date & Time
   • Registration details

4. Log out from the gateway.

2. Download the current gateway image

To download the Classic Gateway image, follow the steps below:

1. In the OpsRamp portal, select your client from All Clients.
2. Navigate to Setup > Account > Collector Profile.
3. On the Collector Profiles page, click DOWNLOAD.

4. In the Gateway Collectors page, select and download the image type for classic Gateway.

The classic gateway image is downloaded to your local system.

3. Detach the existing gateway

1. Navigate to Setup > Account > Collector Profiles in the OpsRamp console.
2. Select the collector profile associated with the Gateway you want to replace and click Detach Gateway.
   

4. Spin up a new virtual machine

Create a virtual appliance using the saved resource configuration information of the existing gateway. Configure the new virtual appliance using the configuration setup data.

1. Log into the gateway web user interface.

2. In the Administration Menu, enter the configuration setup data:

   • Network
   • Date
   • Time.

3. Click Save.

5. Attach the new gateway

1. In OpsRamp, navigate to Setup > Account > Collector Profiles.

2. Select the Collector profile from which you detached the old Gateway.

3. Click Reinstall and follow the instructions to install and register the gateway in the Register via Administration Console section.

6. Configure the new gateway

1. Select Administration Menu > Registration.

2. In the Registration window, note the OpsRamp Server URL.

3. Enter the information for the following options:

   • Activation Key: The OpsRamp -generated activation key.
   • OpsRamp Server: The OpsRamp server IP/URL.

4. Click Activate

5. After activation completes, click Register Appliance Now. The gateway registration status changes from Not Registered to Registered:

Gateway-based G1 monitoring is NOT supported in gateway version 5.3.0 and later.

If your previous gateway was used as a proxy for agent communication, you need to create the new gateway using the same IP address and manually start the proxy service from the gateway web user interface.

7. Verify the upgrade

Confirm the new Gateway is functioning properly by checking the following:

• Gateway status shows Connected under the Collector Profile Status.
• Under Registration Details, verify the Gateway model ID begins with ONG (e.g., ONGVMAU22).
• Confirm the firmware version reflects the latest update.
• Wait 5–10 minutes, then check monitoring graphs for the Gateway and managed devices.
• If the Gateway acts as a proxy for Agents, ensure Agents are active and reporting data.
• For Gateways monitoring verify recent data is being collected correctly.
• For Gateway connected resource monitoring verify recent data is being collected correctly.

×