Using the Solacectl Utility

The Solace PubSub+ software message broker image package includes a command-line utility, solacectl, that automates common tasks in the Linux host environment. The Linux host environment can be accessed remotely by ssh to port 22, and logging in through the Linux host shell as user sysadmin.

Note:  The command examples in this section use a host name of vmr-132-1 in the Linux host shell.

The solacectl utility enables you to perform the following tasks for software message broker Cloud and Machine images:

To run the systemctl utility and view the available options, enter the following command from the Linux Host shell:

solacectl -h

Output similar to the following will display:

[sysadmin@vmr-132-1 ~]$ solacectl -h
Usage: solacectl [OPTIONS] COMMAND [ARGS]...

  A non-interpretive Command Line Interface for managing the Solace PubSub+ software message broker

Options:
  -h, --help  Show this message and exit.

Commands:
  cli                 Enter the PubSub+ Command Line Interface
  gather-diagnostics  Collect logs for debugging and diagnosing...
  hostname            Commands for managing the hostname of the...
  images              Commands for managing images in PubSub+...
  service             Commands for managing PubSub+ Application
  shell               Login to PubSub+ Application shell interface
  storage             Commands for managing storage in PubSub+...
  upgrade             Upgrade Solace PubSub+ software message...
  version             Display current release version