In this section, you will find a detailed walkthrough for deploying the OpsRamp NextGen Gateway ISO using Hyper-V Manager on Windows.

Step 1: Launch Hyper-V Manager

1. Press Windows + S and type Hyper-V Manager in the search bar.
2. Select Hyper-V Manager from the results to open it.
3. If prompted, enter your credentials to proceed.

Step 2: Create a New Virtual Machine

1. In the Actions pane, select New > Virtual Machine.

2. The New Virtual Machine Wizard opens. Click Next to continue.

Step 3: Configure the Virtual Machine

1. Name and Location

   • Enter a VM name (for example: OpsRampGatewayVM).
   • Select a location to store VM files.
     

2. Specify Generation

   • Choose Generation 2 (recommended for UEFI support).

   
   

3. Memory

   • Allocate 8192 MB (8 GB RAM) minimum.

     
     

4. Networking

   • Select a virtual switch.
   • For internet access, choose an External Switch.

5. Virtual Hard Disk

   • Select “Create a new virtual hard disk”.
   • Set to 60 GB or higher.

   
   

6. Installation Options

   • Select “Install an operating system from a bootable image file”.
   • Click Browse and select the ISO file downloaded from the OpsRamp portal.
   • Click Next.

Step 4: Finish and Start the VM

Review the settings and click Finish to create the VM.

Step 5: Adjust CPU Allocation

1. Select the VM and click Settings to open the settings window.
   

2. In the settings window, go to Processor.

3. Under “Number of virtual processors”, set the value to 4 vCPUs.

4. Click OK to save changes.
   

Step 6: Connect to the VM

1. From the VM list, select the newly created VM.
2. Click Connect to open the console.

3. Start the VM to begin the Gateway ISO installation.

In this section, you will find a detailed walkthrough for deploying the OpsRamp NextGen Gateway as a virtual machine (VM) on a KVM hypervisor.

Step 1: Create the Disk Image

Create a new disk image for the VM using the following command.

qemu-img create -f qcow2 gateway.img 60G

• -f qcow2 → Specifies the QCOW2 disk image format.
• 60G → Sets the disk size to 60 GB.

Step 2: Create the VM XML Definition

Create an XML file, for example gateway.xml, to define the VM’s configuration. This definition specifies the VM’s resources, boot order, and device settings.

<domain type='kvm' id='1'>
  <!-- Unique domain name for identification -->
  <name>gateway</name>

  <!-- Total memory allocated to the VM in KiB (8 GB) -->
  <memory unit='KiB'>8388608</memory>
  <currentMemory unit='KiB'>8388608</currentMemory>

  <!-- Number of virtual CPUs assigned -->
  <vcpu placement='static'>4</vcpu>

  <os>
    <!-- OS type and architecture -->
    <type arch='x86_64'>hvm</type>
    
    <!-- Boot order: hard disk first, then CD-ROM -->
    <boot dev='hd'/>
    <boot dev='cdrom'/>
  </os>

  <features>
    <!-- Enable ACPI (power management), APIC (interrupt controller), and PAE (memory extension) -->
    <acpi/>
    <apic/>
    <pae/>
  </features>

  <!-- Set clock to UTC timezone -->
  <clock offset='utc'/>
  
  <!-- VM behavior on power off, reboot, and crash -->
  <on_poweroff>destroy</on_poweroff>
  <on_reboot>restart</on_reboot>
  <on_crash>destroy</on_crash>

  <devices>
    <!-- Emulator binary used to run the VM -->
    <emulator>/usr/bin/kvm-spice</emulator>
   
    <!-- Primary disk: QCOW2 image file used as the VM's hard drive -->
    <disk type='file' device='disk'>
      <driver name='qemu' type='qcow2' cache='none'/>
      <source file='/data01/os/gateway.img'/>
      <target dev='vda' bus='ide'/>
    </disk>
    
    <!-- CD-ROM device: ISO file used for installation or boot -->
    <disk type="file" device="cdrom">
      <source file="/data01/iso/OG_2204_20.0.0-202507301520-java-11.iso"/>
      <target dev="hdc" bus="ide"/>
      <readonly/>
    </disk>
   
    <!-- Network interface: bridged to 'kvmbr3104' for external connectivity -->
    <interface type='bridge'>
      <source bridge='kvmbr3104'/>
      <model type='virtio'/>
    </interface>
   
    <!-- Serial port for console access -->
    <serial type='pty'>
      <target port='0'/>
    </serial>
    
    <!-- Console configuration for VM access via terminal -->
    <console type='pty' tty='/dev/pts/1'>
      <target type='serial' port='0'/>
    </console>
   
    <!-- Input devices: mouse and keyboard via PS/2 bus -->
    <input type='mouse' bus='ps2'/>
    <input type='keyboard' bus='ps2'/>
    
    <!-- Graphics configuration: VNC access enabled, auto-assign port -->
    <graphics type='vnc' port='-1' autoport='yes' listen='0.0.0.0'>
      <listen type='address' address='0.0.0.0'/>
    </graphics>
  </devices>
</domain>

Step 3: Register the Virtual Machine with KVM

This step registers the virtual machine configuration in KVM using the above XML definition file. Registering the VM makes it known to the hypervisor so it can be started and managed.
Run the following command:

virsh define gateway.xml

Step 4: Verify the Virtual Machine Registration

This step confirms that the virtual machine has been successfully registered with KVM and is available for management, even if it is not currently running.
Run the following command:

virsh list --all

Step 5: Start the Virtual Machine

This step powers on the virtual machine so the operating system can boot and the VM becomes operational.
Run the following command:

virsh start gateway

Step 6: Retrieve the VNC Display Port

This step identifies the VNC display port assigned to the virtual machine, which is required to access the VM’s console.
Run the following command:

virsh vncdisplay gateway

Step 7: Connect to the Virtual Machine Console

Use a VNC client to access the virtual machine’s console by connecting to the host system’s IP address and the VNC port obtained in the previous step. This allows you to interact directly with the VM.
Example command:

vncviewer <host-ip>:<vnc-port>

Step 8: Assign an IP Address to the Virtual Machine

Inside the virtual machine, configure a static IP address (for example, 172.xx.xxx.xx) based on your network requirements. This ensures the VM is reachable on the network.

Step 9: Register the Gateway

After the virtual machine is running and has a valid IP address, proceed with registering the OpsRamp Gateway according to your environment’s registration process.

This page documents the workflow to deploy OpsRamp NextGen Gateway on HPE VME using ISO 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.

4. Click Edit.
   

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

Step 2: Download the NextGen Gateway ISO

To download the NextGen Gateway ISO 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 (ISO) tile. You can also choose the desired Gateway version from the available options from the dropdown.

5. Click NEXT.
6. Download the NextGen Gateway ISO by clicking on the VIRTUAL APPLIANCE (ISO) tile.

7. Once the ISO is downloaded, you can proceed to the installation Step.

Step 3: Create ISO image in the VME Library

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

2. Select +Add > ISO.
   

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

• Name: Name for ISO 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?

4. Select File for Create Image type.
5. Click Add File.
6. Upload the downloaded Gateway ISO file.
7. In the Advanced drop-down, select VIRTIO DRIVERS LOADED? and VM TOOLS INSTALLED?.
8. Click Save Changes.

You have now created the ISO 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 ISO image you just created.
• Select Host from the drop-down.
• In 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.