Overview

This section provides step-by-step instructions to deploy the OpsRamp Gateway VM using an OVA template on supported platforms.

The supported environments are:

  • VMware vSphere / ESXi (on-premises)
  • HPE VM Essentials (VME)

Prerequisites

Before deploying the Gateway VM, ensure the following prerequisites are met:

  • OpsRamp Gateway OVA file downloaded from the OpsRamp portal.
  • Access permissions to deploy resources in the VMware vSphere/Esxi and HPE VME environment.
  • VM network connectivity to OpsRamp Cloud endpoints.
  • Valid license and credentials to register the Gateway.
  • Review the server requirements before creating a VM.

Installation Steps

Below are step-by-step instructions to deploy the OpsRamp Gateway in various environments:

VMware
HPE VME
Below are step-by-step instructions to deploy the OpsRamp Gateway on VMware environment:

Step 1. Connect to VMware ESXi Server

  • Open vSphere Client and log in to your ESXi host.

Step 2. Upload the Gateway OVA to Datastore

Before creating the VM, upload the Gateway OVA to the VMware datastore:

  1. In the vSphere Client, navigate to Storage.
  2. Select your target datastore.
  3. Click Datastore Browser.
  4. Click Upload > Upload File.
  5. Browse and select the Gateway OVA file downloaded from the OpsRamp portal.
  6. Wait for the upload to complete successfully.

Step 3. Deploy the OVA Template

  1. In vSphere Client, click File > Deploy OVF Template.
  2. Click Browse and navigate to the datastore where you uploaded the OVA file.
  3. Select the OVA file and click Open.

Step 4. Review OVA Template Details

  1. Verify details on the OVA Template Details screen such as VM size and configuration.
  2. Click Next.

Step 5. Name and Location

  1. Enter a unique name for the Gateway VM (e.g., OpsRamp-Gateway-01).
  2. Select the appropriate datacenter or folder location.
  3. Click Next.

Step 6. Select Resource Pool

  1. Select the resource pool (e.g., VG) where the VM will run.
  2. Click Next.

Step 7. Select Storage

  1. Select the datastore for VM files.
  2. Ensure there is enough free space.
  3. Click Next.

Step 8. Configure Disk Format

  1. Confirm datastore and available space.
  2. Enable Thick Provision Lazy Zeroed for better disk performance.
  3. Click Next.

Step 9. Network Mapping

  1. Select the network(s) that the Gateway VM will connect to.
  2. Click Next.

Step 10. Review Deployment Settings

  1. Review all selected configuration details, including VM name, datastore, disk format, and network mapping.
  2. Confirm that all settings are correct before proceeding.
  3. Click Finish to begin deploying the OVA.

Step 11. Monitor OVA Deployment

  1. Wait for the OVA deployment task to complete.
  2. You can monitor the progress in the Recent Tasks pane of the vSphere Client.
  3. Ensure the deployment completes successfully without errors.

Step 12. Power On the Gateway VM

Once the OVA deployment is complete, power on the virtual machine. In the vSphere Client:

  1. Right-click the Gateway VM.
  2. Select Power > Power On. This starts the Gateway VM and initiates the boot process.

Step 13. Access the VM Console

Open the VM console to verify the boot process and perform initial configuration if required.

  1. Select the Gateway VM.
  2. Click Open Console. Use this console to monitor startup messages and access the VM login prompt.

Step 14. Configure Network Settings

Inside the Gateway VM, configure the required network settings.

  1. Assign a static IP address based on your network design
  2. Configure subnet mask, gateway, and DNS as required This ensures the Gateway is reachable from the network.

Step 15. Verify Network Connectivity

Confirm that the Gateway VM has proper network connectivity.

  1. Verify the assigned IP address
  2. Test connectivity (for example, ping the default gateway or OpsRamp endpoints)
This page documents the workflow to deploy OpsRamp NextGen Gateway on HPE VME using OVA images, and then proceed with standard gateway registration.

Step 1: Verify/Enable Required HPE VME Cloud Settings

You need to ensure that the following cloud settings are enabled for a smooth installation of OpsRamp NextGen gateway.

  1. Log in to HPE VME.
  2. Navigate to Infrastructure > Clouds. In the Clouds type, you will see the cloud configuration entry (here, HVM-appliance).
  3. Click HVM-appliance.


  1. Click Edit.

  2. In the EDIT CLOUD page, ensure all the required options are enabled (as per your VME environment), listed in the table below.

FieldSelect
LocationEnabled
Advanced Options
  • Enable Disk Type Selection
  • Enable Storage Type Selection
  • Enable Network Interface Type Selection

Step 2: Download the NextGen Gateway OVA

To download the NextGen Gateway OVA from OpsRamp Portal, 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 + ADD.

  4. On the configuration page, enter the following details:

    • Profile Name: Provide a name for the profile you are creating.
    • Profile Type: By default, the Standard profile type is selected.
    • Description: Add a short description for the profile. (Optional)
    • Gateway Collector (NextGen): Select the VIRTUAL APPLIANCE (OVA) tile. You can also choose the desired Gateway version from the available options from the dropdown.


  1. Click NEXT.
  2. Download the NextGen Gateway OVA by clicking on the VIRTUAL APPLIANCE (OVA) tile.


  1. Once the OVA is downloaded, you can proceed to the installation Step.

Step 3: Create OVA image in the VME Library

  1. Navigate to Library > Virtual Images.
    The Virtual Images page displays multiple image types.

  2. Select +Add > VMware (vmdf/ovf/ova).

  3. In the UPLOAD VIRTUAL IMAGE page, enter the following details:


  • Name: Name for OVA image.
  • Labels: A short label/description.
  • Operating System: Ubuntu 22.04 (64-bit)
  • Minimum memory: 8 GB
  • Select IS CLOUD INIT AVAILABLE? and INSTALL AGENT?
  1. Select File for Create Image type.
  2. Click Add File.
  3. Upload the downloaded Gateway OVA file.
  4. In the Advanced drop-down, select VIRTIO DRIVERS LOADED? and VM TOOLS INSTALLED?.
  5. Click Save Changes.

You have now created the OVA image, which is available in the Library list.

Step 4: Deploy (spin up) the Gateway VM (Instance)

  1. In VME environment, navigate to Provisioning > Instances.

  2. Click Add. The CREATE INSTANCE page is displayed.

  3. Select the HPE VME / HVM option.

  4. Enter instance name in the CREATE INSTANCE page.

  5. Click Next

  6. Enter the following configurations:

    • Plan: 4 CPU / 16 GB Memory
    • Resource Pool: HVM Cluster
    • Volumes: root/60 GB/Standard
    • Networks: Management
    • Image: Select the OVA image you just created.
    • Select Host from the drop-down.
    • In the Advanced Options drop-down, select:
      QEMU ARGUMENTS - ATTACH VIRITO DRIVERS

  7. Click Next. You can skip the automation configuration options and click Next.

  8. Review the complete configuration and then click Complete.

Step 5: Monitor Deployment and Confirm VM Status

After submission, the VM will show as Creating in the Library list. Click the VM and you can see the progress. When complete, status will show as green.


Step 6: Get the Gateway IP address (for Registration)

  1. In Instances, click the instance name.
  2. From Actions, select Open Console.
  3. Locate the IP address shown in the console.


4. Use this IP for the standard OpsRamp gateway registration flow.

Step 7: Register the Gateway

Refer to the Install Gateway Using OpsRamp Bootstrap Tool page for step-by-step instructions for completing the Gateway installation.

Tabbed Interface with Table