Inquire Channel Listener Status on Multiplatforms

The Inquire Channel Listener Status (MQCMD_INQUIRE_LISTENER_STATUS) command inquires about the status of one or more IBM MQ listener instances.

You must specify the name of a listener for which you want to receive status information. We can specify a listener by using either a specific listener name or a generic listener name. By using a generic listener name, we can display either:

• Status information for all listener definitions, by using a single asterisk (*), or
• Status information for one or more listeners that match the specified name.

Required parameters

ListenerName (MQCFST)

Listener name (parameter identifier: MQCACH_LISTENER_NAME).

Generic listener names are supported. A generic name is a character string followed by an asterisk (*), for example ABC*, and it selects all listeners having names that start with the selected character string. An asterisk on its own matches all possible names.

The listener name is always returned, regardless of the attributes requested.

The maximum length of the string is MQ_LISTENER_NAME_LENGTH.

Optional parameters

IntegerFilterCommand (MQCFIF)

Integer filter command descriptor. The parameter identifier must be any integer type parameter allowed in ListenerStatusAttrs except MQIACF_ALL. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFIF - PCF integer filter parameter for information about using this filter condition.

If you specify an integer filter, we cannot also specify a string filter using the StringFilterCommand parameter.

ListenerStatusAttrs (MQCFIL)

Listener status attributes (parameter identifier: MQIACF_LISTENER_STATUS_ATTRS). The attribute list can specify the following value on its own - default value used if the parameter is not specified:

MQIACF_ALL

All attributes.

or a combination of the following:

MQCACH_IP_ADDRESS

IP address of the listener.

MQCACH_LISTENER_DESC

Description of listener definition.

MQCACH_LISTENER_NAME

Name of listener definition.

MQCACH_LISTENER_START_DATE

The date on which the listener was started.

MQCACH_LISTENER_START_TIME

The time at which the listener was started.

MQCACH_LOCAL_NAME

NetBIOS local name that the listener uses. MQCACH_LOCAL_NAME is valid only on Windows.

MQCACH_TP_NAME

LU6.2 transaction program name. MQCACH_TP_NAME is valid only on Windows.

MQIACF_PROCESS_ID

Operating system process identifier associated with the listener.

MQIACH_ADAPTER

Adapter number on which NetBIOS listens. MQIACH_ADAPTER is valid only on Windows.

MQIACH_BACKLOG

Number of concurrent connection requests that the listener supports.

MQIACH_COMMAND_COUNT

Number of commands that the listener can use. MQIACH_COMMAND_COUNT is valid only on Windows.

MQIACH_LISTENER_CONTROL

How the listener is to be started and stopped.

MQIACH_LISTENER_STATUS

Status of the listener.

MQIACH_NAME_COUNT

Number of names that the listener can use. MQIACH_NAME_COUNT is valid only on Windows.

MQIACH_PORT

Port number for TCP/IP.

MQIACH_SESSION_COUNT

Number of sessions that the listener can use. MQIACH_SESSION_COUNT is valid only on Windows.

MQIACH_SOCKET

SPX socket. MQIACH_SOCKET is valid only on Windows.

MQIACH_XMIT_PROTOCOL_TYPE

Transport type.

StringFilterCommand (MQCFSF)

String filter command descriptor. The parameter identifier must be any string type parameter allowed in ListenerStatusAttrs except MQCACH_LISTENER_NAME. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFSF - PCF string filter parameter for information about using this filter condition.

If you specify a string filter, we cannot also specify an integer filter using the IntegerFilterCommand parameter.

Error code

This command might return the following error code in the response format header, in addition to the values shown in Error codes applicable to all commands.

Reason (MQLONG)

The value can be any of the following values:

MQRCCF_LSTR_STATUS_NOT_FOUND

Listener status not found.