VMware ESXi VMR Machine Image Set Up

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

Before you begin

It's assumed you have:

VMware Tools Support

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

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 & Diagnostics, and for information on other defaults, see Configuration Defaults for VMRs.

The number of client connections to the VMR that can be supported depends on the system resources you provision. The table below lists the minimum system resources that are required to support the client connections offered by each scaling tier.

Minimum System Resources Required For Connection Scaling Tiers

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

High Availability Considerations

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

Step 1: Get a 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 dev.solace.com. Then in the VMware square select Download OVA and choose either Community Edition or Evaluation Edition. 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 support@solace.com if you require assistance.

Step 2: Import the VMR into the VMware ESXi Host

To create a new VM image for the VMR, you must import the OVA file into the VMware ESXi host, and once it is imported, you can start the VMR instance.

To import, then start the VMR, do the following:

  1. Launch a vSphere Client, and then choose File > Deploy OVF Template.

  2. In the Deploy OVF Template window that displays, select your OVA file downloaded, and click Next.
  3. Verify the OVF template details, and click Next.
  4. Enter a name for the VMR instance, and click Next.

  5. Select a location for the VMR storage, and click Next.

  6. Select the format of the virtual disk that the VMR will use (thick provisioning is recommended), and click Next when complete.
  7. Review the settings, and click Finish.

  8. Wait while the VMR image is uploaded to the ESXi host.

  9. Power on the VMR.

    In the vSphere Client, right-click the VMR, and choose Power > Power On.

  10. Open the console.

    Right-click the VMR, then choose Open Console.

    The Solace VMR is successfully started when the login prompt 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.

    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>

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 Management & Shell Users.

Step 5: Review VMR Configuration Defaults

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 Configuration Defaults for VMRs.

Next Steps

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 Topics Unique to VMR Cloud & Machine Images 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 Configuration category of the Solace customer documentation.