Setting Up Hyper-V VMR Machine Images

This tutorial will walk you through the steps required to get a single Solace Virtual Message Router (VMR) machine image instance running in a Microsoft Hyper-V environment and ready for messaging.

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


  • You have access to Windows Server 2012.

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 Configuring Message Spool and Diagnostics Storage, 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 CPUs
up to 1,000 4 GiB 2
up to 10,000 12 GiB minimum of 4
up to 100,000 28 GiB minimum of 8

Step 1: Get a VMR

The first requirement is to obtain a VMR. The VMR is distributed as a Virtual Hard Disk (.vhd) file, which allows it to be easily imported in to virtualization software.

  • Evaluation or Community edition of the VMR: Go to the Downloads page of Then in the Hyper-V square select Download and choose either Community Edition or Evaluation Edition. After you accept the license agreement, a VHD called soltr-<version>-vmr-<type>.vhd.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 VHD file package from a secure Solace server. Contact Solace Support at if you require assistance.

Step 2: Create a New Virtual Machine

To create a new VM image for the VMR, you must create a new virtual machine from the VHD file.

To a new VM image for the VMR and start it , do the following:

  1. Open the Hyper-V Manager, and then right-click the Windows Server instance that will host the new VM and select New -> Virtual Machine.

    This will launch the New Virtual Machine Wizard.

    New VM

  2. In the “Before You Begin” step of the wizard click Next.

    Note:  The .vhd image downloaded in a previous step is compressed using gz compression and will need to be decompressed and placed in a suitable location; the default is “Documents > Hyper-V > Virtual hard drives”.

  3. Name the VMR instance, and click Next.

    Specify VMR Instance Name and Location

  4. Assign memory for the VMR instance, and click Next.

    Assign Memory

  5. Select a network adapter connected to a virtual switch, and click Next.


    Note:  An external virtual switch must be created prior the creating the new virtual machine if the VMR instance is to be reachable from external hosts.

  6. Select the virtual hard disk that the VMR will use, and click Next when complete.

    Connect Virtual Hard Disk

  7. Review the settings, then click Finish.

    Hyper-V Manager

    Wait until the Wizard closes. The VMR image will display in the Hyper-V Manager.

    Hyper-V Manager

  8. Right click your newly created VMR and select Settings...

    Select the Processor tab under Hardware and increase the number of virtual processors to 2.

  9. Power on the VMR.

    In the Hyper-V Manager, right-click the VMR instance you want to start, then click Start.

    Hyper-V Manager

  10. Open the console.

    Right-click the VMR, then click Connect.

    Hyper-V Manager

    The Solace VMR is successfully started when the login prompt similar to the following appears.


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

    Initial Login

    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, enter the following:

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


<name> is the hostname of the VMR. A hostname may contain up to 50 characters, composed of alphanumeric characters 0 to 9, a to z, A to Z, and hyphens (although hyphens cannot be used at the beginning or end of a hostname).

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 VMR Image Configurations 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.