LIST Command

ADDRESS PPQ Commands › Special PPQ Commands › LIST Command

LIST Command

The LIST command lists information about one or more queues residing on the local or remote workstation, or both. The optional QUEUE and SCOPE operands allow you to specify search criteria to target specific queues. This command is useful for troubleshooting TCP/IP problems.

Each line of information that the LIST command returns represents one queue. Each field in a line contains a specific type of information about the queue, as follows:

Field	Description
1	The name of the queue
2	The number of items in the queue
3	The maximum number of items allowed in the queue
4	The maximum allowed length of each item
5	The lock nesting counter
6	The name of the transport where the queue was found
7	The scope of the queue (local, remote, or shared)
8	The name of the transport the queue uses
9	The system name of the creator of the queue

This command has the following format:

ADDRESS PPQ 'LIST [CMDRESP(destination)]
                  [PREFIX(newvarname)]
                  [QUEUE(qname)] 
                  [SCOPE(ALL|LOCAL|REMOTE)]
                  [TRANSPORT(network-transport-name)]'

CMDRESP

(Optional) Directs return information, if any, to a specific destination. For a list of valid destination values, see the section Change the Default Return Destination with CMDRESP.

Default: REXX

PREFIX

(Optional) Directs return information to a stem variable name (newvarname) other than the default. For more information, see ADDRESS PPQ Return Information.

Note: The PREFIX operand is only valid if REXX is the destination of the return information.

Default: PPQ.LIST

QUEUE

(Optional) Specifies the 1- to 16-character name of the queue (qname). The queue name can contain alphanumeric characters and any of these special characters: ! @ # $ _

The queue name cannot contain blanks.

Note: Wildcard characters are not valid in this case.

SCOPE

(Optional) Specifies queues on the local or remote workstation, as follows:

ALL: Lists queues residing on the local workstation and queues on remote workstations that REXX programs on the local workstation have accessed.
LOCAL: Lists only those queues residing on the local workstation.
REMOTE: Lists only those queues residing on remote workstations that REXX programs on the local workstation have accessed.

Default: ALL

TRANSPORT

(Optional) Specifies a valid transport.

The network-transport-name is the network transport specified on the TRANSPORT() startup initialization parameter.

Valid network transport names are:

PPQTCP

The network transport is TCP/IP.

When TRANSPORT(PPQTCP) is specified, the LIST command displays the current state of each TCP/IP connection to the remote hosts listed under TCP/IP Host Names in the Configuration Manager Program-to-Program Queues dialog.

'LIST TRANSPORT(PPQTCP)' displays one of the following forms of output:

If the local machine is configured only with IPv4 under TCP/IP:

Session nnnnnnn: IP: iphost1 State: host1state Host 'host1'
Session nnnnnnn: IP: iphost2 State: host2state Host 'host2'

If the local machine is configured to support both IPv4 and IPv6 under TCP/IP:

Session nnnnnnn: State: host1state
  IP: iphost1
  Host 'host1'
Session nnnnnnn: State: host2state
  IP: iphost2
  Host 'host2'

nnnnnnn -- Specifies the internal session identifier

iphostn- -- Specifies the IPv4 or IPv6 address for the host named hostn; an IPv6 address will be enclosed in square brackets

hostnstate -- Specifies the state of the session that is connected to the host named hostn. Values are UP, DOWN, STARTING, LISTEN, BROKEN, and UNKNOWN.

Notes:

The old IPv4 format is deprecated; it may be removed in a future release in favor of the new IPv4/IPv6 format.
PPQTCP is the only valid value for TRANSPORT.