Description

The LIST command lists OMS objects in the OMS Server of a specified type. The following information may be listed:

OMS client connections
OMS message queues
OMS message data files

Command Line Syntax

The following figures illustrate the command line syntax of the LIST command, using the command line, long form of its command options.

-list {connections CNN_OPTS | queues QUE_OPTS | data DATA_OPTS} GENERAL_OPTS

CNN_OPTS

    [-clientid id]
    [-print prtopt]
    [-summary opt]
    [-headers opt]

QUE_OPTS

    [-queuename qname]
    [-print prtopt]
    [-summary opt]
    [-headers opt]

DATA_OPTS

    -datafile datafile
    [-offset offset]


GENERAL_OPTS

    [-codepage codepage]
    [-file cmfile]
    [-encryptedfile ecmfile [-key ecmdkey]]
    [-level msglevel]
    [-nls_directory directory]
    [-port port]

Command Options

The following table describes all LIST command options and provides the command line, long form of each option illustrated in the LIST command line syntax, above.

Command Option Name	Command Line Long Form	Description
CLIENT_ID	-clientid	OMS connection client ID to select.
DATA_FILE	-datafile	OMS message data file to be listed.
HEADERS	-headers	Specification for whether or not the column header line is printed.
OFFSET	-offset	Offset into the OMS message data file where the data list will start to list message data file segments.
PRINT	-print	Category of information to print.
SUMMARY	-summary	Specification for whether or not to print a summary line after listing the requested OMS objects.
QUEUE_NAME	-queuename	OMS queue name to select for listing or deleting.
CODE_PAGE	-codepage	Local code page used to translate text data from and to the OMS Server.
FILE	-file	Command file that contains OMS Administration Utility (omsadm) command line options.
ENCRYPTED_FILE	-encryptedfile	Command file encrypted by the Universal Encrypt (uencrypt) utility.
KEY	-key	Encryption key used to encrypt the encrypted command file.
MESSAGE_LEVEL	-level	Severity level of messages to be written.
NLS_DIRECTORY	-nls_directory	Directory in which to find the Universal Translation Table (UTT) file specified by the CODE_PAGE command option.
PORT	-port	TCP port on which the OMS Server is listening for connections.

List Information

The information the LIST command prints is determined by the OMS object being listed and the PRINT option value. The table below lists all potential information listed by its column header name.

Header Name	Object	Description
CERT	connection	The OMS client digital certificate if provided.
CLIENT_ID	connection	The OMS client ID, also known as connection ID.
CONNECT_TIME	connection	The time the OMS client connected to the OMS server.
CONS_CNT	connection and queue	For connections, the number of registered OMS consumers on the connection. For queues, the number of registered OMS consumers on the queue.
CREATE_TIME	queue	The time the queue was created. Note that the queue create time is reset when the OMS server start.
IP_ADDRESS	connection	The OMS client IP address.
LAST_REQUEST_TIME	connection	The last time a request was received from the OMS client.
LAST_REQUEST_NAME	connection	The name of the last request command received from the OMS client.
MSG_CNT	queue	The number of OMS messages in the queue.
MSG_CONS_CNT	connection	The number of total OMS messages consumed on the OMS client connection.
MSG_PROD_CNT	connection	The number of total OMS messages produced on the OMS client connection.
MSGQ_CNT	connection	The number of message or replies pending delivery to the OMS client.
PND_ACK	queue	Whether there is an OMS message delivery acknowledgement pending on the queue.
PND_CONSUMER	queue	The OMS client from which the OMS server is waiting for message delivery acknowledgement.
PROD_CNT	connection	The number of registered OMS producers on the connection.
QUEUE_NAME	queue	The name of the queue.
SENDING	connection	Whether data is in the process of being sent to the OMS client or not.
STATE	connection	The state of the OMS connection.
RECVING	connection	Whether data is in the process of being received from the OMS client or not.
REQUEST	connection	The OMS client request command in the process of being serviced by the OMS server.
TYPE	connection	The OMS connection type.
VERSION	connection	The OMS client library version used by the OMS client.

Universal Agent 7.4.x

LIST - OMS Administration Utility Command

Description

Command Line Syntax

Command Options

List Information