Initial Setup

After a Solace PubSub+ appliance has been successfully installed, powered up (as described in the Prerequisites & Installation instructions for your model of appliance), and connected with a management console, you can quickly give it the minimum required configuration to allow client applications to connect to it and begin exchanging Direct or Guaranteed messages using samples built with Solace messaging Application Programming Interfaces (APIs) and other Solace-supported messaging APIs and protocols.

To perform the initial configuration, do the following steps:

  1. At initial log on, general access is established when the following prompt appears on your management console screen:

    solace login:

  2. Enter the default user administration name, and when you are prompted for a password, enter the default password:

    solace login: admin
    Password: admin

  3. Once CLI connectivity is established, a CLI banner and prompt similar to the following will display on your screen.

    System Software. SolOS-TR Version <version>

    Copyright 2004-2017 Solace Corporation. All rights reserved.

    Solace recommends that a system administrator change the default password for the admin user account once the initial Solace PubSub+ software configuration is completed. For information on managing CLI user accounts, see Management & Shell Users.

  4. Enter the following commands at the prompt:

    solace> enable
    solace# setup

  5. Follow the on-screen prompts to configure the network parameters shown in the table. Once the last one is entered, the appliance automatically powers down and then restarts.
  6. Parameter Prompted For... Description


    Enter an identifying hostname for the appliance.

    If this is the first time that the hostname is configured, once the last network parameter is entered, the appliance will be automatically powered down and then restarted. Rerunning the setup command will only result in an appliance power down and restart if the hostname is changed.

    Management Interface Configuration

    When prompted to place the management interfaces in an active-backup Link Aggregation Group (LAG), you can do one of the following:

    • To configure the two management interfaces as an active‑backup LAG, enter y. Then enter the interface (eth1 or eth2) that will be the primary interface for the LAG.
      This option groups the management interfaces into a single LAG named lag1, which provides a single IP address associated with the management interfaces.
    • To assign an independent IP interface to one of the management interfaces, enter n. Then enter the IP interface to be associated with the physical interface port (for example, eth1:1).

    If you want to assign an independent IP interface to the second management interface, it can be configured later after the setup.

    IP Address / subnet mask

    Enter an IP address and subnet mask to assign to the Management Virtual Routing and Forwarding (VRF) object used by the Management IP interface.

    Default gateway IP addresses

    Enter the IP address for the default gateway for the management network interfaces.

    Message Backbone VRF IP Address/ subnet mask

    Enter the IP address and subnet mask for the Message Backbone (that is, data) VRF (lag1) network interface.

    Time Zone

    Enter the local time zone relative to the Coordinated Universal Time (UTC).

    To view a full list of all supported system time zones, you can quit the setup, and enter the show clock timezones User Exec command.

    Synchronize with an NTP server or PTP

    When you are prompted to synchronize with a Network Time Protocol (NTP) server, you can do one of the following:

    • To synchronize the event broker’s clock with an NTP server, enter y. Then enter the IP address of a reachable NTP server.
    • If you don't want to synchronize the event broker’s clock with an NTP server, enter n. You must then enter the current local time and date.
    • If you want to synchronize the appliance's clock with PTP, enter n, and then enter the current local time and date. After setup is all done, you'll need to enable PTP. You'll find instructions at Configuring PTP for an Appliance.

    DNS server

    Enter the comma-separated IP addresses of up to three external Domain Name System (DNS) servers to use to resolve hostnames for network object IP addresses.

    Power Redundancy

    Solace PubSub+ appliances use redundant AC hot-swappable power supplies. Enter one of the following possible redundant power supply configurations appropriate for the appliance that you are setting up:

    • 1+1—The only possible configuration for a Solace PubSub+ 3230, 3530, or 3560 appliance. This configuration requires at least two active power supplies.
    • 2 + 1—Available for a Solace PubSub+ 3260, this configuration requires at least three active power supplies.
    • 2+2—Available for a Solace PubSub+ 3260, this configuration requires at least four active power supplies.
  7. After the appliance has powered down and then restarted, login to the appliance again.
  8. If one or more optional appliance features (for example, PubSub+ Cache service, Web transport service, or high-performance ADB service) were purchased, do the following:
    • To determine whether a product key to unlock the options was pre-entered by Solace, enter the following User EXEC command:

      solace> show product-key

      Any product keys currently in use, and the features they unlock, are displayed.

    • If any of the options are not unlocked, and you have valid product keys provided by Solace, use the following commands to manually enter them:

      solace> enable
      solace# admin
      solace(admin)# product-key <key-value>

    For assistance with locked features and product keys, refer to Product Keys or contact Solace.

Config-Sync will not automatically synchronize the objects or properties discussed in this section. Therefore, if the event broker is being used in a high-availability (HA) pair or in a replicated site, you must manually configure these objects/properties on each mate event broker or replicated Message VPN.

To determine whether an object/property is synchronized by Config-Sync, look up the command used to configure the object/property in the CLI Command Reference or type the command in the Solace CLI, ending the command with "?". The Help will list whether the object/property is synchronized.