VMware ESXi

This section will walk you through the steps required to get a single Solace PubSub+ software message broker instance running in your environment and ready for messaging.

Before you begin

It's assumed you have:

VMware Tools Support

The Solace PubSub+ software message broker 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 number of CPUs and system memory required by your message broker depends on the number of client connections you need to support. By default, fresh installations of the message broker allow up to 100 client connections by default.

The following table lists the minimum system resources required to support each client connection scaling tier.

Minimum System Resources Required For Connection Scaling Tiers

Client Connections CPUs* Virtual Memory (MiB)
up to 100 2 1,903
up to 1,000 2 5,301
up to 10,000 4 12,892
up to 100,000 8 28,191
up to 200,000 12 53,816

*The monitoring node in a high-availability (HA) group needs only 1 CPU.

If you plan to scale your deployment above the 1,000 client connections tier you should note that the Solace PubSub+ software message broker 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's also recommended to provide an additional drive for diagnostics information. For instructions on provisioning additional storage space, see Storage Configuration, and for information on other defaults, see Default Configuration for Software Message Brokers.

High Availability Considerations

To deploy message brokers in high-availability (HA) redundancy groups, you must set up three separate message broker instances and then configure them as an HA group. For more information on how to configure existing message brokers into an HA group, see HA Group Configuration.

Step 1: Get a Software Message Broker

The first task is to download the Solace PubSub+ software message broker. It is distributed as an Open Virtualization Archive (.OVA) file, which allows for easy importation to virtualization software.

  • Solace PubSub+ Standard or Solace PubSub+ Enterprise Evaluation Edition: Go to the Solace PubSub+ Message Broker downloads page. Select the OVA square in either thePubSub+ Standard or PubSub+ Enterprise Evaluation section, and then select the Download link. An OVA called solace-pubsub-standard-<version>.ova or solace-pubsub-evaluation-<version>.ova, as appropriate, will be downloaded.
  • Solace PubSub+ Enterprise: If you have purchased PubSub+ Enterprise, Solace will provide information on how to download an OVA file package from a secure Solace server. Contact Solace Support at support@solace.com if you require assistance.

Step 2: Import into the VMware ESXi Host

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

To import, then start the message broker, 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 message broker instance, and click Next.

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

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

  8. Wait while the message broker image is uploaded to the ESXi host.

  9. Power on the message broker.

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

  10. Open the console.

    Right-click the message broker, then choose Open Console.

    The message broker has successfully started when the login prompt appears.

  11. Login to the message broker.

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

    To log in to the message broker 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 Host Name

To set the hostname for the new message broker, do the following:

  1. Shut down Solace PubSub+:

    [sysadmin@solace ~]$ solacectl service stop

  2. Configure the hostname:

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

  3. Restart the Solace PubSub+:

    [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 message broker. 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 message brokers.

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 message broker’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 message broker, enter the following command:

    solace> show ip vrf management

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

    solace> show ip vrf management
    VRF: management
    Number of interfaces: 1
    Status Flags:   R=Redundancy,  A=Admin,  O=Oper,  P=Physical
    Status Values:  U=Up,  D=Down,  N=Not Applicable
    Interface       V Router  IP Address          Source  R  A  O  P
    --------------  --------  ------------------  ------  -----------
    intf0:1         static    <IP Address>        system  U  U  U  U
    Number of active global routes: 5
    Destination       Gateway           Network Mask      Interface
    ----------------  ----------------  ----------------  ----------   *          N/A        *              N/A
    default            intf0       *              intf0     *            intf0
  4. To remotely access the Solace CLI for the message broker, you can now ssh to port 2222 of the message broker’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 Configuration Defaults

By default, a message broker 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 Default Configuration for Software Message Brokers.

Next Steps

You now have a message broker 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 begin to configure and manage the message broker’s messaging operations through the Solace CLI. For information on how to perform these configuration and management tasks, refer to the topics in Configuration.