Inquire Queue Status (Response)

The response to the Inquire Queue Status (MQCMD_INQUIRE_Q_STATUS) command consists of the response header followed by the QName structure and a set of attribute parameter structures determined by the value of StatusType in the Inquire command.

Always returned:

QName , QSGDisposition , StatusType Possible values of StatusType are:

MQIACF_Q_STATUS: Returns status information relating to queues.
MQIACF_Q_HANDLE: Returns status information relating to the handles that are accessing the queues.

Returned if requested and StatusType is MQIACF_Q_STATUS:

CurrentMaxQFileSize, CurrentQFileSize, CurrentQDepth, LastGetDate, LastGetTime, LastPutDate, LastPutTime, MediaRecoveryLogExtent, OldestMsgAge, OnQTime, OpenInputCount, OpenOutputCount, QueueMonitoring, UncommittedMsgs

Returned if requested and StatusType is MQIACF_Q_HANDLE:

ApplDesc , ApplTag , ApplType , ASId , AsynchronousState , ChannelName , ConnectionName , ExternalUOWId , HandleState , OpenOptions , ProcessId , PSBName , PSTId , QMgrUOWId , TaskNumber , ThreadId , TransactionId , UOWIdentifier , UOWType , UserIdentifier

Response data if StatusType is MQIACF_Q_STATUS

CurrentMaxQFileSize (MQCFIN)

Current maximum queue file size (parameter identifier MQIA_CUR_MAX_FILE_SIZE)

The current maximum size the queue file can grow to, rounded up to the nearest megabyte, given the current block size in use on a queue

The maximum length is MQIA_CUR_MAX_FILE_SIZE.

CurrentQFileSize (MQCFIN)

Current queue file size (parameter identifier MQIA_CUR_Q_FILE_SIZE)

The current size of the queue file in megabytes, rounded up to the nearest megabyte.

The maximum length is MQIA_CUR_Q_FILE_SIZE.

CurrentQDepth (MQCFIN)

Current queue depth (parameter identifier: MQIA_CURRENT_Q_DEPTH).

LastGetDate (MQCFST)

Date on which the last message was destructively read from the queue (parameter identifier: MQCACF_LAST_GET_DATE).

The date, in the form yyyy-mm-dd, on which the last message was successfully read from the queue. The date is returned in the time zone in which the queue manager is running.

The maximum length of the string is MQ_DATE_LENGTH.

LastGetTime (MQCFST)

Time at which the last message was destructively read from the queue (parameter identifier: MQCACF_LAST_GET_TIME).

The time, in the form hh.mm.ss, at which the last message was successfully read from the queue. The time is returned in the time zone in which the queue manager is running.

The maximum length of the string is MQ_TIME_LENGTH.

LastPutDate (MQCFST)

Date on which the last message was successfully put to the queue (parameter identifier: MQCACF_LAST_PUT_DATE).

The date, in the form yyyy-mm-dd, on which the last message was successfully put to the queue. The date is returned in the time zone in which the queue manager is running.

The maximum length of the string is MQ_DATE_LENGTH.

LastPutTime (MQCFST)

Time at which the last message was successfully put to the queue (parameter identifier: MQCACF_LAST_PUT_TIME).

The time, in the form hh.mm.ss, at which the last message was successfully put to the queue. The time is returned in the time zone in which the queue manager is running.

The maximum length of the string is MQ_TIME_LENGTH.

MediaRecoveryLogExtent (MQCFST)

Name of the oldest log extent required to perform media recovery of the queue (parameter identifier: MQCACF_MEDIA_LOG_EXTENT_NAME).

On IBM i, this parameter identifies the name of the oldest journal receiver required to perform media recovery of the queue.

The name returned is of the form Snnnnnnn.LOG and is not a fully qualified path name. The use of this parameter provides the ability for the name to be easily correlated with the messages issued, following an rcdmqimg command to identify those queues causing the media recovery LSN not to move forwards.

This parameter is valid only on Multiplatforms.

The maximum length of the string is MQ_LOG_EXTENT_NAME_LENGTH.

OldestMsgAge (MQCFIN): Age of the oldest message (parameter identifier: MQIACF_OLDEST_MSG_AGE). Age, in seconds, of the oldest message on the queue.
If the value is unavailable, MQMON_NOT_AVAILABLE is returned. If the queue is empty, 0 is returned. If the value exceeds 999 999 999, it is returned as 999 999 999.

OnQTime (MQCFIL)

Indicator of the time that messages remain on the queue (parameter identifier: MQIACF_Q_TIME_INDICATOR). Amount of time, in microseconds, that a message spent on the queue. Two values are returned:

A value based on recent activity over a short period.
A value based on activity over a longer period.

Where no measurement is available, the value MQMON_NOT_AVAILABLE is returned. If the value exceeds 999 999 999, it is returned as 999 999 999.

OpenInputCount (MQCFIN): Open input count (parameter identifier: MQIA_OPEN_INPUT_COUNT).

OpenOutputCount (MQCFIN): Open output count (parameter identifier: MQIA_OPEN_OUTPUT_COUNT).

QName (MQCFST): Queue name (parameter identifier: MQCA_Q_NAME).
The maximum length of the string is MQ_Q_NAME_LENGTH.

QSGDisposition (MQCFIN)

QSG disposition (parameter identifier: MQIA_QSG_DISP). Returns the disposition of the object (that is, where it is defined and how it behaves). This parameter is valid on z/OS only. The value can be any of the following values:

MQQSGD_COPY: The object is defined as MQQSGD_COPY.
MQQSGD_Q_MGR: The object is defined as MQQSGD_Q_MGR.
MQQSGD_SHARED: The object is defined as MQQSGD_SHARED.

QueueMonitoring (MQCFIN)

Current level of monitoring data collection for the queue (parameter identifier: MQIA_MONITORING_Q). The value can be any of the following values:

MQMON_OFF: Monitor for the queue is disabled.
MQMON_LOW: Low rate of data collection.
MQMON_MEDIUM: Medium rate of data collection.
MQMON_HIGH: High rate of data collection.

StatusType (MQCFST): Queue status type (parameter identifier: MQIACF_Q_STATUS_TYPE).
Specifies the type of status information.

UncommittedMsgs (MQCFIN)

The number of uncommitted changes (puts and gets) pending for the queue (parameter identifier: MQIACF_UNCOMMITTED_MSGS). The value can be any of the following values:

MQQSUM_YES: On z/OS, there are one or more uncommitted changes pending.
MQQSUM_NO: There are no uncommitted changes pending.
n: On Multiplatforms, an integer value indicating how many uncommitted changes are pending.

Response data if StatusType is MQIACF_Q_HANDLE

ApplDesc (MQCFST): Application description (parameter identifier: MQCACF_APPL_DESC).
The maximum length is MQ_APPL_DESC_LENGTH.
ApplTag (MQCFST): Open application tag (parameter identifier: MQCACF_APPL_TAG).
The maximum length of the string is MQ_APPL_TAG_LENGTH.

ApplType (MQCFIN)

Open application type (parameter identifier: MQIA_APPL_TYPE). The value can be any of the following values:

MQAT_QMGR: A queue manager process.
MQAT_CHANNEL_INITIATOR: The channel initiator.
MQAT_USER: A user application.
MQAT_BATCH: Application using a batch connection. MQAT_BATCH applies only to z/OS.
MQAT_RRS_BATCH: RRS-coordinated application using a batch connection. MQAT_RRS_BATCH applies only to z/OS.
MQAT_CICS: A CICS transaction. MQAT_CICS applies only to z/OS.
MQAT_IMS: An IMS transaction. MQAT_IMS applies only to z/OS.
MQAT_SYSTEM_EXTENSION: Application performing an extension of function that is provided by the queue manager.

ASId (MQCFST)

Address-space identifier (parameter identifier: MQCACF_ASID).

The 4-character address-space identifier of the application identified by ApplTag . It distinguishes duplicate values of ApplTag . This parameter applies only to z/OS.

The length of the string is MQ_ASID_LENGTH.

AsynchronousState (MQCFIN)

The state of the asynchronous consumer on this queue (parameter identifier: MQIACF_ASYNC_STATE). The value can be any of the following values:

MQAS_ACTIVE: An MQCB call has set up a function to call back to process messages asynchronously and the connection handle has been started so that asynchronous message consumption can proceed.
MQAS_INACTIVE: An MQCB call has set up a function to call back to process messages asynchronously but the connection handle has not yet been started, or has been stopped or suspended, so that asynchronous message consumption cannot currently proceed.
MQAS_SUSPENDED: The asynchronous consumption callback has been suspended so that asynchronous message consumption cannot currently proceed on this handle. This situation can be either because an MQCB or MQCTL call with Operation MQOP_SUSPEND has been issued against this object handle by the application, or because it has been suspended by the system. If it has been suspended by the system, as part of the process of suspending asynchronous message consumption the callback function is called with the reason code that describes the problem resulting in suspension. This situation is reported in the Reason field in the MQCBC structure passed to the callback. In order for asynchronous message consumption to proceed, the application must issue an MQCB or MQCTL call with Operation MQOP_RESUME.
MQAS_SUSPENDED_TEMPORARY: The asynchronous consumption callback has been temporarily suspended by the system so that asynchronous message consumption cannot currently proceed on this object handle. As part of the process of suspending asynchronous message consumption the callback function is called with the reason code that describes the problem resulting in suspension. This situation is reported in the Reason field in the MQCBC structure passed to the callback. The callback function is called again when asynchronous message consumption is resumed by the system after the temporary condition has been resolved.
MQAS_NONE: An MQCB call has not been issued against this handle, so no asynchronous message consumption is configured on this handle.

ChannelName (MQCFST): Channel name (parameter identifier: MQCACH_CHANNEL_NAME).
The maximum length of the string is MQ_CHANNEL_NAME_LENGTH.

ConnectionName (MQCFST): Connection name (parameter identifier: MQCACH_CONNECTION_NAME).
The maximum length of the string is MQ_CONN_NAME_LENGTH.

ExternalUOWId (MQCFBS)

RRS unit-of-recovery identifier (parameter identifier: MQBACF_EXTERNAL_UOW_ID).

The RRS unit-of-recovery identifier associated with the handle. This parameter is valid only on z/OS only.

The length of the string is MQ_EXTERNAL_UOW_ID_LENGTH.

HandleState (MQCFIN)

State of the handle (parameter identifier: MQIACF_HANDLE_STATE). The value can be any of the following values:

MQHSTATE_ACTIVE: An API call from a connection is currently in progress for this object. For a queue, this condition can arise when an MQGET WAIT call is in progress.
If there is an MQGET SIGNAL outstanding, it does not mean, by itself, that the handle is active.
MQHSTATE_INACTIVE: No API call from a connection is currently in progress for this object. For a queue, this condition can arise when no MQGET WAIT call is in progress.

OpenBrowse (MQCFIN)

Open browse (parameter identifier: MQIACF_OPEN_BROWSE). The value can be any of the following values:

MQQSO_YES: The queue is open for browsing.
MQQSO_NO: The queue is not open for browsing.

OpenInputType (MQCFIN)

Open input type (parameter identifier: MQIACF_OPEN_INPUT_TYPE). The value can be any of the following values:

MQQSO_NO: The queue is not open for inputting.
MQQSO_SHARED: The queue is open for shared input.
MQQSO_EXCLUSIVE: The queue is open for exclusive input.

OpenInquire (MQCFIN)

Open inquire (parameter identifier: MQIACF_OPEN_INQUIRE). The value can be any of the following values:

MQQSO_YES: The queue is open for inquiring.
MQQSO_NO: The queue is not open for inquiring.

OpenOptions (MQCFIN): Open options currently in force for the queue (parameter identifier: MQIACF_OPEN_OPTIONS).

OpenOutput (MQCFIN)

Open output (parameter identifier: MQIACF_OPEN_OUTPUT). The value can be any of the following values:

MQQSO_YES: The queue is open for output.
MQQSO_NO: The queue is not open for output.

OpenSet (MQCFIN)

Open set (parameter identifier: MQIACF_OPEN_SET). The value can be any of the following values:

MQQSO_YES: The queue is open for setting.
MQQSO_NO: The queue is not open for setting.

ProcessId (MQCFIN): Open application process ID (parameter identifier: MQIACF_PROCESS_ID).

PSBName (MQCFST)

Program specification block (PSB) name (parameter identifier: MQCACF_PSB_NAME).

The 8-character name of the PSB associated with the running IMS transaction. This parameter is valid on z/OS only.

The length of the string is MQ_PSB_NAME_LENGTH.

PSTId (MQCFST)

Program specification table (PST) identifier (parameter identifier: MQCACF_PST_ID).

The 4-character identifier of the PST region identifier for the connected IMS region. This parameter is valid on z/OS only.

The length of the string is MQ_PST_ID_LENGTH.

QMgrUOWId (MQCFBS)

The unit of recovery assigned by the queue manager (parameter identifier: MQBACF_Q_MGR_UOW_ID).

On z/OS, this parameter is an 8-byte log RBA, displayed as 16 hexadecimal characters. On platforms other than z/OS, this parameter is an 8-byte transaction identifier, displayed as 16 hexadecimal characters.

The maximum length of the string is MQ_UOW_ID_LENGTH.

QName (MQCFST): Queue name (parameter identifier: MQCA_Q_NAME).
The maximum length of the string is MQ_Q_NAME_LENGTH.

QSGDisposition (MQCFIN)

MQQSGD_COPY: The object is defined as MQQSGD_COPY.
MQQSGD_Q_MGR: The object is defined as MQQSGD_Q_MGR.
MQQSGD_SHARED: The object is defined as MQQSGD_SHARED.

StatusType (MQCFST): Queue status type (parameter identifier: MQIACF_Q_STATUS_TYPE).
Specifies the type of status information.

TaskNumber (MQCFST)

CICS task number (parameter identifier: MQCACF_TASK_NUMBER).

A 7-digit CICS task number. This parameter is valid on z/OS only.

The length of the string is MQ_TASK_NUMBER_LENGTH.

ThreadId (MQCFIN): The thread ID of the open application (parameter identifier: MQIACF_THREAD_ID).
A value of zero indicates that the handle was opened by a shared connection. A handle created by a shared connection is logically open to all threads.

TransactionId (MQCFST)

CICS transaction identifier (parameter identifier: MQCACF_TRANSACTION_ID).

A 4-character CICS transaction identifier. This parameter is valid on z/OS only.

The length of the string is MQ_TRANSACTION_ID_LENGTH.

UOWIdentifier (MQCFBS)

The external unit of recovery associated with the connection (parameter identifier: MQBACF_EXTERNAL_UOW_ID).

This parameter is the recovery identifier for the unit of recovery. Its format is determined by the value of UOWType.

The maximum length of the string is MQ_UOW_ID_LENGTH.

UOWType (MQCFIN)

Type of external unit of recovery identifier as perceived by the queue manager (parameter identifier: MQIACF_UOW_TYPE). The value can be any of the following values:

MQUOWT_Q_MGR
MQUOWT_CICS: Valid only on z/OS.
MQUOWT_RRS: Valid only on z/OS.
MQUOWT_IMS: Valid only on z/OS.
MQUOWT_XA

UOWType identifies the UOWIdentifier type and not the type of the transaction coordinator. When the value of UOWType is MQUOWT_Q_MGR, the associated identifier is in QMgrUOWId (and not UOWIdentifier).

UserIdentifier (MQCFST): Open application user name (parameter identifier: MQCACF_USER_IDENTIFIER).
The maximum length of the string is MQ_MAX_USER_ID_LENGTH.

Parent topic: Definitions of the Programmable Command Formats