Universal Broker Configuration Options


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.

DNS_CACHE_TIMEOUT

Time-out for DNS cache.

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.

MESSAGE_DESTINATION

Location where messages are written.