Setting Up a VMR with Microsoft Hyper-V

This section will walk you through the steps required to get the Solace Virtual Message Router running in your environment and ready for messaging.


  • You have access to Windows Server 2012.

System Requirements

For Evaluation and Enterprise VMR editions, the system resources that you provision for the VM automatically determines the number of client connections to the VMR that can be made. If you provision:

  • 30 GB of disk space, 4 GB of RAM, and two vCPUs—a maximum of 1,000 client connections are possible. This is the minimum required system resources.
  • 30 GB of disk space, 12 GB of RAM, and four vCPUs or greater—a maximum of 10,000 client connections are possible.

For Community VMR editions, a maximum of 100 client connections is permitted. Increasing the system requirements will not increase the number of available client connections.


  • To get a Solace Version 7.2.2 VMR instance up and running and ready for messaging.

Download the Solace 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—On the Downloads page of, in the Products section, click Virtual Message Router, then click Hyper-V.

    After you read and agree to 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.

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:

  1. In VMware Player, click Player > File > Open.
  2. 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

  3. 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”.

  4. Name the VMR instance, and click Next.

    Specify VMR Instance Name and Location

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

    Assign Memory

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

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

    Connect Virtual Hard Disk

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

Start the VMR Instance

  1. Power on the VMR.

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

    Hyper-V Manager

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


  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.

    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.

Configuring Default User Passwords

Before the VMR messaging application can be accessed; passwords must be configured for the following default users from the sysadmin host environment.

Default Users and Names

User Type

User Name


CLI User


Default CLI user—has access to all CLI commands.

Root user

root Superuser in the support shell.
Support user support Default user in the support shell.
  • To set the support or root user passwords enter one of the following commands in the Linux host shell, and then follow the prompts:

    docker exec -i -t solace passwd support

    docker exec -i -t solace passwd root

    Set Support Root Passwords

    Note:   Logging in as the support user name will place the user in the shell environment of the container. The VMR prevents root login at the console and through SSH. If you require root access, login as support (to the container shell) or as sysadmin(to the Linux host shell), and then switch user to root.

  • To set the password for the admin user and enable remote access, do the following:
    1. To enter the Solace router CLI from the console in the Linux host environment, enter the solacectl cli command in the Linux host shell.

      [sysadmin@solace ~]$ solacectl cli

      A CLI banner and prompt appears:

      System Software. SolOS Version <version number>

      Copyright 2004-2017 Solace Corporation. All rights reserved.


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

    2. Within the Solace router CLI, you can set the password for the admin user enter the following commands:

      solace> enable

      solace# configure

      solace(configure)# username admin

      solace(configure/username)# change-password <password>

    3. To determine the IP address assigned to the VMR, enter the following CLI 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 router CLI for the VMR, you can now ssh to port 22 of the VMR's IP address and login in as the admin user.

Managing the VMR Configuration

Unlike a Solace messaging appliance, a VMR starts with a basic configuration that enables most common services. This basic configuration can be modified as required. For more information, refer to VMR Configuration Defaults.