Overview

This page provides links to detailed information on the configuration options available for use with the OMS Server.

The options are listed alphabetically, without regard to any specific operating system.

Configuration Options Information

For each configuration option, these pages provide the following information.

Description

Describes the configuration option and how it is used.

Usage

Provides a table of the following information:

Method	Syntax	IBM i	HP NonStop	UNIX	Windows	z/OS
Configuration File Keyword	<Format / Value>
Environment Variable	<Format / Value>

Method

Identifies the method used to specify OMS configuration options:

Configuration File Keyword
Environment Variable

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
HP NonStop
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 OMS configuration options. Each Option Name is a link to detailed information about that option.

Option Name	Description
AUTHENTICATE_PEER	Controls whether or not OMS server will validate host name and/or IP addresss of the incoming client connection based on its certificate.
CODE_PAGE	Universal Translate Table (utt) file to use for network data translation to and from the local code page and Unicode.
DNS_CACHE_TIMEOUT	Number of seconds that a successfully resolved host name is cached.
INDEX_CACHE_SIZE	Size of the memory cache used to store the message index.
INSTALLATION_DIRECTORY	Directory where OMS is installed.
MAX_CONNECTIONS	Maximum number of concurrent connections that can be made to an OMS server.
MAX_DATA_FILE_SIZE	Maximum size of a message data file.
MAX_MESSAGE_SIZE	Maximum message size allowed by the OMS server.
MAX_SSL_PROTOCOL	Maximum SSL/TLS protocol level that will be negotiated and used for communications channels.
MESSAGE_LANGUAGE	Message catalog used to format messages.
MESSAGE_LEVEL	Level of messages written.
MIN_SSL_PROTOCOL	Minimum SSL/TLS protocol level that will be negotiated and used for communications channels.
MSG_CHUNK_SIZE	Size limit where messages exceeding the limit will be split into "chunks" no larger than that limit for transmission.
MSG_CLEANUP_INTERVAL	Interval for message data file clean-up.
MSG_DATA_FLUSH_INTERVAL	Interval for message data flush to disk.
MSG_SUPPRESSION_LIST	List of message IDs representing Universal messages to be suppressed.
NLS_DIRECTORY	Directory where OMS message catalog and code page tables are located.
OTEL_ENABLE_TRACING	Specification for whether or not OMS will export traces to the Opentelemetry collector.
OTEL_EXPORT_METRICS	Specification for whether or not OMS will export metrics to the Opentelemetry collector.
OTEL_METRICS_ENDPOINT	URL used to export OMS metric data using the OTLP/HTTP(S) protocol to the Opentelemetry Collector.
OTEL_METRICS_EXPORT_INTERVAL	Interval for how often to export the metrics to the Opentelemetry Collector.
OTEL_SERVICE_NAME	Value of the `service.name` resource attribute used to identify OMS in traces and metrics.
OTEL_SSL_CA_CERT_PATH	Full path to the file containing one or more X.509 trusted certificates in PEM format. The certificate(s) will be used to validate the Opentelemetry Collector (server).
OTEL_SSL_CLIENT_CERT_PATH	Full path to an X.509 certificate used to identify OMS to the Opentelemetry Collector. This option is only needed for HTTP connections where client authentication is set up in the Opentelemetry Collector.
OTEL_SSL_CLIENT_KEY_PATH	Full path to the PEM formatted file containing the private key associated with the client certificate specified by the OTEL_SSL_CLIENT_CERT_PATH option. This option is only needed for HTTP connections where client authentication is set up in the Opentelemetry Collector.
OTEL_SSL_INSECURE_SKIP_VERIFY	Specification for whether or not to validate the Opentelemetry Collector's (server's) certificate against the locally configured CA certificate.
OTEL_TRACE_ENDPOINT	URL used to export OMS trace data using the OTLP/HTTP(S) protocol to the Opentelemetry Collector.
REQUIRE_SSL	Specification for whether or not the OMS Server will enforce the use of SSL/TLS connections by clients.
SERVICE_BACKLOG	Size of the service interface backlog queue in TCP/IP for pending connection requests.
SERVICE_IP_ADDRESS	IP address on which to accept OMS connection requests.
SERVICE_PORT	Port to use to listen for OMS connection requests.
SERVICE_TIMEOUT	Number of seconds of inactivity before the OMS server considers the connection as inactive and closes the connection.
SPOOL_DIRECTORY	Directory where OMS maintains the message database.
SSL_CIPHER_LIST	List of acceptable SSL/TLS cipher suites to use for network communication.
SSL_CIPHER_SUITES	SSL/TLS 1.3 specific cipher suites that are acceptable to use for network communications between OMS clients and the OMS server.
TMP_DIRECTORY	Directory in which OMS will create temporary files.
TRACE_DIRECTORY	Directory into which trace files are written if the MESSAGE_LEVEL option is set to trace.
TRACE_FILE_LINES	Maximum number of lines written to the trace file.
TRACE_TABLE	Memory trace table specifications.

Browser not supported