OpsRamp regularly publishes gateway firmware updates. 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 18 months.

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 only host OpsRamp software and is disabled if you install non-OpsRamp software.

Use the UI for major and minor updates.

Minor update

Minor firmware updates can be done on your existing gateways.

Prerequisites

  • The gateway must be running and communicating with the cloud.
  • The gateway must have the previous firmware version currently installed. For example, you can update from version 5.3.0 to version 5.4.0.

Step 1: Create a user role

To update gateway firmware, create a user role and assign gateway firmware update permissions to the role:

  1. Go to Setup > Accounts > Permission Sets.
  2. From the Gateway Firmware drop-down menu, select the Allow Gateway Firmware Upgrade option and click Save.
  3. Go to Accounts > Roles, create a role, and assign the gateway permission set.
  4. Go to Accounts > Users, select your user name, and assign the created role.

Step 2: Update the gateway

  1. Go to Resource Management > Management Profiles and select the applicable client.
  2. Select Management OpsRamp Gateways.
  3. From the available gateways list, select the gateway you want to update.
  4. Click the Allow icon, which displays a confirmation pop-up.
  5. Click Yes to continue.
  6. Click the Update Now button.
  7. In the confirmation pop-up, click Yes to continue. The gateway is offline for few minutes while it downloads the new version.
  8. To update multiple gateways, select the gateways you want and click the Allow button.
  9. Wait five to fifteen minutes before verifying the gateway is online.
  10. Verify that the gateway Firmware Upgrade status displays up to date and that the Firmware Version status is the latest version, similar to the following figure:
Gateway Update

Major update

Major firmware updates cannot be done on an existing gateway. You must replace the existing gateway with a new gateway. A major gateway firmware update requires creating a new gateway and switching over to it.

Before you begin

Verify that your existing gateway model belongs to one of the following models:

  • VGVMA
  • VGAMI
  • VGAZU
  • VGGCE
  • VGPHY

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

Step 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 OpsRamp 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.

Step 2: Download the current gateway image

  1. Select Setup > Downloads.
  2. Click Gateway.
  3. Select ISO or OVA as required and click Download. This downloads the gateway to your system.

Step 3: Detach the existing gateway

Before you detach the gateway, make sure SIP Agent and Web Service Agent are not disabled in your management profile.

  1. Select Setup > Resources > Management Profiles.
  2. Select the gateway profile you want to detach. Remember this profile for step 5.
  3. Click Detach Gateway.
  4. On the Infrastructure page, make sure no other available device has the same gateway IP address. If a device with the same IP address exists, delete the device.
  5. Shut down the gateway.

Step 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.

Step 5: Attach the new gateway

  1. Select Setup > Resources > Management Profiles.
  2. Click Attach Gateway for the management profile from which the gateway was detached in step 3.
  3. Click Copy. The activation code is copied to the clipboard to be used in the next step.

Step 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:

Ubuntu Summary

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.

Step 7: Verify the upgrade

Verify the following options:

  • The gateway is connected and has a status of UP in the Management Profile Status column.

  • In Management Profile, click Management gateways and verify the following columns for the respective management profile:

    • Model; verify that the model ID starts with OG, such as OGVMAU18.
    • Firmware Version
  • Wait five minutes and verify recent graphs on either gateway or gateway-managed devices.

  • If a gateway is used as a Proxy server for Agents, verify that the Agents are in the Active state and verify recent graphs.

  • If a gateway is used for monitoring Web Services or SIP, verify recent graphs.