MQCMD_INQUIRE_Q_MGR_STATUS (Inquire Queue Manager Status) on Multiplatforms
The Inquire Queue Manager Status (MQCMD_INQUIRE_Q_MGR_STATUS) PCF command inquires about the status of the local queue manager.
Optional parameters
- IntegerFilterCommand
- Integer filter command descriptor. The parameter identifier must be one of the following Native
HA integer type parameters:
- MQIACF_NHA_INSTANCE_ROLE
- MQIACF_NHA_INSTANCE_BACKLOG
- MQIACF_NHA_INSTANCE_ACTV_CONNS
- MQIACF_NHA_INSTANCE_IN_SYNC
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, you cannot also specify a string filter using the StringFilterCommand parameter.
- QMStatusAttrs (MQCFIL)
- Queue manager status attributes (parameter identifier: MQIACF_Q_MGR_STATUS_ATTRS).
The attribute list might specify the following value on its own and is the default value used if the parameter is not specified:
- MQIACF_ALL
- All attributes.
A combination of the following attributes returns status information for a queue manager:
Where StatusType is MQIACF_Q_MGR_STATUS_INFO_Q_MGR:
- MQCA_Q_MGR_NAME
- Name of the local queue manager.
- MQCA_INSTALLATION_DESC
- Description of the installation associated with the queue manager.
- MQCA_INSTALLATION_NAME
- Name of the installation associated with the queue manager.
- MQCA_INSTALLATION_PATH
- Path of the installation associated with the queue manager.
- MQCACF_ARCHIVE_LOG_EXTENT_NAME)
- Name of the oldest log extent for which the queue manager is waiting for archive
notification.
The maximum length of the string is MQ_LOG_EXTENT_NAME_LENGTH.
If the queue manager is not using archive log management, this attribute is blank. This parameter is not valid on IBM® i.
- MQCACF_CURRENT_LOG_EXTENT_NAME
- Name of the log extent currently being written to by the logger. MQCACF_CURRENT_LOG_EXTENT_NAME is available only on queue managers using linear logging. On other queue managers, MQCACF_CURRENT_LOG_EXTENT_NAME is blank.
MQCACF_HOST_NAME- The name of the host that the queue manager is running on. The length of this attribute is given by MQ_HOST_NAME_LENGTH.
- MQCACF_LOG_PATH
- Location of the recovery log extents.
MQCACF_LOG_START_DATE- The date for the last log record recovered when the queue manager started (in the form
yyyy-mm-dd). The length of this attribute
is given by MQ_DATE_LENGTH.
This attribute is not valid on IBM i.
MQCACF_LOG_START_LSN-
The log sequence number (LSN) for the last log record recovered when the queue manager started. Given in the form
<nnnnn:nnnnn:nnnnn:nnnnn>. The length of this attribute is given by MQ_LSN_LENGTH.This attribute is not valid on IBM i.
MQCACF_LOG_START_TIME- The time for the last log record recovered when the queue manager started (in the form
hh.mm.ss). The length of this attribute is
given by MQ_TIME_LENGTH.
This attribute is not valid on IBM i.
- MQCACF_MEDIA_LOG_EXTENT_NAME
- Name of the earliest log extent required to perform media recovery. MQCACF_MEDIA_LOG_EXTENT_NAME is available only on queue managers using linear logging. On other queue managers, MQCACF_MEDIA_LOG_EXTENT_NAME is blank.
MQCACF_NHA_INSTANCE_NAME- The name of the local Native HA instance if the queue manager is running in a Native HA environment, or blank otherwise. The length of this attribute is given by MQ_NHA_INSTANCE_NAME_LENGTH.
- MQCACF_RESTART_LOG_EXTENT_NAME
- Name of the earliest log extent required to perform restart recovery. MQCACF_RESTART_LOG_EXTENT_NAME is available only on queue managers using linear logging. On other queue managers, MQCACF_RESTART_LOG_EXTENT_NAME is blank.
MQCACF_Q_MGR_DATA_PATH- Location of the queue manager data. This parameter identifies the directory where queue manager data files are created by the queue manager. The length of this attribute is given by MQ_Q_MGR_DATA_PATH_LENGTH.
- MQCACF_Q_MGR_START_DATE
- The date on which the queue manager was started (in the form yyyy-mm-dd). The length of this attribute is given by MQ_DATE_LENGTH.
- MQCACF_Q_MGR_START_TIME
- The time at which the queue manager was started (in the form hh.mm.ss). The length of this attribute is given by MQ_TIME_LENGTH.
MQCACF_UNIFORM_CLUSTER_NAME- Indicates the name of the uniform cluster that the queue manager is a member of, or blank otherwise. The length of this attribute is given by MQ_CLUSTER_NAME_LENGTH.
- MQIACF_ARCHIVE_LOG_SIZE
- Current size of the amount of space occupied, in megabytes, by log extents no longer required
for restart or media recovery but waiting to be archived.
This attribute is not valid on IBM i.
MQIACF_AUTO_CLUSTER_TYPE- The type of automatic cluster that the queue manager is a member of.
- MQIACF_CHINIT_STATUS
- Current status of the channel initiator.
- MQIACF_CMD_SERVER_STATUS
- Current status of the command server.
- MQIACF_CONNECTION_COUNT
- Current number of connections to the queue manager.
MQIACF_DATA_FS_SIZE- The size of the dedicated queue manager data file system in MB, rounded up.
MQIACF_DATA_FS_IN_USE- The percentage of the dedicated queue manager data file system that is used, rounded up to the nearest percent.
- MQIACF_LDAP_CONNECTION_STATUS
- Current status of the connection to the LDAP server.
MQIACF_LOG_EXTENT_SIZE- The size of each log file in KB or the threshold of the currently attached journal receiver on IBM i.
MQIACF_LOG_FS_SIZE- The size of the dedicated recovery log file system in MB, rounded up. The amount of file system space is different from the amount of the active log being used and is based on the configuration of the log, the space may not be useable.
MQIACF_LOG_FS_IN_USE- The percentage of the recovery log file system that is used, rounded up to the nearest percent.
- MQIACF_LOG_IN_USE
- Current size of the percentage of the primary log space in use for restart recovery at this
point in time.
This attribute is not valid on IBM i.
MQIACF_LOG_PRIMARIES- The number of primary log files.
This attribute is not valid on IBM i.
MQIACF_LOG_SECONDARIES- The maximum number of secondary log files.
This attribute is not valid on IBM i.
MQIACF_LOG_TYPE- The type of logging used by the queue manager.
- MQIACF_LOG_UTILIZATION
- Current percentage estimate of how well the queue manager workload is contained within the
primary log space.
This attribute is not valid on IBM i.
- MQIACF_MEDIA_LOG_SIZE
- Current size of the log data required for media recovery in megabytes.
This attribute is not valid on IBM i.
- MQIACF_NHA_IN_SYNC_INSTANCES
- How many of the configured instances are in-sync with the active instance in a Native HA configuration.
- MQIACF_NHA_TOTAL_INSTANCES
- Total number of configured instances of the queue manager in a Native HA configuration.
- MQIACF_PERMIT_STANDBY
- Whether a standby instance is permitted.
MQIACF_Q_MGR_FS_ENCRYPTED- Indicates whether the queue manager file system is encrypted or not.
Returned on the IBM MQ Appliance only.
MQIACF_Q_MGR_FS_SIZE- The size of the queue manager data and recovery log file systems in MB, rounded up.
MQIACF_Q_MGR_FS_IN_USE- The percentage of the queue manager data and recovery log file systems that are used, rounded up to the nearest percent.
- MQIACF_Q_MGR_STATUS
- Current status of the queue manager.
- MQIACF_Q_MGR_STATUS_LOG
- Current status of all the log attributes. The attributes can be any of the following:
- MQCACF_ARCHIVE_LOG_EXTENT_NAME
- MQIACF_ARCHIVE_LOG_SIZE
- MQCACF_CURRENT_LOG_EXTENT_NAME
- MQIACF_LOG_IN_USE
- MQIACF_LOG_UTILIZATION
- MQCACF_MEDIA_LOG_EXTENT_NAME
- MQIACF_MEDIA_LOG_SIZE
- MQCACF_RESTART_LOG_EXTENT_NAME
- MQIACF_RESTART_LOG_SIZE
- MQIACF_REUSABLE_LOG_SIZE
- MQIACF_RESTART_LOG_SIZE
- Size of the log data required for restart recovery in megabytes.
This attribute is not valid on IBM i.
- MQIACF_REUSABLE_LOG_SIZE
- The amount of space occupied, in megabytes, by log extents available to be reused.
This attribute is not valid on IBM i.
Where StatusType is MQIACF_Q_MGR_STATUS_INFO_NHA: ![[MQ 9.3.2 Feb 2023]](ng932.gif)
- MQCACF_NHA_INSTANCE_NAME
- The name of the instance. The length of this attribute is given by MQ_NHA_INSTANCE_NAME_LENGTH.
- MQIACF_NHA_INSTANCE_ROLE
- The current role of the instance in the Native HA group.
- MQIACF_NHA_INSTANCE_BACKLOG
- How many KB of recovery log data the active instance has written that have not yet been acknowledged by the named instance.
- MQIACF_NHA_INSTANCE_ACTV_CONNS
- Whether the instance currently has a pair of active connections to the active instance.
- MQCACF_NHA_GROUP_INITIAL_DATE
- The date of the last log record recovered when the Native HA group initially became active. The length of this attribute is given by MQ_DATE_LENGTH.
- MQCACF_NHA_GROUP_INITIAL_LSN
- The log sequence number (LSN) of the last log record recovered when the Native HA group initially became active. The length of this attribute is given by MQ_LSN_LENGTH.
- MQCACF_NHA_GROUP_INITIAL_TIME
- The time of the last log record recovered when the Native HA group initially became active. The length of this attribute is given by MQ_TIME_LENGTH.
- MQIACF_NHA_INSTANCE_IN_SYNC
- Whether this instance is currently considered in-sync with the active instance.
- MQCACF_NHA_REPL_ADDRESS
- The network address and port to use when sending data to and from the specified instance. The length of this attribute is given by MQ_NHA_REPL_ADDRESS_LENGTH.
![[MQ 9.3.2 Feb 2023]](ng932.gif)
- StatusType (MQCFIN)
- Queue manager status type (parameter identifier: MQIACF_Q_MGR_STATUS_INFO_TYPE). Specifies the
type of status information required. Can be any of the following values:
- MQIACF_Q_MGR_STATUS_INFO_Q_MGR
- Selects general status information relating to the queue manager.
- MQIACF_Q_MGR_STATUS_INFO_NHA
- Selects status information relating to Native HA instances.
The default value, if this parameter is not specified, is MQIACF_Q_MGR_STATUS_INFO_Q_MGR.
You cannot use StatusType as a parameter to filter on.
- StringFilterCommand (MQCFSF)
- String filter command descriptor. The parameter identifier must be one of the following Native
HA string type parameters:
- MQCACF_NHA_INSTANCE_NAME
- MQCACF_NHA_GROUP_INITIAL_DATE
- MQCACF_NHA_GROUP_INITIAL_LSN
- MQCACF_NHA_GROUP_INITIAL_TIME
- MQCACF_NHA_REPL_ADDRESS
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, you cannot also specify an integer filter using the IntegerFilterCommand parameter.
![[MQ 9.3.2 Feb 2023]](ng932.gif)
Error codes
This command might return the following error code in the response format header Error codes applicable to all commands
- Reason (MQLONG)
- The value can be any of the following values:
- MQRCCF_NHA_NOT_AVAILABLE
- Native HA status not available.