Inquire Usage (Response) on z/OS
The response to the Inquire Usage (MQCMD_INQUIRE_USAGE) command consists of the response header followed by one or more UsageType structure and a set of attribute parameter structures determined by the value of UsageType in the Inquire command.
- Always returned:
- UsageType
Possible values of ParameterType are:
- MQIACF_USAGE_PAGESET
- Page set information.
- MQIACF_USAGE_BUFFER_POOL
- Buffer pool information.
- MQIACF_USAGE_DATA_SET
- Data set information for log data sets.
- MQIACF_USAGE_SMDS
- Return shared message data set usage and buffer pool information.
This includes the allocated, and used space for each data set, and information about the number of buffers currently active, the number with valid contents, and the number of free buffers.
- Returned if UsageType is MQIACF_USAGE_PAGESET:
- BufferPoolId, Encrypted, ExpandCount, ExpandType, LogRBA, NonPersistentDataPages, PageSetId, PageSetStatus, PersistentDataPages, TotalPages, UnusedPages
- Returned if UsageType is MQIACF_USAGE_BUFFER_POOL:
- BufferPoolId, FreeBuffers, FreeBuffersPercentage, TotalBuffers, BufferPoolLocation, PageClass
- Returned if UsageType is MQIACF_USAGE_DATA_SET:
- DataSetName, DataSetType, LogRBA, LogLRSN
- Returned if UsageType is MQIACF_USAGE_SMDS:
- DataSetName, DataSetType, Encrypted
Response data if UsageType is MQIACF_USAGE_PAGESET
- BufferPoolId (MQCFIN)
- Buffer pool identifier (parameter identifier: MQIACF_BUFFER_POOL_ID).
This parameter identifies the buffer pool being used by the page set.
- Encrypted (MQCFIN)
- Shows whether the page set is encrypted (parameter identifier: MQIACF_DS_ENCRYPTED)The value
can be one of the following values:
- MQSYSP_YES
- The page set is encrypted.
- MQSYSP_NO
- The page set is not encrypted.
- ExpandCount (MQCFIN)
- The number of times the page set has been dynamically expanded since restart (parameter identifier: MQIACF_USAGE_EXPAND_COUNT).
- ExpandType (MQCFIN)
- How the queue manager expands a page set when it becomes nearly full, and further pages are
required within it (parameter identifier: MQIACF_USAGE_EXPAND_TYPE).
The value can be:
- MQUSAGE_EXPAND_NONE
- No further page set expansion is to take place.
- MQUSAGE_EXPAND_USER
- The secondary extent size that was specified when the page set was defined is used. If no
secondary extent size was specified, or it was specified as zero, then no dynamic page set expansion
can take place.
At restart, if a previously used page set has been replaced with a data set that is smaller, it is expanded until it reaches the size of the previously used data set. Only one extent is required to reach this size.
- MQUSAGE_EXPAND_SYSTEM
- A secondary extent size that is approximately 10 per cent of the current size of the page set is used. MQUSAGE_EXPAND_SYSTEM can be rounded up to the nearest cylinder of DASD.
- NonPersistentDataPages (MQCFIN)
- The number of pages holding nonpersistent data (parameter identifier:
MQIACF_USAGE_NONPERSIST_PAGES).
These pages are being used to store nonpersistent message data.
- PageSetId (MQCFIN)
- Page set identifier (parameter identifier: MQIA_PAGESET_ID).
The string consists of two numeric characters, in the range 00 through 99.
- PageSetStatus (MQCFIN)
- Current status of the page set (parameter identifier: MQIACF_PAGESET_STATUS).
The value can be any of the following values:
- MQUSAGE_PS_AVAILABLE
- The page set is available.
- MQUSAGE_PS_DEFINED
- The page set has been defined but has never been used.
- MQUSAGE_PS_OFFLINE
- The page set is currently not accessible by the queue manager, for example because the page set has not been defined to the queue manager.
- MQUSAGE_PS_NOT_DEFINED
- The command was issued for a specific page set that is not defined to the queue manager.
- MQUSAGE_PS_SUSPENDED
- The page set has been suspended.
- PersistentDataPages (MQCFIN)
- The number of pages holding persistent data (parameter identifier: MQIACF_USAGE_PERSIST_PAGES).
These pages are being used to store object definitions and persistent message data.
- TotalPages (MQCFIN)
- The total number of 4 KB pages in the page set (parameter identifier: MQIACF_USAGE_TOTAL_PAGES).
- UnusedPages (MQCFIN)
- The number of pages that are not used (that is, available page sets) (parameter identifier: MQIACF_USAGE_UNUSED_PAGES).
- LogRBA (MQCFST)
- Log RBA (parameter identifier: MQCACF_USAGE_LOG_RBA).
The maximum length is MQ_RBA_LENGTH.
This response is returned only if PageSetStatus is set to MQUSAGE_PS_NOT_DEFINED or MQUSAGE_SUSPENDED. However, the response is not always returned if PageSetStatus is set to MQUSAGE_PS_NOT_DEFINED.
A value of 'FFFFFFFFFFFFFFFF' indicates that the page set has never been online.
Response data if UsageType is MQIACF_USAGE_BUFFER_POOL
- BufferPoolId (MQCFIN)
- Buffer pool identifier (parameter identifier: MQIACF_BUFFER_POOL_ID).
This parameter identifies the buffer pool being used by the page set.
- FreeBuffers (MQCFIN)
- Number of free buffers (parameter identifier: MQIACF_USAGE_FREE_BUFF).
- FreeBuffersPercentage (MQCFIN)
- Number of free buffers as a percentage of all buffers in the buffer pool (parameter identifier: MQIACF_USAGE_FREE_BUFF_PERC).
- TotalBuffers (MQCFIN)
- The number of buffers defined for specified buffer pool (parameter identifier: MQIACF_USAGE_TOTAL_BUFFERS).
- BufferPoolLocation (MQCFIN)
- The location of the buffers in this buffer pool relative to the bar. This is one of the
following values:
- MQBPLOCATION_ABOVE
- All buffer pool buffers are above the bar.
- MQBPLOCATION_BELOW
- All buffer pool buffers are below the bar.
- MQBPLOCATION_SWITCHING_ABOVE
- Buffer pool buffers are being moved above the bar.
- MQBPLOCATION_SWITCHING_BELOW
- Buffer pool buffers are being moved below the bar.
- PageClass (MQCFIN)
- The type of virtual storage pages used for backing the buffers in the buffer pool. This is one
of the following values:
- MQPAGECLAS_4KB
- Pageable 4 KB pages are used.
- MQPAGECLAS_FIXED4KB
- Fixed 4 KB pages are used.
Response data if UsageType is MQIACF_USAGE_DATA_SET
- DataSetName (MQCFST)
- Data set name (parameter identifier: MQCACF_DATA_SET_NAME).
The maximum length is MQ_DATA_SET_NAME_LENGTH.
- DataSetType (MQCFIN)
- The type of data set, and circumstance (parameter identifier: MQIACF_USAGE_DATA_SET_TYPE).
The value can be:
- MQUSAGE_DS_OLDEST_ACTIVE_UOW
- The log data set containing the start RBA of the oldest active unit of work for the queue manager
- MQUSAGE_DS_OLDEST_PS_RECOVERY
- The log data set containing the oldest restart RBA of any page set for the queue manager.
- MQUSAGE__DS_OLDEST_CF_RECOVERY
- The log data set containing the LRSN which matches the time of the oldest current backup of any CF structure in the queue sharing group.
- LogRBA (MQCFST)
- Log RBA (parameter identifier: MQCACF_USAGE_LOG_RBA).
The maximum length is MQ_RBA_LENGTH.
- LogLRSN (MQCFST)
- Log LRSN (parameter identifier: MQIACF_USAGE_LOG_LRSN).
The length of the string is MQ_LRSN_LENGTH.
Response data if UsageType is MQIACF_USAGE_SMDS
- Encrypted (MQCFIN)
- Shows whether the SMDS is encrypted (parameter identifier: MQIACF_DS_ENCRYPTED)The value can
be one of the following values:
- MQSYSP_YES
- The SMDS is encrypted.
- MQSYSP_NO
- The SMDS is not encrypted.
- SMDSStatus (MQCFIN)
- SMDS status (parameter identifier: MQIACF_SMDS_STATUS).
- MQUSAGE_SMDS_NO_DATA
- There is no SMDS data available. Nothing further is returned.
- MQUSAGE_SMDS_AVAILABLE
- For each CF structure two sets of PCF data are returned:
- A
-
- CFStrucNames (MQCFSL)
- List of CF application structure names (parameter identifier: MQCACF_CF_STRUC_NAME).
- MQIACF_USAGE_OFFLOAD_MSGS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_OFFLOAD_MSGS).
- MQIACF_USAGE_TOTAL_BLOCKS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_TOTAL_BLOCKS).
- MQIACF_USAGE_DATA_BLOCKS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_DATA_BLOCKS).
- MQIACF_USAGE_USED_BLOCKS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_USED_BLOCKS).
- MQIACF_USAGE_USED_RATE (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_USED_RATE).
- MQIACF_SMDS_STATUS (MQCFIN)
- Description required (parameter identifier: MQIACF_SMDS_STATUS). The value is MQUSAGE_SMDS_AVAILABLE.
- MQIACF_USAGE_TYPE (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_TYPE).
- B
-
- CFStrucNames (MQCFSL)
- List of CF application structure names (parameter identifier: MQCACF_CF_STRUC_NAME).
- MQIACF_USAGE_BLOCK_SIZE (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_BLOCK_SIZE).
- MQIACF_USAGE_TOTAL_BUFFERS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_TOTAL_BUFFERS).
- MQIACF_USAGE_INUSE_BUFFERS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_INUSE_BUFFERS).
- MQIACF_USAGE_SAVED_BUFFERS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_SAVED_BUFFERS).
- MQIACF_USAGE_EMPTY_BUFFERS (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_EMPTY_BUFFERS).
- MQIACF_USAGE_READS_SAVED (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_READS_SAVED).
- MQIACF_USAGE_LOWEST_FREE (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_LOWEST_FREE).
- MQIACF_USAGE_WAIT_RATE (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_WAIT_RATE).
- MQIACF_SMDS_STATUS (MQCFIN)
- Description required (parameter identifier: MQIACF_SMDS_STATUS). The value is MQUSAGE_SMDS_AVAILABLE.
- MQIACF_USAGE_TYPE (MQCFIN)
- Description required (parameter identifier: MQIACF_USAGE_TYPE).
Parent topic: Definitions of the Programmable Command Formats