This document describes the process to update your gateways to minor and major firmware versions.
OpsRamp publishes updates to firmware that runs within the gateway, on a regular basis. These updates are driven by security patches, bug fixes and new features. There are two types of firmware updates:
- Minor updates that accompany OpsRamp releases. These are published roughly every 3 months.
- Major updates that are published when the underlying OS behind the firmware goes on End-of-Life (EOL). Major updates are published roughly every 18 months.
ImportantGateways running unsupported firmware cannot connect to OpsRamp. Therefore, it is important to keep your gateways updated. See the gateway support policy.
WarningThe gateway virtual appliance is designed to host OpsRamp software only. The gateway appliance will stop working if you install non-OpsRamp published software in the appliance.
Your gateways can be updated in place using the UI using the following steps:
- Creating a user role with permissions.
- Updating the gateway.
- Your current gateway is up and communicating with OpsRamp.
- Your current gateway is running the previous (-1) version of the latest firmware. Example: You can update from firmware version 5.3.0 to version 5.4.0.
Step 1: Create a user role
The user role must have the required permission for updating the gateway.
To create a user role:
- Go to Setup > Accounts > Permission Sets.
- From the Gateway Firmware drop-down menu, select the Allow Gateway Firmware Upgrade option and Save.
- Go to Accounts > Roles, create a role, and assign the gateway permission set.
- Go to Accounts > Users, select your user name and assign the created role.
SuccessYou have now created a user role and assigned gateway firmware update permissions to the role.
Step 2: Update the gateway
To update the gateway:
- Go to Resource Management > Management Profiles and select the required client.
- Select Management OpsRamp Gateways, from the available list of gateways, select the gateway to update.
- Click Allow icon. Confirmation pop-up window appears.
- Click Yes to proceed.
- From the Update Now button, click Update Now.
- From the confirmation pop-up, click Yes to proceed with the update.
- The gateway downloads the required files from OpsRamp cloud.
- The gateway is offline for few minutes during the update.
- To update multiple gateways, select the required gateways and click the Allow button.
- After 5-15 minutes, verify if that the gateway is online.
- Verify that the Firmware Upgrade status for the gateway displays as up to date and the gateway Firmware Version status displays the latest version.
Major firmware updates cannot done in place. You must retire your existing gateway and replace it with a new gateway.
Updating a gateway involves creating a new gateway and switching over to it:
- Obtaining configuration data of your current gateway.
- Downloading the latest gateway image.
- Detaching the existing gateway from your management profile.
- Spinning up a new virtual machine with latest gateway image.
- Attaching the new gateway to your management profile.
- Configuring the new gateway.
- Verify that your existing gateway model belongs to one of the following models:
- Verify that your gateway tunnel is in TLS before you start the migration process. The SSHD tunnel-based gateway does not support migration of the gateway.
Make note of the resource configuration 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: Obtain the configuration data
To obtain the configuration setup data from the OpsRamp gateway web user interface:
- From the web browser, enter the URL in the following format:
https://<Gateway IP address>:5480.
- Provide username and password to log in. For default login credentials, contact OpsRamp Support.
- From the Administration Menu, note the configuration setup data of IP Address, Network Configuration, Date & Time, and Registration details. The configuration setup data is required while attaching the new gateway.
- Log out from the OpsRamp gateway web user interface.
Step 2: Download the current gateway image from OpsRamp
- Select Setup > Downloads.
- Click Gateway.
- Select ISO or OVA as required and click Download.
SuccessThe gateway is now downloaded onto your system.
Step 3: Detach the existing gateway
To detach the existing gateway:
- Select Setup > Resources > Management Profiles.
Be sure that, before you detach the gateway, SIP Agent or Web Service Agent are not disabled in your existing management profile.
- Select the gateway profile that needs to be detached and click Detach Gateway.
Step 4: Spin up a new VM
To setup a new virtual appliance:
- Create a virtual appliance with the resource configurations of the existing OpsRamp gateway virtual appliance.
- Configure the new virtual appliance using the configuration setup data.
- Log into the OpsRamp gateway web user interface.
- From the Administration Menu, provide the configuration setup data for Network, Date and Time.
- Click Save.
Step 5: Attach the new gateway
To attach the new gateway:
- Select Setup > Resources > Management Profiles.
- Click Attach Gateway for the Management profile from which gateway is detached in step:4.
- Click Copy. The activation code is copied to clipboard. This activation code is required to configure gateway.
Step 6: Configure the gateway
To configure the gateway through the web user interface:
- Select Administration Menu > Registration.
- From the Registration screen, note OpsRamp Server URL.
- Provide details for the following options and click Activate:
- Activation Key: Refers to the activation key generated in OpsRamp
- OpsRamp Server: Refers to IP/URL of OpsRamp Server
- Click Register Appliance Now when the activation is complete. Registration Status of gateway changes from Not Registered to Registered.
NoteGateway-based G1 monitoring is NOT supported in gateway version 5.3.0 and later versions.
NoteIf your previous gateway is used as proxy for agent communication,
you need to create the gateway with the same IP address and manually start the proxy service from the gateway web user interface.
Step 7: Verify the upgrade
After successfully registering new gateway to the existing management profile, verify the following options:
- The gateway is connected and has the status UP in the Status column of Management Profile.
- From Management Profile, click Management gateways to verify Model, Firmware Version columns for the respective management profile. Verify if Model Starts with OG. For example, OGVMAU18.
- Wait for 5 minutes and verify the recent Graphs on either gateway or gateway-managed devices.
- If a gateway is used as a Proxy server for Agents, then verify if Agents are in the Active state and verify recent graphs.
- If a gateway is used for monitoring Web Services or SIP, verify the recent graphs.