Router Administration

This section provides information for common administrative tasks for the Solace Messaging Platform:

It also provides the following reference information to assist network administrators:

Documentation Conventions

The Solace customer documentation uses the following conventions:

  • The Solace Messaging platform is comprised of a network of Solace messaging routers. These routers may be purpose-built physical hardware devices (that is, appliances) or Solace Virtual Message Routers (VMRs) that can run on commodity hardware. In general, the term “router” is used in the customer documentation, and it applies to both physical routers and VMRs. In most cases, when the term “appliance” is used, it refers to a physical Solace router.
  • Examples of CLI commands and responses are written in the following manner:


    For this particular example, the Solace CLI is acting for the host router solace, it is at a CONFIG level, and it is awaiting a command string after the CONFIG prompt character (#).

  • When an item in a CLI command is not enclosed by < >, [ ], or { } symbols, the item is a required keyword.


    solace(configure/service/smf)# shutdown

  • When an item in a CLI command is enclosed with < > symbols, the information requested is a variable and required.


    interface <interface-id>

  • When an item in a CLI command is enclosed with [ ] symbols, the information requested is optional.


    show logging debug [<subsystem-id>]

  • When an item in a CLI command is enclosed by { } symbols, the information requested is a variable of which only one is required.


    boot {<version> | backout}

  • When two or more options in a CLI command are separated by a | symbol, you may at most enter one of the options as part of the command.


    tree [all | global]

  • Code snippets and command outputs are displayed in Courier font and may in some cases use a gray background.


    solace> show hardware

    Platform: Solace 3560

    Power redundancy configuration: 1+1

    Operational power supplies: 1

    System Type: topic-routing

    Supported Blade Configuration: Yes

    . . .

  • Code snippets and command outputs are only provided for demonstration purposes only. You should not assume that a code snippet copied directly from this document will work correctly in your CLI or that the display output will be an exact match to what your operating environment will generate.
  • System limits and supported value ranges for configuration parameters may be written with decimal (for example, megabytes) or binary (for example, mebibytes) units. In some places, binary units will include the exact number of bytes for clarity.
  • Unit Abbreviation Size in Bytes
    kilobyte KB 1,000
    kibibyte KiB 1,024
    megabyte MB 1,000,000 or 10002
    mebibyte MiB 1,048,576 or 10242
    gigabyte GB 1,000,000,000 or 10003
    gibibyte GiB 1,073,741,824 or 10243
    terabyte TB 1,000,000,000,000 or 10004
    tebibyte TiB 1,099,511,627,776 or 10244

  • For some configuration parameters, the maximum permitted values may not be explicitly stated in this document because they are dependent on factors that may vary (for example, the hardware, API, or protocols used).