Setting Up a VMR with VMware Player

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

Note:  The VMR supports VMware Tools when running in a compatible hypervisor environment (ESXi or VMware Player). Supported VMware Tools functionality includes Managed Power Settings, Enhanced Networking, Network Status and Heartbeat; memory ballooning and time synchronization are not supported.


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 an Open Virtualization Archive (.OVA) 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 VMR Community Edition or VMR Evaluation Edition areas, select VM Images > OVA Package > VMware Player.

    After you read and agree to the license agreement, an OVA called soltr-<version>-vmr-<type>.ova 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 OVA file package from a secure Solace server. Contact Solace Support at if you require assistance.

Import the OVA into the Virtual Machine Manager

To create a new VM image for the VMR, import the OVA file into the virtual machine manager using the default configuration:

  1. In VMware Player, click Player > File > Open.
  2. In the Import Virtual Machine window that displays, select the OVA file that you downloaded, and click Import.
  3. The virtual machine manager will import the Solace VMR OVA.

Configure VMR Networking

Configure the VM image to use one of the interfaces on the host machine that has access to DHCP services. Note that other platforms (mainly VMware on Linux) may have different ways of specifying network interfaces, refer to the VMware documentation for more information. If you do not have an interface with access to DHCP, refer to Configuring Hypervisor Network Interfaces for alternative configurations.

  1. Right-click the VMR image, and choose Settings.
  2. In the Virtual Machine Settings dialog box that displays, select Network Adapter.
  3. In the Network Adapter settings view, select Configure Adapters.
  4. In the dialog box that displays, ensure that only one adapter is selected, and that it is the correct adapter for the Solace VMR to use.

    The above configuration shows a Bridged Adapter. The bridged adapter configuration provides the guest VM a network interface directly on the host computer’s network. It will appear as an independent device on that subnet and must have its network configuration set up using DHCP. This works well for static configurations where the VMR will be accessed from other machines on the network.

    One potential drawback of using DHCP on laptops is that they are often re-IP’d as they join different networks. This means the VMR will constantly change addresses as well.

    So, for these scenarios it is often simpler to use the Host-only Adapter. A host-only adapter will provide the VMR with a network interface that can only be reached from the host computer. When running in this mode, the VMR is not able to talk to any external networks and, therefore, will not be able to use a DHCP server on that network to retrieve IP configuration information. In this case, it is necessary to either enable DHCP services within the VM Manager or to provide the VMR with a static IP address. The VMR release notes provide instructions for both of these configurations.

Start the Solace VMR

  1. To start the VMR, in virtual machine manager, click the Power On button.


    The Solace VMR will startup and display console output similar to the following:

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

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

    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.