Universal Broker Configuration Options

Owned by Stonebranch (Deactivated)
Last updated: Feb 02, 2024
6 min read


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

ACTIVITY_MONITORING

Specification for whether or not product activity monitoring events are generated.

BIF_DIRECTORY

Broker Interface File directory that specifies where Universal Broker will create its 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.

COMPONENT_PORT

TCP/IP port used for Broker-Component communications.

CTL_SSL_CIPHER_LIST

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.

DB_FILE_GENERATIONS

Number of archived UBroker databases that should be stored.

DNS_CACHE_TIMEOUT

Time-out for DNS cache.

ECDSA_CERTIFICATE

 The ECDSA_CERTIFICATE option specifies the file / ddname name of the PEM-formatted ECDSA  X.509 certificate that identifies the Universal Broker.

ECDSA_PRIVATE_KEY

 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.

ECDSA_PRIVATE_KEY_PWD

 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.

EVENT_GENERATION

Events to be generated as persistent events.

INSTALLATION_DIRECTORY

Base directory where product is installed.

KEYSTORE_PATH

Location of a remote Universal Broker key store.

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.
MAX_SSL_PROTOCOL Maximum SSL/TLS protocol level that will be negotiated and used for communications channels.

MESSAGE_DESTINATION

Location where messages are written.

MESSAGE_LANGUAGE

Language of messages written.

MESSAGE_LEVEL

Level of messages written.

MIN_SSL_PROTOCOL

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.

MONITOR_EVENT_EXPIRATION

Duration of a monitoring event record in the Universal Broker local UES database.

MOUNT_POINT

HFS or zFS database mount directory.

MOUNT_POINT_MODE

HFS or zFS permission mode for MOUNT_POINT.

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

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.

Note

This option was introduced to IBM i in version 5.1.1.0.

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.

SAF_KEY_RING

SAF certificate key ring name.

SAF_KEY_RING_LABEL

SAF certificate key ring label.

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.
SHARED_MOUNT_POINT  zFS database shared mount directory.
SHARED_MOUNT_POINT_MODE  zFS permission mode for SHARED_MOUNT_POINT.

SMF_EXIT_LOAD_LIBRARY

UNVACTRT SMF exit load library.

SPOOL_DIRECTORY

Spool file directory.

SSL_IMPLEMENTATION

SSL implementation to be used for network configuration.

SYSPLEX_ROLE

Role that Universal Broker will perform in a Sysplex configuration.

SYSTEM_ID

Universal Broker running on a system (O/S image).

TCP_RECV_BUFFER

TCP/IP receive buffer size.

TCP_SEND_BUFFER

TCP/IP send buffer size.

TMP_DIRECTORY

Directory for temporary files.

TRACE_DIRECTORY

Directory for trace files.

TRACE_FILE_LINES

Maximum number of lines written to the trace file.

TRACE_TABLE

Memory trace table specification.

UCMD_STC_SUPPORT

Support for Universal Command started tasks.

UCMD_PATH

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.

UCTL_PATH

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.

UNIX_DB_DATA_SET

HFS or zFS data set used for the Universal Broker's databases.

UNIX_SPOOL_DATA_SET

HFS or zFS data set used for the Universal Broker's spool.

USAP_PATH

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.

WORKING_DIRECTORY

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.