Setting Up KVM VMR Machine Images

This tutorial will walk you through the steps required to get a single Solace Virtual Message Router (VMR) machine image instance up and running in a Centos or Ubuntu environment and ready for messaging.

To deploy VMRs in High-Availability (HA) redundancy groups, you must set up three separate VMRs and then configure them appropriately as a group. For information on how to configure existing VMRs as an HA group, see Managing VMR Redundancy.


  • You have installed a Linux Kernel-based Virtual Machine (KVM).
  • It will use the Virtual Machine Manager GUI for simplicity.

System Requirements

The VMR Machine Image provides a 30 GB disk partition, which is suitable for proof of concept use for up to 1,000 clients, but is insufficient for client connection tiers above 1,000 and most guaranteed messaging deployments in production environments. For production use, you must provision an additional drive for the message spool, and it is recommended to also provide an additional drive for diagnostics information. For instructions on provisioning additional storage space, see Externalizing the Message Spool and Diagnostics, and for information on other defaults, see VMR Configuration Defaults.

For Evaluation and Enterprise VMR editions, the number of client connections to the VMR that can be supported depends on the system resources you provision for the VM. The table below lists the minimum system resources that are required to support the client connections offered by each tier.

Minimum System Resources Required For Connection Scaling Tiers

Client Connections RAM (GiB) CPUs Minimum Recommended Diagnostics Volume Size (GB)
up to 1,000 4 2 8.6
up to 10,000 12 minimum of 4 10.7
up to 100,000 28 minimum of 8 21.5

Step 1: Get a VMR

The first requirement is to download an edition of the VMR. For KVM on Linux platforms, the VMR is distributed as a compressed QCOW2.

  • Evaluation or Community edition of the VMR: Go to the Downloads page of Then in the KVM square select Download QCOW2 and choose either Community Edition or Evaluation Edition. After you read and agree to the license agreement, a compressed QCOW2 file called soltr-<version>-vmr-<type>.tar.gz will be downloaded.
  • Enterprise version of the VMR: If you have purchased an Enterprise version of the VMR, Solace will provide information for how to download an enterprise version of the VMR QCOW2 file package from a secure Solace server. Contact Solace Support at if you require assistance.

Once you have the compressed QCOW2 package, you must extract the QCOW2 image.
Use the tar command to extract the image. For example:

Then you are left with a file called soltr-VERSION-vmr-evaluation.qcow2. This is the file you will use with Virtual Machine Manager.

Step 2: Import the VMR into the VM Manager

Once KVM is installed, the easiest way to create a virtual machine (VM) is with the Virtual Machine Manager application.

  1. Launch the Virtual Machine Manager application.




    $ virt-manager

  2. Then import the QCOW2 file into the Virtual Machine Manager. This will create a new VM image for the VMR.
    • Select the creation icon on the left of the menu. This will open up the New VM wizard. Enter an appropriate name for your Solace VMR VM and select Import Existing Disk Image. Then click Forward.
    • Select the QCOW2 file, leave the OS Type and Version as “Generic”, then click Forward.
    • Configure the Memory and CPUs for the VM, then click Forward.

      The amount of memory and CPUs configured can affect the number of client connections that can be made to the VMR . A minimum of 4 GiB of RAM and 2 CPUs is required for all VMR editions. For Evaluation and Enterprise editions, this enables a maximum of 1,000 client connections; if you increase the resources to at least 12 GiB of RAM and 4 CPUs, a maximum of 10,000 client connections can be made. Increasing RAM to at least 28 GiB and provisioning 8 CPUs allows a maximum of 100,000 client connections.

      For Community editions, a maximum of 100 client connections are permitted even if you provision more resources than the minimum system requirements.


    • Confirm that “Customize configuration before install” has been checked and that the network interface is correct by selecting Advanced Options (this example uses “MacVTap bridge”, which is a recommended option). Then click Finish.
    • The virtual machine manager will now launch the VM properties dialog.

    • Select 'Disk 1'. After expanding 'Advanced options', change the 'Disk bus' to VirtIO and set the 'Storage format' to qcow2. Click Apply and then Begin Installation.
    • The Solace VMR will start up and display console output similar to the following:

  3. Login to the VMR.

    The VMR messaging application software resides in a container that is wrapped within a Linux OS to form a VMR virtual machine image. In its default state, this VMR Linux host environment has remote login disabled and contains no passwords.

    To log in to the VMR for the first time you must log in as sysadmin, which is the default user account for the Linux host environment. You will be prompted to create a password for that user.

    When you are logged in as sysadmin, you can then create passwords for the default users through the console. You must assign these default users passwords to allow remote login.

Step 3: Configure the VMR’s Host Name

To set the hostname for the new VMR, do the following:

  1. Shut down the SolOS:

    [sysadmin@solace ~]$ solacectl service stop

  2. Configure the hostname:

    [sysadmin@solace ~]$ solacectl hostname configure <hostname>

  3. Restart the SolOS:

    [sysadmin@solace ~]$ solacectl service start

  4. Verify that the hostname has been set to the new one:

    [sysadmin@solace ~]$ hostname

Note:  The shell may still reflect the old hostname until a reboot, or a re-login (log out and log back in).


<name> is the hostname to assign to the VMR. Host names can contain up to 64 characters, composed of alphanumeric characters 0 to 9, a to z, A to Z, and underscores '_' and hyphens '-'. Note that '_' and '-' cannot be used at the beginning or end of a hostname. Host names must be unique among all configured routers.

Step 4: Access the Solace CLI

You can access the Solace CLI from the console in the Linux host environment. This is done through the Solace Control Utility.

When you first access the Solace CLI, you should do the following:

  • set a password for the admin user, which has access to all CLI commands
  • determine the VMR’s IP address so that you can enable remote access

To access the Solace CLI, do the following:

  1. To enter the Solace CLI from the console in the Linux host environment, enter the following command in the Linux host shell.

    [sysadmin@solace ~]$ solacectl cli

    A CLI banner and prompt appears.

    At the > prompt, you are at the User EXEC level of the Solace CLI command structure.

  2. Within the Solace CLI, enter the following commands to create an admin user named admin:

    solace> enable

    solace# configure

    solace(configure)# create username admin password <password>

    solace(configure/username)# global-access-level admin

  3. To determine the IP address assigned to the VMR, enter the following command:

    solace> show ip vrf management

    The displayed output lists the IP address assigned to the VMR (listed for eth0:1), which can be used to remotely manage the VMR (that is, not from the VM console).

    show ip vrf management command

  4. To remotely access the Solace CLI for the VMR, you can now ssh to port 2222 of the VMR’s IP address and login in as the admin user.
  5. ssh -p 2222 admin@<public_ip>

    Note: For VMR releases prior to 8.5.0, ssh to port 22.

Tip:  In addition to the admin CLI User, you can create additional CLI and file transfer users through the Solace CLI in the manner described in Administering Management & Shell Users.

Step 5: Review the VMR Configuration Defaults

Unlike a Solace appliance, by default, a VMR starts with a basic configuration that has most common services enabled and ready for use. This basic configuration and the default ports that are used can be modified as required. For details, see VMR Configuration Defaults.

Additional VMR Machine Image Configuration

You now have a VMR machine image with a basic configuration that is ready for messaging tasks. However, there are additional configuration tasks that you can perform. At this stage, you should do the following:

  1. Review the extra configuration tasks specific to VMR machine images presented on the Index of VMR Image Configuration Tasks page.

    These additional configurations allow you to further customize your VMR machine image to better suit your particular use-case and to make it more suitable for a production deployment.

  2. Begin to configure and manage the VMR machine image’s messaging operations through the Solace CLI in the same manner as you would other Solace messaging routers (say, a Solace messaging appliance or a Solace VMR Docker container). For information on how to perform these configuration and management tasks, see the topics in the Router Configuration category of the Solace customer documentation.