Inquire Queue (Response)

The response to the Inquire Queue command MQCMD_INQUIRE_Q consists of the response header followed by the QName structure. On z/OS only, response includes the QSGDisposition structure, and the requested combination of attribute parameter structures.

Always returned:

QName, QSGDisposition, QType

Returned if requested:

AlterationDate , AlterationTime , BackoutRequeueName , BackoutThreshold , BaseQName ,, CFStructure , ClusterChannelName , ClusterDate , ClusterName , ClusterNamelist , ClusterQType , ClusterTime , CLWLQueuePriority , CLWLQueueRank , CLWLUseQ , CreationDate , CreationTime , CurrentQDepth , Custom , DefaultPutResponse , DefBind , DefinitionType , DefInputOpenOption , DefPersistence , DefPriority , DefReadAhead , DistLists , HardenGetBackout , Imgrcovq , IndexType , InhibitGet , InhibitPut , InitiationQName , MaxMsgLength , MaxQDepth , MsgDeliverySequence , NonPersistentMessageClass , OpenInputCount , OpenOutputCount , PageSetID , ProcessName , PropertyControl , QDepthHighEvent , QDepthHighLimit , QDepthLowEvent , QDepthLowLimit , QDepthMaxEvent , QDesc , QMgrIdentifier , QMgrName , QServiceInterval , QServiceIntervalEvent , QueueAccounting , QueueMonitoring , QueueStatistics , RemoteQMgrName , RemoteQName , RetentionInterval , Scope , Shareability , StorageClass , TpipeNames , TriggerControl , TriggerData , TriggerDepth , TriggerMsgPriority , TriggerType , Usage , XmitQName

Response data

AlterationDate (MQCFST)

Alteration date (parameter identifier: MQCA_ALTERATION_DATE).

The date when the information was last altered, in the form yyyy-mm-dd.

AlterationTime (MQCFST)

Alteration time (parameter identifier: MQCA_ALTERATION_TIME).

The time when the information was last altered, in the form hh.mm.ss.

BackoutRequeueName (MQCFST)

Excessive backout requeue name (parameter identifier: MQCA_BACKOUT_REQ_Q_NAME).

The maximum length of the string is MQ_Q_NAME_LENGTH.

BackoutThreshold (MQCFIN)

Backout threshold (parameter identifier: MQIA_BACKOUT_THRESHOLD).

BaseQName (MQCFST)

Queue name to which the alias resolves (parameter identifier: MQCA_BASE_Q_NAME).

The name of a queue that is defined to the local queue manager.

The maximum length of the string is MQ_Q_NAME_LENGTH.

CFStructure (MQCFST)

Coupling facility structure name (parameter identifier: MQCA_CF_STRUC_NAME). This parameter applies to z/OS only.

Specifies the name of the coupling facility structure where we want to store messages when you use shared queues.

The maximum length of the string is MQ_CF_STRUC_NAME_LENGTH.

ClusterChannelName (MQCFST)

Cluster-sender channel name (parameter identifier: MQCA_CLUS_CHL_NAME).

ClusterChannelName is the generic name of the cluster-sender channels that use this queue as a transmission queue.

The maximum length of the channel name is: MQ_CHANNEL_NAME_LENGTH.

ClusterDate (MQCFST)

Cluster date (parameter identifier: MQCA_CLUSTER_DATE).

The date on which the information became available to the local queue manager, in the form yyyy-mm-dd.

ClusterName (MQCFST)

Cluster name (parameter identifier: MQCA_CLUSTER_NAME).

ClusterNamelist (MQCFST)

Cluster namelist (parameter identifier: MQCA_CLUSTER_NAMELIST).

ClusterQType (MQCFIN)

Cluster queue type (parameter identifier: MQIA_CLUSTER_Q_TYPE). The value can be:

MQCQT_LOCAL_Q

The cluster queue represents a local queue.

MQCQT_ALIAS_Q

The cluster queue represents an alias queue.

MQCQT_REMOTE_Q

The cluster queue represents a remote queue.

MQCQT_Q_MGR_ALIAS

The cluster queue represents a queue manager alias.

ClusterTime (MQCFST)

Cluster time (parameter identifier: MQCA_CLUSTER_TIME).

The time at which the information became available to the local queue manager, in the form hh.mm.ss.

CLWLQueuePriority (MQCFIN)

Cluster workload queue priority (parameter identifier: MQIA_CLWL_Q_PRIORITY).

Priority of the queue in cluster workload management. The value is in the range zero through 9, where zero is the lowest priority and 9 is the highest.

CLWLQueueRank (MQCFIN)

Cluster workload queue rank (parameter identifier: MQIA_CLWL_Q_RANK).

Rank of the queue in cluster workload management. The value is in the range zero through 9, where zero is the lowest rank and 9 is the highest.

CLWLUseQ (MQCFIN)

Cluster workload queue rank (parameter identifier: MQIA_CLWL_USEQ). The value can be:

MQCLWL_USEQ_AS_Q_MGR

Use the value of the CLWLUseQ parameter on the queue manager's definition.

MQCLWL_USEQ_ANY

Use remote and local queues.

MQCLWL_USEQ_LOCAL

Do not use remote queues.

CreationDate (MQCFST)

Queue creation date, in the form yyyy-mm-dd (parameter identifier: MQCA_CREATION_DATE).

The maximum length of the string is MQ_CREATION_DATE_LENGTH.

CreationTime (MQCFST)

Creation time, in the form hh.mm.ss (parameter identifier: MQCA_CREATION_TIME).

The maximum length of the string is MQ_CREATION_TIME_LENGTH.

CurrentQDepth (MQCFIN)

Current queue depth (parameter identifier: MQIA_CURRENT_Q_DEPTH).

Custom (MQCFST)

Custom attribute for new features (parameter identifier: MQCA_CUSTOM).

This attribute is reserved for the configuration of new features before separate attributes are named. It can contain the values of zero or more attributes as pairs of attribute name and value, separated by at least one space. The attribute name-value pairs have the form NAME(VALUE).

This description is updated when features using this attribute are introduced.

DefaultPutResponse (MQCFIN)

Default put response type definition (parameter identifier: MQIA_DEF_PUT_RESPONSE_TYPE). The parameter specifies the type of response to be used for put operations to the queue when an application specifies MQPMO_RESPONSE_AS_Q_DEF. The value can be any of the following values:

MQPRT_SYNC_RESPONSE

The put operation is issued synchronously, returning a response.

MQPRT_ASYNC_RESPONSE

The put operation is issued asynchronously, returning a subset of MQMD fields.

DefBind (MQCFIN)

Default binding (parameter identifier: MQIA_DEF_BIND). The value can be:

MQBND_BIND_ON_OPEN

Binding fixed by MQOPEN call.

MQBND_BIND_NOT_FIXED

Binding not fixed.

MQBND_BIND_ON_GROUP

Allows an application to request that a group of messages are all allocated to the same destination instance.

DefinitionType (MQCFIN)

Queue definition type (parameter identifier: MQIA_DEFINITION_TYPE). The value can be:

MQQDT_PREDEFINED

Predefined permanent queue.

MQQDT_PERMANENT_DYNAMIC

Dynamically defined permanent queue.

MQQDT_SHARED_DYNAMIC

Dynamically defined shared queue. This option is available on z/OS only.

MQQDT_TEMPORARY_DYNAMIC

Dynamically defined temporary queue.

DefInputOpenOption (MQCFIN)

Default input open option for defining whether queues can be shared (parameter identifier: MQIA_DEF_INPUT_OPEN_OPTION). The value can be:

MQOO_INPUT_EXCLUSIVE

Open queue to get messages with exclusive access.

MQOO_INPUT_SHARED

Open queue to get messages with shared access.

DefPersistence (MQCFIN)

Default persistence (parameter identifier: MQIA_DEF_PERSISTENCE). The value can be:

MQPER_PERSISTENT

Message is persistent.

MQPER_NOT_PERSISTENT

Message is not persistent.

DefPriority (MQCFIN)

Default priority (parameter identifier: MQIA_DEF_PRIORITY).

DefReadAhead (MQCFIN)

Default read ahead (parameter identifier: MQIA_DEF_READ_AHEAD).

Specifies the default read ahead behavior for non-persistent messages delivered to the client.

The value can be any of the following values:

MQREADA_NO

Non-persistent messages are not sent ahead to the client before an application requests them. A maximum of one non-persistent message can be lost if the client ends abnormally.

MQREADA_YES

Non-persistent messages are sent ahead to the client before an application requests them. Non-persistent messages can be lost if the client ends abnormally or if the client does not consume all the messages it is sent.

MQREADA_DISABLED

Read ahead of non-persistent messages in not enabled for this queue. Messages are not sent ahead to the client regardless of whether read ahead is requested by the client application.

DistLists (MQCFIN)

Distribution list support (parameter identifier: MQIA_DIST_LISTS). The value can be:

MQDL_SUPPORTED

Distribution lists supported.

MQDL_NOT_SUPPORTED

Distribution lists not supported.

This parameter is supported only on Multiplatforms.

HardenGetBackout (MQCFIN)

Harden backout, or not: (parameter identifier: MQIA_HARDEN_GET_BACKOUT). The value can be:

MQQA_BACKOUT_HARDENED

Backout count remembered.

MQQA_BACKOUT_NOT_HARDENED

Backout count may not be remembered.

ImageRecoverQueue (MQCFST)

Specifies whether a local or permanent dynamic queue object is recoverable from a media image, if linear logging is being used (parameter identifier: MQIA_MEDIA_IMAGE_RECOVER_Q). This parameter is not valid on z/OS. Possible values are:

MQIMGRCOV_YES

These queue objects are recoverable.

MQIMGRCOV_NO

Automatic media images, if enabled, are not written for these objects.

MQIMGRCOV_AS_Q_MGR

If the ImageRecoverQueue attribute for the queue manager specifies MQIMGRCOV_YES, these queue objects are recoverable.

If the ImageRecoverQueue attribute for the queue manager specifies MQIMGRCOV_NO, the rcdmqimg (record media image) and rcrmqobj (re-create object) commands are not permitted for these objects, and automatic media images, if enabled, are not written for these objects.

IndexType (MQCFIN)

Index type (parameter identifier: MQIA_INDEX_TYPE). This parameter applies to z/OS only. Specifies the type of index maintained by the queue manager to expedite MQGET operations on the queue. The value can be any of the following values:

MQIT_NONE

No index.

MQIT_MSG_ID

The queue is indexed using message identifiers.

MQIT_CORREL_ID

The queue is indexed using correlation identifiers.

MQIT_MSG_TOKEN

The queue is indexed using message tokens.

MQIT_GROUP_ID

The queue is indexed using group identifiers.

InhibitGet (MQCFIN)

Get operations are allowed or inhibited: (parameter identifier: MQIA_INHIBIT_GET). The value can be:

MQQA_GET_ALLOWED

Get operations are allowed.

MQQA_GET_INHIBITED

Get operations are inhibited.

InhibitPut (MQCFIN)

Putt operations are allowed or inhibited: (parameter identifier: MQIA_INHIBIT_PUT). The value can be:

MQQA_PUT_ALLOWED

Put operations are allowed.

MQQA_PUT_INHIBITED

Put operations are inhibited.

InitiationQName (MQCFST)

Initiation queue name (parameter identifier: MQCA_INITIATION_Q_NAME).

The maximum length of the string is MQ_Q_NAME_LENGTH.

MaxMsgLength (MQCFIN)

Maximum message length (parameter identifier: MQIA_MAX_MSG_LENGTH).

MaxQDepth (MQCFIN)

Maximum queue depth (parameter identifier: MQIA_MAX_Q_DEPTH).

MsgDeliverySequence (MQCFIN)

Messages ordered by priority or sequence: (parameter identifier: MQIA_MSG_DELIVERY_SEQUENCE). The value can be:

MQMDS_PRIORITY

Messages are returned in priority order.

MQMDS_FIFO

Messages are returned in FIFO order (first in, first out).

NonPersistentMessageClass (MQCFIN)

The level of reliability assigned to non-persistent messages that are put to the queue (parameter identifier: MQIA_NPM_CLASS). Specifies the circumstances under which non-persistent messages put to the queue may be lost. The value can be any of the following values:

MQNPM_CLASS_NORMAL

Non-persistent messages are limited to the lifetime of the queue manager session. They are discarded in the event of a queue manager restart. MQNPM_CLASS_NORMAL is the default value.

MQNPM_CLASS_HIGH

The queue manager attempts to retain non-persistent messages for the lifetime of the queue. Non-persistent messages may still be lost in the event of a failure.

OpenInputCount (MQCFIN)

Number of MQOPEN calls that have the queue open for input (parameter identifier: MQIA_OPEN_INPUT_COUNT).

OpenOutputCount (MQCFIN)

Number of MQOPEN calls that have the queue open for output (parameter identifier: MQIA_OPEN_OUTPUT_COUNT).

PageSetID (MQCFIN)

Page set identifier (parameter identifier: MQIA_PAGESET_ID).

Specifies the identifier of the page set on which the queue resides.

This parameter applies to z/OS only when the queue is actively associated with a page set.

ProcessName (MQCFST)

Name of process definition for queue (parameter identifier: MQCA_PROCESS_NAME).

The maximum length of the string is MQ_PROCESS_NAME_LENGTH.

PropertyControl (MQCFIN)

Property control attribute (parameter identifier MQIA_PROPERTY_CONTROL). Specifies how message properties are handled for messages that are retrieved from queues using the MQGET call with the MQGMO_PROPERTIES_AS_Q_DEF option. The value can be any of the following values:

MQPROP_COMPATIBILITY

If the message contains a property with a prefix of mcd., jms., usr. or mqext., all message properties are delivered to the application in an MQRFH2 header. Otherwise all properties of the message, except properties contained in the message descriptor (or extension), are discarded and are no longer accessible to the application.

MQPROP_COMPATIBILITY is the default value. It allows applications which expect JMS-related properties to be in an MQRFH2 header in the message data to continue to work unmodified.

MQPROP_NONE

All properties of the message are removed from the message before the message is sent to the remote queue manager. Properties in the message descriptor (or extension) are not removed.

MQPROP_ALL

All properties of the message are included with the message when it is sent to the remote queue manager. The properties are placed in one or more MQRFH2 headers in the message data. Properties in the message descriptor (or extension) are not placed in MQRFH2 headers.

MQPROP_FORCE_ MQRFH2

Properties are always returned in the message data in an MQRFH2 header regardless of whether the application specifies a message handle.

A valid message handle supplied in the MsgHandle field of the MQGMO structure on the MQGET call is ignored. Properties of the message are not accessible via the message handle.

This parameter is applicable to local, alias, and model queues.

QDepthHighEvent (MQCFIN)

Controls whether Queue Depth High events are generated (parameter identifier: MQIA_Q_DEPTH_HIGH_EVENT). The value can be:

MQEVR_DISABLED

Event reporting disabled.

MQEVR_ENABLED

Event reporting enabled.

QDepthHighLimit (MQCFIN)

High limit for queue depth (parameter identifier: MQIA_Q_DEPTH_HIGH_LIMIT).

The threshold against which the queue depth is compared to generate a Queue Depth High event.

QDepthLowEvent (MQCFIN)

Controls whether Queue Depth Low events are generated (parameter identifier: MQIA_Q_DEPTH_LOW_EVENT). The value can be:

MQEVR_DISABLED

Event reporting disabled.

MQEVR_ENABLED

Event reporting enabled.

QDepthLowLimit (MQCFIN)

Low limit for queue depth (parameter identifier: MQIA_Q_DEPTH_LOW_LIMIT).

The threshold against which the queue depth is compared to generate a Queue Depth Low event.

QDepthMaxEvent (MQCFIN)

Controls whether Queue Full events are generated (parameter identifier: MQIA_Q_DEPTH_MAX_EVENT). The value can be:

MQEVR_DISABLED

Event reporting disabled.

MQEVR_ENABLED

Event reporting enabled.

QDesc (MQCFST)

Queue description (parameter identifier: MQCA_Q_DESC).

The maximum length of the string is MQ_Q_DESC_LENGTH.

QMgrIdentifier (MQCFST)

Queue manager identifier (parameter identifier: MQCA_Q_MGR_IDENTIFIER).

The unique identifier of the queue manager.

QMgrName (MQCFST)

Name of local queue manager (parameter identifier: MQCA_CLUSTER_Q_MGR_NAME).

The maximum length of the string is MQ_Q_MGR_NAME_LENGTH.

QName (MQCFST)

Queue name (parameter identifier: MQCA_Q_NAME).

The maximum length of the string is MQ_Q_NAME_LENGTH.

QServiceInterval (MQCFIN)

Target for queue service interval (parameter identifier: MQIA_Q_SERVICE_INTERVAL).

The service interval used for comparison to generate Queue Service Interval High and Queue Service Interval OK events.

QServiceIntervalEvent (MQCFIN)

Controls whether Service Interval High or Service Interval OK events are generated (parameter identifier: MQIA_Q_SERVICE_INTERVAL_EVENT). The value can be:

MQQSIE_HIGH

Queue Service Interval High events enabled.

MQQSIE_OK

Queue Service Interval OK events enabled.

MQQSIE_NONE

No queue service interval events enabled.

QSGDisposition (MQCFIN)

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

MQQSGD_COPY

The object is defined as MQQSGD_COPY.

MQQSGD_GROUP

The object is defined as MQQSGD_GROUP.

MQQSGD_Q_MGR

The object is defined as MQQSGD_Q_MGR.

MQQSGD_SHARED

The object is defined as MQQSGD_SHARED.

QType (MQCFIN)

Queue type (parameter identifier: MQIA_Q_TYPE). The value can be:

MQQT_ALIAS

Alias queue definition.

MQQT_CLUSTER

Cluster queue definition.

MQQT_LOCAL

Local queue.

MQQT_REMOTE

Local definition of a remote queue.

MQQT_MODEL

Model queue definition.

QueueAccounting (MQCFIN)

Controls the collection of accounting (thread-level and queue-level accounting) data (parameter identifier: MQIA_ACCOUNTING_Q). The value can be:

MQMON_Q_MGR

The collection of accounting data for the queue is performed based upon the setting of the QueueAccounting parameter on the queue manager.

MQMON_OFF

Do not collect accounting data for the queue.

MQMON_ON

Collect accounting data for the queue.

QueueMonitoring (MQCFIN)

Online monitoring data collection (parameter identifier: MQIA_MONITORING_Q). The value can be:

MQMON_OFF

Online monitoring data collection is turned off for this queue.

MQMON_Q_MGR

The value of the queue manager's QueueMonitoring parameter is inherited by the queue.

MQMON_LOW

Online monitoring data collection is turned on, with a low rate of data collection, for this queue unless QueueMonitoring for the queue manager is MQMON_NONE.

MQMON_MEDIUM

Online monitoring data collection is turned on, with a moderate rate of data collection, for this queue unless QueueMonitoring for the queue manager is MQMON_NONE.

MQMON_HIGH

Online monitoring data collection is turned on, with a high rate of data collection, for this queue unless QueueMonitoring for the queue manager is MQMON_NONE.

QueueStatistics (MQCFIN)

Controls the collection of statistics data (parameter identifier: MQIA_STATISTICS_Q). The value can be:

MQMON_Q_MGR

The collection of statistics data for the queue is performed based upon the setting of the QueueStatistics parameter on the queue manager.

MQMON_OFF

Do not collect statistics data for the queue.

MQMON_ON

Collect statistics data for the queue unless QueueStatistics for the queue manager is MQMON_NONE.

This parameter is supported only on Multiplatforms.

RemoteQMgrName (MQCFST)

Name of remote queue manager (parameter identifier: MQCA_REMOTE_Q_MGR_NAME).

The maximum length of the string is MQ_Q_MGR_NAME_LENGTH.

RemoteQName (MQCFST)

Name of remote queue as known locally on the remote queue manager (parameter identifier: MQCA_REMOTE_Q_NAME).

The maximum length of the string is MQ_Q_NAME_LENGTH.

RetentionInterval (MQCFIN)

Retention interval (parameter identifier: MQIA_RETENTION_INTERVAL).

Scope (MQCFIN)

Scope of the queue definition (parameter identifier: MQIA_SCOPE). The value can be:

MQSCO_Q_MGR

Queue manager scope.

MQSCO_CELL

Cell scope.

This parameter is not valid on IBM i or z/OS.

Shareability (MQCFIN)

The queue can be shared, or not: (parameter identifier: MQIA_SHAREABILITY). The value can be:

MQQA_SHAREABLE

Queue is shareable.

MQQA_NOT_SHAREABLE

Queue is not shareable.

StorageClass (MQCFST)

Storage class (parameter identifier: MQCA_STORAGE_CLASS). This parameter applies to z/OS only.

Specifies the name of the storage class.

The maximum length of the string is MQ_STORAGE_CLASS_LENGTH.

TpipeNames (MQCFSL)

TPIPE names (parameter identifier: MQCA_TPIPE_NAME). This parameter applies to local queues on z/OS only.

Specifies the TPIPE names used for communication with OTMA via the IBM MQ IMS bridge, if the bridge is active.

The maximum length of the string is MQ_TPIPE_NAME_LENGTH.

TriggerControl (MQCFIN)

Trigger control (parameter identifier: MQIA_TRIGGER_CONTROL). The value can be:

MQTC_OFF

Trigger messages not required.

MQTC_ON

Trigger messages required.

TriggerData (MQCFST)

Trigger data (parameter identifier: MQCA_TRIGGER_DATA).

The maximum length of the string is MQ_TRIGGER_DATA_LENGTH.

TriggerDepth (MQCFIN)

Trigger depth (parameter identifier: MQIA_TRIGGER_DEPTH).

TriggerMsgPriority (MQCFIN)

Threshold message priority for triggers (parameter identifier: MQIA_TRIGGER_MSG_PRIORITY).

TriggerType (MQCFIN)

Trigger type (parameter identifier: MQIA_TRIGGER_TYPE). The value can be:

MQTT_NONE

No trigger messages.

MQTT_FIRST

Trigger message when queue depth goes from 0 to 1.

MQTT_EVERY

Trigger message for every message.

MQTT_DEPTH

Trigger message when depth threshold exceeded.

Usage (MQCFIN)

Usage (parameter identifier: MQIA_USAGE). The value can be:

MQUS_NORMAL

Normal usage.

MQUS_TRANSMISSION

Transmission queue.

XmitQName (MQCFST)

Transmission queue name (parameter identifier: MQCA_XMIT_Q_NAME).

The maximum length of the string is MQ_Q_NAME_LENGTH.

Parent topic: Definitions of the Programmable Command Formats