Configuration

Universal Broker reads its configuration options from the Universal Broker configuration file, ubroker.conf.

This file can be edited manually with any text editor.

For overriding Universal Agent component definition options and UAG configuration options, environment variable and command line options are provided.

Also, for overriding the default Universal Broker and UAG run-time configurations, environment variables and command line options are provided.

Configuration Options

The following table identifies all of the Universal Broker for UNIX configuration options. Each Option Name is a link to detailed information about that option.

Option Name	Description
ACTIVITY_MONITORING	Specification for generation of product activity monitoring events.
BIF_DIRECTORY	Broker Interface Directory where Universal Broker will create its broker interface file.
CA_CERTIFICATES	Path to PEM formatted trusted CA X.509 certificates.
CERTIFICATE	Path to Broker's PEM formatted X.509 certificate.
CERTIFICATE_EXPIRATION_NOTICE	Number of days prior to certificate expiration to begin issuing informational messages about the expiration.
CERTIFICATE_REVOCATION_LIST	Path to PEM formatted CRL.
CODE_PAGE	Text translation code page.
COMPONENT_BACKLOG	Component interface backlog size for pending connection requests.
COMPONENT_DIRECTORY	Component definition file directory.
CTL_SSL_CIPHER_LIST	SSL cipher list for the control sessions.
DNS_CACHE_TIMEOUT	Time-out for DNS cache.
EVENT_GENERATION	Events to be generated as persistent event records.
INSTALLATION_DIRECTORY	Base directory where product is installed.
LOG_DIRECTORY	Log file directory.
LOG_FILE_GENERATIONS	Total number of log files that will be saved within the log directory.
LOG_FILE_LINES	Total number of lines to be written to the log file before the log file is wrapped.
MESSAGE_DESTINATION	Location where messages are written.
MESSAGE_LANGUAGE	Language of written messages.
MESSAGE_LEVEL	Level of messages written.
MIN_SSL_PROTOCOL	Minimum SSL protocol level that will be negotiated and used for communications channels.
MONITOR_EVENT_EXPIRATION	Duration of a monitoring event record in the Universal Broker local UES database.
MSG_SUPPRESSION_LIST	List of message IDs representing Universal messages to be suppressed.
NLS_DIRECTORY	UMC and UTT file directory.
PERSISTENT_EVENT_EXPIRATION	Duration of a persistent event record in the Universal Broker local UES database.
PID_FILE_DIRECTORY	PID file location.
PRIVATE_KEY	Path to Broker's PEM formatted RSA private key.
PRIVATE_KEY_PWD	Password for the Broker's PRIVATE_KEY.
REQUIRE_SSL	Specification for whether or not Universal Broker will enforce the use of SSL connections by the clients (managers) of Universal Command Server and Universal Data Mover Server,
RETRY_MAX_COMP	Specification for whether or not the Start Component request is retryable when the maximum number of components are running.
RUNNING_MAX	Maximum number of simultaneous components.
SERVICE_BACKLOG	Service interface backlog size for pending connection requests.
SERVICE_IP_ADDRESS	TCP/IP address on which the Broker listens.
SERVICE_PORT	TCP/IP port number on which the Broker listens.
SPOOL_DIRECTORY	Spool file directory.
TMP_DIRECTORY	Temporary file directory.
TRACE_DIRECTORY	Trace file directory.
TRACE_FILE_LINES	Maximum number of lines written to the trace file.
TRACE_TABLE	Memory trace table specification.
WORKING_DIRECTORY	Broker's working directory.
Override Options	The following Universal Broker configuration options let you override UAG, OMS, and UEM automatically start component definition options and multiple UAG configuration options at Universal Broker start-up.
UAG_AUTOSTART	UAG AUTOMATICALLY_START component definition option override.
UEM_AUTOSTART	UEM AUTOMATICALLY_START component definition option override.
OMS_AUTOSTART	OMS AUTOMATICALLY_START component definition option override.
UAG_AGENT_CLUSTERS	UAG AGENT_CLUSTERS configuration option override.
UAG_EXTENSION_ACCEPT_LIST	UAG EXTENSION_ACCEPT_LIST configuration option override.
UAG_EXTENSION_CANCEL_TIMEOUT	UAG EXTENSION_CANCEL_TIMEOUT configuration option override.
UAG_EXTENSION_DEPLOY_ON_REGISTRATION	UAG EXTENSION_DEPLOY_ON_REGISTRATION configuration option override.
UAG_EXTENSION_PYTHON_LIST	UAG EXTENSION_PYTHON_LIST configuration option override.
UAG_NETNAME	UAG NETNAME configuration option override.
UAG_OMS_SERVERS	UAG OMS_SERVERS configuration option override.
UAG_TRANSIENT	UAG TRANSIENT configuration option override.

Component Management

Universal Broker is aware only of Universal Agent components that have been defined. It is the responsibility of Universal Broker to start, stop, and query these defined components.

One of the steps in the installation of a component is defining it to the local Universal Broker. These component definitions provide Universal Broker with the necessary information that it needs to manage the components.

Component Definitions

Component definitions are text files that define Universal Agent components to the Universal Broker. All UNIX component definition files are located in the Universal Broker component definition directory (specified with the COMPONENT_DIRECTORY configuration option).

The syntax of a component definition file is the same as the Universal Broker configuration file.

The following table identifies all of the options that comprise Universal Agent for UNIX component definitions. Each Option Name is a link to detailed information about that option.

Option Name	Description
AUTOMATICALLY_START	Specification for whether the component automatically starts by the Universal Broker at start-up time or only on demand.
COMPONENT_NAME	Name by which clients know the component.
COMPONENT_TYPE	Type of component.
CONFIGURATION_FILE *	Component's configuration file name.
RESTART	Specification for whether or not the component should be restarted if it ends.
RESTART_CONDITIONS	Exit conditions criteria for which the server is considered eligible for restart.
RESTART_DELAY	Number of seconds to wait before restarting.
RESTART_MAX_FREQUENCY	Maximum frequency a server can be restarted.
RUNNING_MAXIMUM	Maximum number of this component that can run simultaneously.
START_COMMAND *	Command that starts the component.
WORKING_DIRECTORY *	Path used as the working directory of the component.
* These options are required in the component definitions.

Universal Access Control List

Universal Broker uses the Universal Access Control List (UACL) file as an extra layer of security. The UACL file contains Universal Broker entries that contain Access Control List (ACL) rules that permit or deny access to Universal Broker.

Universal Broker reads in the UACL entries when the program is started. If the UACL file is changed, the new entries can be activated either by:

Stopping and starting Universal Broker
Sending Universal Broker a Universal Control REFRESH command, which instructs Universal Broker to reread all its configuration files, including the UACL file.

The UNIX REFRESH command is:

uctl -refresh -host BROKER-IPADDR

UACL Entries

The syntax of a UACL entry file is the same as the Universal Broker configuration file.

The following table identifies all Universal Broker for UNIX UACL entries. Each UACL Entry Name is a link to detailed information about that option.

UACL Entry Name	Description
UBROKER_ACCESS	Allows or denies access to Universal Broker services.
CERT_MAP	Maps a client X.509 certificate to a certificate identifier.
EVENT_ACCESS	Controls which Universal Enterprise Controller has read and delete access to the Universal Event Subsystem event data maintained by the Universal Broker.
REMOTE_CONFIG_ACCESS	Authorizes update access to the product configuration files and setting of the configuration managed mode of the Broker.

Browser not supported