OMS Administration Utility Command Options

Owned by
Stonebranch
Feb 06, 2023
2 min read

Overview

This page provides links to detailed information on the command options available for use with the OMS Administration Utility.

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

Command Options Information

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

Description

Describes the command option and how it is used.

Usage

Provides a table of the following information:

Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Short Form

<Format / Value>






Command Line, Long Form

<Format / Value>






Method

Identifies the method used to specify OMS Administration Utility command options:

  • Command Option, Short Form (case-sensitive)
  • Command Option, Long Form (not case-sensitive)

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.

A value must be separated from the option name by at least one space.

Defaults are identified in bold type.

<Additional Information>

Identifies any additional information specific to the option.

Command Options List

The following table identifies all OMS Administration Utility command options.

Option

Description

CLIENT_ID

OMS connection client ID to select.

CODE_PAGE

Local code page used to translate text data from and to the OMS Server.

DATA_FILE

OMS message data file to be listed.

ENCRYPTED_FILE

Command file (see #FILE, below) encrypted by the Universal Encrypt (uencrypt) utility.

FILE

Command file that contains OMS Administration Utility (omsadm) command line options.

HEADERS

Specification for whether or not the column header line is printed for the output of the LIST command.

IO_COUNT

Number of 512-byte blocks to write in the I/O write test.

IO_FILE

File name used for the I/O write test.

IO_FLUSH

Frequency in which data is flushed to disk as part of the I/O write test.

KEY

Encryption key used to encrypt the encrypted command file <ecmdfile>.

KEYSTORE_PATH

Path to a local or remote Universal Broker service interface from which an encryption key can be obtained.

MESSAGE_LEVEL

Severity level of messages to be written.

NLS_DIRECTORY

Directory in which to find the Universal Translation Table (UTT) file specified by the #CODE_PAGE option.

OFFSET

Offset into the OMS message data file where the data list will start to list message data file segments.

PORT

TCP port on which the OMS Server is listening for connections.

PRINT

Category of information to printed when listing an OMS object.

QUEUE_NAME

OMS queue name to select for listing or deleting.

SUMMARY

Specification for whether or not to print a summary line after listing the requested OMS objects.

TRACE

Instruction to start a message trace on the OMS server or stop an active message trace on the OMS server.

TRACE_BODY_MAX

Specification for whether or not the message body is included in the message trace.

TRACE_FMT

Format of the message header and body in the message trace.

TRACE_ID

Text value used to generate the message trace file name.

TRACE_TIMEOUT

Length of time that a trace is active.