Skip to content

Assure1 Broker Control Utility

Overview

The Assure1 Broker Control Utility interfaces with the Assure1 Broker Daemon/Service to send control signals for services and jobs on the various Assure1 servers. It can also be used to view configuration files and logs on the Assure1 servers. For administration, it is recommended that you use the standard web interface to perform actions rather than the command-line utility.

Administration Details

The following list shows the technical details needed for advanced administration of the application:

  • Interactive - ./BrokerControl

  • Batch Mode to return debug information - ./BrokerControl --batch debug

  • Package - assure1-app

  • Synopsis - ./BrokerControl [OPTIONS]

  • Options:

    • --Batch, -b COMMAND Batch mode (if supplied multiple times, commands will each be executed in the order they were specified)

    • --Mode, -m MODE Change the message transport mode to soap for direct communication (defaults to amqp)

    • --Server, -s SERVER Specify the broker to make initial connection to (localhost by default)

    • --Show-Response Always display raw contents of broker's response

    • --Log Optionally log request and output to $A1BASEDIR/logs/BrokerControl.log (defaults to off)

    • -?, -h, --Help Print usage and exit

  • Commands:

    • server <name|ip> Change to another Broker service

    • ping [BROKER] Ping the Broker for a basic response

    • listservices List all services and their states

    • listjobs List all jobs and their states

    • listall List all services and jobs

    • listservice <id> List service details specified by ID

    • listjob <id> List job details specified by ID

    • reloadappconfig <id> Reload application configuration of running service specified by ID

    • startall Start all processes

    • stopall Stop all processes

    • startservice <id> Start service specified by ID

    • stopservice <id> Stop service specified by ID

    • startjob <id> Start job specified by ID

    • disablepackage <package> Stop all apps in a package and prevent future execution

    • enablepackage <package> Allow apps in package to be run again

    • runjob <name> <args> Run an on-demand job

    • reload Reload all processes from database

    • readconfig Show the Assure1.conf file

    • debug [<path.to.node>] Dump Broker object information

    • exit|quit Exit Broker Control (interactive mode only)