CLI Command Reference

This section each of the commands available in the Solace PubSub+ message broker Command Line Interface (CLI). The commands are listed separately for each CLI level.

The CLI is the interface to the software that you use to access Solace PubSub+ functionality. The CLI provides commands that you can use to perform various tasks, including configuring, monitoring and troubleshooting the software, network connectivity, and, for the Solace PubSub+ appliance, hardware.

Conventions

The following conventions are used in the Solace CLI documentation:

  • Examples of CLI entries and responses are written in the following manner:

    solace(configure)#

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

    Example:

    interface <interface-id>

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

    Example:

    show logging debug [<subsystem-id>]

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

    Example:

    boot {<version> | backout}

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

    Example:

    show router name

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

    Example:

    tree [all | global]