Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

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:

  • start
    Start the ubrokerd daemon.
  • stop
    Stop the ubrokerd daemon.
  • restart
    Stop/start the ubrokerd daemon.
  • status
    Query the ubrokerd daemon status.

-uag_agent_clusters

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 yes, UAG Server will register with the Controller as a transient agent, and un-register from the Controller automatically when going offline.
  • If no, UAG Server will NOT enable the transient option.

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 yes, OMS Server will start automatically at Universal Broker start-up, regardless of the value specified in the component definition file.
  • If no, OMS Server will not start when the Universal Broker starts, regardless of the value specified in the component definition file.

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 yes, OMS Server will start automatically at Universal Broker start-up, regardless of the value specified in the component definition file.
  • If no, OMS Server will not start when the Universal Broker starts, regardless of the value specified in the 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.

  • A single value of * indicates that all extensions are accepted.
  • A single value of none indicates that no extensions are accepted.
-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:

  • s - seconds (default)
  • m - minutes
  • h - hours
  • d - days
-uag_extension_deploy_on_registration

Overrides the EXTENSION_DEPLOY_ON_REGISTRATION option in the UAG configuration file.

Controls Extension deployment behavior from Universal Controller.

  • If yes, the Controller will preemptively deploy all extensions acceptable by UAG.
  • If no, the Controller will only send Extension modules as needed (on demand).
-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:

  • s - seconds (default)
  • m - minutes
  • h - hours
  • d - days
-uem_autostart

Overrides the AUTOMATICALLY_START option in the UEM definition file.

  • If yes, UEM Server will start automatically at Universal Broker startup, regardless of the value specified in the component definition file.
  • If no, UEM Server will not start when the Universal Broker starts, regardless of the value specified in the component definition file.

If this option is omitted, the value specified in AUTOMATICALLY_START controls start-up behavior.

hDisplay 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.

...