Universal Broker Configuration Options
- Stonebranch (Deactivated)
Universal Broker Configuration Options
This page provides links to detailed information on the configuration options available for use with the Universal Broker. Information on how these options are used is documented in the operating system-specific pages of this document.
The options are listed alphabetically, without regard to any specific operating system.
Configuration Options Information
For each configuration option, the following information is provided.
Description
Describes the configuration option and how it is used.
Usage
Provides a table of the following information:
Method | Syntax | IBM i | UNIX | Windows | z/OS |
Command Line, Long Form | <Format / Value> | ||||
Environment Variable | <Format / Value> | ||||
Configuration File Keyword | <Format / Value> |
Method
Identifies the method used to specify Universal Broker configuration options:
- Command Line Option, Long Form
- Environment Variable
- Configuration File Keyword
Note
You can specify most configuration options only using the Configuration File Keyword method. The details for each option identify the available methods.
Syntax
Identifies the syntax of the method used to specify the option:
- Format: Specific characters that identify the option.
- Value: Type of value(s) to be supplied for this method.
(Operating System)
Identifies the operating systems for which each method of specifying the option is valid:
- IBM i
- UNIX
- Windows
- z/OS
Values
Identifies all possible values for the specified value type.
Defaults are identified in bold type.
<Additional Information>
Identifies any additional information specific to the option.
Configuration Options List
The following table identifies all Universal Broker configuration options.
Option | Description |
Specification for whether or not product activity monitoring events are generated. | |
Broker Interface File directory that specifies where Universal Broker will create its 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. | |
TCP/IP port used for Broker-Component communications. | |
SSL cipher list for the control sessions. | |
| CTL_SSL_CIPHER_SUITES | SSL/TLS 1.3 specific cipher suites that are acceptable to use for network communications on the control session, which is used for component internal communication. |
Time-out for DNS cache. | |
| The ECDSA_CERTIFICATE option specifies the file / ddname name of the PEM-formatted ECDSA X.509 certificate that identifies the Universal Broker. | |
| The ECDSA_PRIVATE_KEY option specifies the location of the PEM-formatted ECDSA private key that corresponds to the X.509 certificate specified by the ECDSA_CERTIFICATE option. | |
| The ECDSA_PRIVATE_KEY_PWD option specifies the password or passphrase for the PEM-formatted ECDSA private key specified with the ECDSA_PRIVATE_KEY option. | |
Events to be generated as persistent events. | |
Base directory where product is installed. | |
Location of a remote Universal Broker key store. | |
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. | |
| MAX_SSL_PROTOCOL | Maximum SSL/TLS protocol level that will be negotiated and used for communications channels. |
Location where messages are written. | |
Language of messages written. | |
Level of messages written. | |
Minimum SSL protocol level that will be negotiated and used for communications channels. Note This option was introduced to IBM i in version 5.1.1.0. | |
Duration of a monitoring event record in the Universal Broker local UES database. | |
HFS or zFS database mount directory. | |
HFS or zFS permission mode for MOUNT_POINT. | |
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. Note This option was introduced to IBM i in version 5.1.1.0. | |
Specification for whether or not the Start Component request is retryable when the maximum number of components are running. | |
Maximum number of simultaneous components. | |
SAF certificate key ring name. | |
SAF certificate key ring label. | |
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. | |
| SHARED_MOUNT_POINT | zFS database shared mount directory. |
| SHARED_MOUNT_POINT_MODE | zFS permission mode for SHARED_MOUNT_POINT. |
UNVACTRT SMF exit load library. | |
Spool file directory. | |
SSL implementation to be used for network configuration. | |
Role that Universal Broker will perform in a Sysplex configuration. | |
Universal Broker running on a system (O/S image). | |
TCP/IP receive buffer size. | |
TCP/IP send buffer size. | |
Directory for temporary files. | |
Directory for trace files. | |
Maximum number of lines written to the trace file. | |
Memory trace table specification. | |
Support for Universal Command started tasks. | |
Absolute path to the UCMD external link that was created manually on the USS file system to support disabling the UID 0 requirement for the Universal Broker started task. | |
Absolute path to the UCTL external link that was created manually on the USS file system to support disabling the UID 0 requirement for the Universal Broker started task. | |
HFS or zFS data set used for the Universal Broker's databases. | |
HFS or zFS data set used for the Universal Broker's spool. | |
Absolute path to the USAP external link that was created manually on the USS file system to support disabling the UID 0 requirement for the Universal Broker started task. | |
Universal 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 for: |
| 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_BUSINESS_SERVICES | UAG BUSINESS_SERVICES 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_PROCESS_CANCEL_TIMEOUT | UAG PROCESS_CANCEL_TIMEOUT configuration option override. |