MQCMD_INQUIRE_APPL_STATUS (inquire application status) on Multiplatforms

The Inquire Application Status (MQCMD_INQUIRE_APPL_STATUS) PCF command inquires about the applications and application instances connected to a queue manager or uniform cluster.

You must specify the application name for which you want to receive status information.

Required parameters

ApplicationName (MQCFST)

Application name set using the APPPLTAG parameter (parameter identifier: MQCACF_APPL_NAME).

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

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

The maximum length of the string is MQ_APPL_NAME_LENGTH.

Optional parameters

ApplicationInfoAttrs (MQCFIL)

Application information attributes (parameter identifier: MQIACF_APPL_INFO_ATTRS)

If not provided, defaults to MQIACF_ALL

Alternatively, you can specify any of the parameter values listed in the Inquire Application Status (Response)command, which are valid for the requested status type.

ApplicationStatusInfoType (MQCFIN)

The type of status to return (parameter identifier: MQIACF_APPL_INFO_TYPE).

The value can be:

MQIACF_APPL_INFO_APPL
The command displays status information relating to each unique application name. This represents a summary of the details from the local queue manager and any queue manager in the same uniform cluster.
MQIACF_APPL_INFO_QMGR
The command displays status information relating to applications at a queue manager level, including the local queue manager and any queue manager in the same uniform cluster.
MQIACF_APPL_INFO_LOCAL
The command displays status information for applications, for each application instance connected to the local queue manager.

The default value, if this parameter is not specified, is MQIACF_APPL_INFO_APPL.

ApplicationType (MQCFIL): Application type (parameter identifier: MQIACF_BALANCING_TYPE); The application type (MQBNO_BALTYPE_SIMPLE, MQBNO_BALTYPE_REQREP, or MQBNO_BALTYPE_RAMANAGED) in effect for this application instance.; Note that different instances of the same application can provide different balancing options without causing any error.

BalancingOptions (MQCFIL)

Application balancing options (parameter identifier: MQIACF_BALANCING_OPTIONS)

The balancing options (MQBNO_OPTIONS_NONE or MQBNO_OPTIONS_IGNORE_TRANS) in effect for this application instance.

Connections(MQCFIN)

The number of queue manager connections this application instance currently has open. (parameter identifier: MQIACF_CONNECTION_COUNT).

ConnectionTag (MQCFBS)

The connection tag associated with this application instance. When generated by the queue manager, this is a UTF8 string. (parameter identifier: MQBACF_CONN_TAG).

The maximum length of this field is MQ_CONN_TAG_LENGTH

ImmovableCount (MQCFIN)

The count of times this application instance has been requested to move to another queue manager and has not yet disconnected. Any value higher than one is an indication that the application is failing to rebalance when requested to. (parameter identifier: MQIACF_APPL_IMMOVABLE_COUNT).

ImmovableDate (MQCFST)

Date on which this local instance is considered eligible for being moved around a uniform cluster. This field is blank unless there is a temporary condition which prevents an application instance being moved to another queue manager in a uniform cluster. (parameter identifier: MQCACF_APPL_IMMOVABLE_DATE).

The length of the string is MQ_DATE_LENGTH

ImmovableReason (MQCFIN)

The reason why this application is currently considered to be immovable and, therefore, will not be rebalanced around the cluster. Some reasons are temporary, and have an associated ImmovableDate and ImmovableTime, or ImmovableTime reason. Other reasons persist for the lifetime of this application instance. (parameter identifier: MQIACF_APPL_IMMOVABLE_REASON).

The value can be any of the following values:

MQIMMREASON_NONE: This application instance is currently considered movable.
MQIMMREASON_NOT_CLIENT: This application instance cannot be moved as it is not a client connection.
MQIMMREASON_NOT_RECONNECTABLE: This application instance cannot be moved as it is not a reconnectable client connection.
MQIMMREASON_MOVING: This application instance cannot be moved as it has recently been requested to move, and has not yet disconnected.
MQIMMREASON_APPLNAME_CHANGED: This application instance cannot be moved as it is sharing a socket with a connection from an application instance which has a different application name.
MQIMMREASON_IN_TRANSACTION: The application instance has successfully performed at least one MQI operation within syncpoint, and the timeout specified to forcibly rebalance an instance has not been reached.
MQIMMREASON_TDQ_OPEN_INPUT: The application instance has at least one dynamic queue open for input, and the timeout specified to forcibly rebalance an instance has not been reached.
MQIMMREASON_AWAITS_REPLY: The application instance has successfully performed at least one MQI operation within syncpoint, and the timeout specified to forcibly rebalance an instance has not been reached.

ImmovableTime (MQCFST)

Time on which this local instance is considered eligible for being moved around a uniform cluster. This field is blank unless there is a temporary condition which prevents an application instance being moved to another queue manager in a uniform cluster. (parameter identifier: MQCACF_APPL_IMMOVABLE_TIME).

The length of the string is MQ_TIME_LENGTH

IntegerFilterCommand (MQCFIF)

Integer filter command descriptor that you use to restrict the output from the command. The parameter identifier must be an integer type, and must be one of the values allowed for the ApplicationStatusInfoType selected, except MQIACF_ALL.

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

Movable (MQCFIN)

Indicates whether this application instance is considered eligible for moving around the uniform cluster. At a minimum, a movable application must be a client connection which has connected as reconnectable. (parameter identifier: MQIACF_APPL_MOVABLE).

The value can be any of the following values:

MQACTIVE_YES: This application instance is considered movable.
MQACTIVE_NO: This application instance is not considered movable.

StringFilterCommand (MQCFSF)

String filter command descriptor. The parameter identifier must be any string type parameter except MQCA_APPL_NAME. Use this parameter to restrict the output from the command by specifying a filter condition.

Ensure that the parameter is valid for the type selected in ApplicationStatusInfoType.

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

Note: Although the ConnectionTag (MQBACF_CONN_TAG) field in Inquire Application Status (Response) is defined as a binary field, the contents should be UTF8.

Because of this, use a StringFilter for this field, not a ByteStringFilter, and you can use all valid StringFilter operators.

Timeout (MQCFIN): Application timeout (parameter identifier: MQIACF_BALANCING_TIMEOUT); The time out value of NEVER, IMMEDIATE, or the time in seconds up to a maximum of 999999999 seconds.