Universal Broker for UNIX
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 |
Specification for generation of product activity monitoring events. | |
Broker Interface Directory where Universal Broker will create its broker interface file. | |
Path to PEM formatted trusted CA X.509 certificates. | |
Path to Broker's PEM formatted X.509 certificate. | |
Number of days prior to certificate expiration to begin issuing informational messages about the expiration. | |
Path to PEM formatted CRL. | |
Text translation code page. | |
Component interface backlog size for pending connection requests. | |
Component definition file directory. | |
SSL cipher list for the control sessions. | |
Time-out for DNS cache. | |
Events to be generated as persistent event records. | |
Base directory where product is installed. | |
Log file directory. | |
Total number of log files that will be saved within the log directory. | |
Total number of lines to be written to the log file before the log file is wrapped. | |
Location where messages are written. | |
Language of written messages. | |
Level of messages written. | |
Minimum SSL protocol level that will be negotiated and used for communications channels. | |
Duration of a monitoring event record in the Universal Broker local UES database. | |
List of message IDs representing Universal messages to be suppressed. | |
UMC and UTT file directory. | |
Duration of a persistent event record in the Universal Broker local UES database. | |
PID file location. | |
Path to Broker's PEM formatted RSA private key. | |
Password for the Broker's PRIVATE_KEY. | |
REQ_UPPS_CONN | Number of PeopleSoft connections that Universal Broker will request from a pool of connections permitted by your Universal Agent license. |
REQ_USAP_CONN | Number of SAP connections that Universal Broker will request from a pool of connections permitted by your Universal Agent license. |
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, | |
Specification for whether or not the Start Component request is retryable when the maximum number of components are running. | |
Maximum number of simultaneous components. | |
Service interface backlog size for pending connection requests. | |
TCP/IP address on which the Broker listens. | |
TCP/IP port number on which the Broker listens. | |
Spool file directory. | |
Temporary file directory. | |
Trace file directory. | |
Maximum number of lines written to the trace file. | |
Memory trace table specification. | |
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 |
---|---|
Specification for whether the component automatically starts by the Universal Broker at start-up time or only on demand. | |
Name by which clients know the component. | |
Type of component. | |
Component's configuration file name. | |
Specification for whether or not the component should be restarted if it ends. | |
Exit conditions criteria for which the server is considered eligible for restart. | |
Number of seconds to wait before restarting. | |
Maximum frequency a server can be restarted. | |
Maximum number of this component that can run simultaneously. | |
Command that starts the component. | |
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 |
---|---|
Allows or denies access to Universal Broker services. | |
Maps a client X.509 certificate to a certificate identifier. | |
Controls which Universal Enterprise Controller has read and delete access to the Universal Event Subsystem event data maintained by the Universal Broker. | |
Authorizes update access to the product configuration files and setting of the configuration managed mode of the Broker. |