Starting Universal Broker - UNIX
Starting Universal Broker for UNIX
Universal Broker can be executed in two different environments:
- Console Application
- Daemon
Differences between the environments are described in the following sections.
Only one instance of the Universal Broker can execute at any one time. A PID file is used to help ensure that there is only one active instance; it is a locking mechanism that prevents the execution of a second Broker. The PID file, ubroker.pid, is created in directory /var/opt/universal by default. If the PID file is in the PID directory, it is assumed that a Broker instance is executing.
Console Application
The ubroker command starts Universal Broker as a console application.
Console Security
Universal Broker runs with the same user ID as the user who starts it; it does not require superuser rights. Universal Broker only requires access to its installation directory and files, which often are created by the superuser account when the product is installed.
However, components started by Universal Broker also run with the same user ID as Universal Broker. Some of these components may require superuser rights.
See Universal Agent Security for details on their security requirements for specific Universal Agent components.
Daemon
Universal Broker can run as a UNIX daemon process. This is the preferred method of running the Broker.
A daemon start-up script, ubrokerd, is provided to manage the starting and stopping of the Broker daemon. The start-up script utilizes the PID file to ensure that only one instance of the Broker is executing at any one time. For this reason, the start-up script should be used to start and stop the Broker.
Note
Although they have the same name, the Broker daemon start-up script (ubrokerd) should not be confused with the actual Broker daemon program file.
- Daemon start-up script is installed in the primary Broker directory (that is,
./universal/ubroker). - Daemon program file is installed in the Broker's
bindirectory (that is,./universal/ubroker/bin).
The following table describes the command line arguments to the Universal Broker daemon start-up script.
Command | Description |
|---|---|
start | Starts the Universal Broker daemon. Only one instance of Universal Broker can run at any given time, so if the Broker already is running, the command fails and the script returns. |
stop | Stops the Universal Broker daemon. If the Broker daemon is not running, the script simply returns. |
status | Returns the status of the Universal Broker daemon, either running or stopped. If the daemon is running, the script displays its process ID. |
restart | Performs a stop request followed by a start request. |
Usage
ubrokerd command [-uag_agent_clusters list] [-uag_netname name] [-uag_oms_servers port1@ip1[;...portn@ipn] [-uag_autostart opt] [-oms_autostart opt] [-uag_extension_accept_list list] [-uag_extension_cancel_timeout time] [-uag_extension_python_list path1[,pathn]] [-uag_extension_deploy_on_registration opt] [-uag_process_cancel_timeout time] [-uem_autostart opt] [-uag_transient opt] [-h]
Options
Option Name | Description |
COMMAND | Command to execute for the ubrokerd daemon:
|
Overrides the AGENT_CLUSTERS option in the UAG configuration file. A list of one or more comma-separated agent clusters defined in the Universal Controller that the Agent should join. | |
| -uag_transient | Overrides the TRANSIENT option in the UAG Server configuration file.
If this option is omitted, the value specified for the TRANSIENT option in the UAG Server config file controls start-up behavior. |
| -uag_netname | Overrides the network ID of Universal Automation Center Agent (UAG) in the NETNAME UAG configuration option. UAG Server will use this ID when connecting to a Universal Controller. If the NETNAME value is OPSAUTOCONF (the default), and the UAG Server already has connected to a Universal Controller, the qname value that holds the UAG Server's assigned netname must be deleted before it can be overridden by this option. |
| -uag_oms_servers | Overrides the values in the OMS_SERVERS UAG configuration option. A list of one or more OMS Servers to which this Agent will connect. |
| -uag_autostart | Overrides the AUTOMATICALLY_START option in the UAG Server component definition.
If this option is omitted, the value specified in AUTOMATICALLY_START controls start-up behavior. |
| -oms_autostart | Overrides the AUTOMATICALLY_START option in the OMS Server component definition file.
If this option is omitted, the value specified in AUTOMATICALLY_START controls start-up behavior. |
| -uag_extension_accept_list | Overrides the EXTENSION_ACCEPT_LIST option in the UAG configuration file. Specifies a list of Universal Extensions that the Agent will accept via auto-deployment from Universal Controller. The list consists of one or more comma-separated Extension names.
|
| -uag_extension_cancel_timeout | Overrides the EXTENSION_CANCEL_TIMEOUT option in the UAG configuration file. Specifies the amount of time that an Extension process will be allowed to run following a Cancel message being received from the Controller. If the Extension process is still running after the extension_cancel_timeout expires, UAG will forcibly terminate the process. The format of the value is nnnn[s|m|h|d], where nnnn is a numeric value and [s|m|h|d] is one of the following optional unit specifiers:
|
| -uag_extension_deploy_on_registration | Overrides the EXTENSION_DEPLOY_ON_REGISTRATION option in the UAG configuration file. Controls Extension deployment behavior from Universal Controller.
|
| -uag_extension_python_list | Overrides the EXTENSION_PYTHON_LIST option in the UAG configuration file. Specifies a comma-separated list of zero or more Python locations. Each item in the list is expected to contain a complete path to a Python executable. |
| -uag_process_cancel_timeout | Overrides the PROCESS_CANCEL_TIMEOUT option in the UAG configuration file. Specifies the amount of time that an OS task process will be allowed to run following a Cancel message being received from the Controller. If the process is still running after the process_cancel_timeout expires, UAG will forcibly terminate the process. The format of the value is nnnn[s|m|h|d], where nnnn is a numeric value and [s|m|h|d] is one of the following optional unit specifiers:
|
| -uem_autostart | Overrides the AUTOMATICALLY_START option in the UEM definition file.
If this option is omitted, the value specified in AUTOMATICALLY_START controls start-up behavior. |
| h | Display program usage. |
Daemon Security
When a daemon is started at system initialization, it is started as user root. The root user ID provides sufficient authority for the Broker and any component it may start.
If the daemon is started with a non-root user ID, the environment is the same as if it was started as a console application. (See Console Security, above, for more details.)