DISPLAY APSTATUS (display application status)

Use the MQSC command DISPLAY APSTATUS to display the status of one or more applications and application instances connected to a queue manager or a uniform cluster.

Using MQSC commands

For information on how you use MQSC commands, see Performing local administration tasks using MQSC commands.

Syntax diagram
Usage notes for DISPLAY APSTATUS
Parameter descriptions for DISPLAY APSTATUS
Application status
Queue manager status
Local status

Synonym: DIS APS

DISPLAY APSTATUS

Application status

Queue manager status

Local status

Usage notes for DISPLAY APSTATUS

The application name parameter of the DISPLAY APSTATUS command matches against application names set by applications. See using the application name in supported programming languages for more information.

Parameter descriptions for DISPLAY APSTATUS

The DISPLAY APSTATUS command requires an application name string value to determine which application details to return.

applicationnamestr

The application name string can have one of the following values:

A specific application name string value. For example, DIS APSTATUS('myapp') returns details of just the 'myapp' application
A string containing one or more wildcard characters. For example, DIS APSTATUS('*put*') returns all applications which have 'put' in their application names.

To return a list of all user applications, use DIS APSTATUS('*')

To filter the list of applications returned, use the WHERE parameter. For example,

DIS
APSTATUS('*put*') TYPE(APPL) WHERE(BALANCED eq NO)

returns application information about all unbalanced applications with 'put' in their name.

WHERE

Specifies a filter condition to match only those applications or application instances that satisfy the selection criterion of the filter condition. The filter condition is in three parts: filter-keyword, operator, and filter-value:

filter-keyword

Any parameter that you can use with this DISPLAY command based on the TYPE option.

operator

Determines whether a keywords value satisfies a condition on the given filter value. The operators are:

LT: Less than
GT: Greater than
EQ: Equal to
NE: Not equal to
LE: Less than or equal to
GE: Greater than or equal to
LK: Matches a generic string that you provide as a filter-value
NL: Does not match a generic string that you provide as a filter-value
CT: Contains a specified item. If the filter-keyword is a list, you can use this filter to display objects whose attributes contain the specified item.
EX: Does not contain a specified item. If the filter-keyword is a list, you can use this filter to display objects whose attributes do not contain the specified item.

filter-value

The value that the attribute value must be tested against using the operator. Depending on the filter-keyword, this value can be:

An explicit value, that is a valid value for the attribute being tested.
You can use operators LT, GT, EQ, NE, LE, or GE only. However, if the attribute value is one from a possible set of values on a parameter, you can only use EQ or NE.
A generic value. This value is a character string with an asterisk at the end, for example ABC*. If the operator is LK, all items where the attribute value begins with the string (ABC in the example) are listed. If the operator is NL, all items where the attribute value does not begin with the string are listed.
You cannot use a generic filter-value for parameters with numeric values or with one of a set of values.

ALL

Use this parameter to display all attributes.

If you specify this parameter, any attributes that you request additionally have no effect; the command displays all attributes.

This value is the default, if you do not specify a generic name, and do not request any specific parameters.

TYPE

Specifies the type of status information required:

APPL: The command displays status information relating to each unique application name, which is the default if you do not provide a TYPE parameter. This represents a summary of the details from the local queue manager and any queue manager in the same uniform cluster.
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.
LOCAL: The command displays status information for applications, for each application instance connected to the local queue manager.

Application status

Application status parameters define the data that the command displays. You can specify these parameters in any order, but you must not specify the same parameter more than once:

BALANCED

If the local queue manager is a member of a uniform cluster, this field gives an indication as to whether the number of application instances across the cluster is currently balanced, based on the last information received from the other queue managers in the cluster.

If the queue manager is not a member of a uniform cluster, this field shows NOTAPPLIC.

The value can be any of the following values:

NO: This application is not considered balanced in the uniform cluster.
YES: This application is considered balanced in the uniform cluster.
NOTAPPLIC: This application is not shared across a uniform cluster.
UNKNOWN: This is a temporary state, representing an application that has not yet undergone a scan to calculate whether it is balanced or not, on at least one queue manager, across the uniform cluster.

CLUSTER

If the application details are being sent around a uniform cluster, this field displays the name of the uniform cluster, otherwise it shows a blank.

COUNT

This displays the sum of the number of application instances for this application from the local queue manager, and all queue managers in the uniform cluster that have shared their application instance counts.

A queue manager not in a uniform cluster displays the count of local application instances.

MOVCOUNT

This displays the sum of the number of movable application instances for this application from the local queue manager and all queue managers in the uniform cluster that have shared their application instance counts.

A queue manager not in a uniform cluster displays the count of local application instances that would be movable if put in a uniform cluster.

Queue manager status

Queue manager status parameters define the data that the command displays. You can specify these parameters in any order, but you must not specify the same parameter more than once.

ACTIVE

Displays if the queue manager is considered active when balancing applications, which indicates whether information from that queue manager has been received recently.

YES: The queue manager is communicating with the uniform cluster, and actively participating in balancing for this application.
NO: No status has recently been received from this queue manager. This could indicate a communication problem, or that the queue manager has been suspended from the uniform cluster.

BALSTATE

Indicates the state of the application instances on this queue manager, compared to the other queue managers in a uniform cluster. The value can be :

HIGH: There is a surplus of application instances.
OK: There is a balanced number of application instances.
LOW: There are not enough application instances.
NOTAPPLIC: The queue manager is not in a uniform cluster.
UNKNOWN: This is a temporary state representing an application that is new to the uniform cluster, and which has not yet undergone a scan to calculate whether it is balanced or not.

COUNT

Represents the count of application instances for this application on the queue manager.

LMSGDATE

The local date on which the local queue manager last received a published message from this queue manager, containing its application instance details.

LMSGTIME

The local time on which the local queue manager last received a published message from this queue manager, containing its application instance details.

MOVCOUNT

This represents the count of movable application instances for this application on the queue manager. Only application instances which are movable will be considered for rebalancing in a uniform cluster.

QMID

The queue manager identifier of the queue manager, that this information originated from.

QMNAME

The queue manager name that this information originated from. There will be one entry for the local queue manager, and one from each queue manager that has distributed information about this application in a uniform cluster.

Local status

Local status parameters define the data that the command displays. You can specify these parameters in any order, but you must not specify the same parameter more than once.

BALOPTS

The balancing options in effect for this application instance. Possible values are:

MQBNO_OPTIONS_NONE: No options are set.
MQBNO_OPTIONS_IGNORE_TRANS: This option allows applications to be rebalanced even if in the middle of a transaction.

BALTMOUT

The time out value in effect for this application instance. Possible values are:

NEVER: No time out occurs.
IMMEDIATE: Time out occurs immediately
Set value: The timeout value in seconds, up to a maximum of 999999999 seconds.

BALTYPE

The application type in effect for this application instance. Possible values are:

MQBNO_BALTYPE_SIMPLE: No specific rules should be applied beyond the defaults described in Configuring the balancing behavior.
MQBNO_BALTYPE_REQREP: After each MQPUT call, a matching MQGET call is expected for a response message. Balancing is delayed until such a message is received, or the request message EXPIRY has been exceeded.
MQBNO_BALTYPE_RAMANAGED: Re-balancing requests are always dispatched immediately to the client, which re-balances at a point the client considers appropriate.

Note that different instances of the same application can provide different balancing options without causing any error.

CONNS

The number of connections (HCONNS) the application instance currently has.

CONNTAG

The connection tag of this application instance.

IMMCOUNT

The number of times this application instance has been asked to reconnect but has stayed connected. Any value higher than one indicates the application is not moving when requested.

IMMDATE

If the application instance is immovable for a fixed period, this indicates the date at which the instance will be eligible for moving again. If this has a value, the IMMREASN field should indicate why the connection is temporarily immovable. If the connection is not temporarily immovable, the value is blank.

IMMREASN

If the application instance is immovable, this indicates a reason as to why. If the application instance is movable, the value is blank. Only one IMMREASN is displayed even though multiple might apply; note that permanent statuses (such as NOTRECONN, NOTCLIENT) are displayed in preference to temporary values (such as MOVING, INTRANS).

The value can be any of the following values:

APPNAMECHG: 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.
INTRANS: 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.
MOVING: This application instance cannot be moved as it has recently been requested to move, and has not yet disconnected.; This status should be temporary. IMMDATE and IMMTIME indicate when this application instance is considered eligible to move again if this state unexpectedly persists.
NONE: This application instance is currently considered movable.
NOREDIRECT: The client application has indicated that it cannot process redirect hints from the queue manager. This might be because the application isn't using a CCDT to connect to the queue manager.
NOTCLIENT: This application instance cannot be moved as it is not a client connection.
NOTRECONN: This application instance cannot be moved as it is not a reconnectable client connection.
REPLY: The application instance is of type REQREP and has sent at least one request message for which a corresponding response has not been received. The timeout specified to forcibly rebalance an instance has not been reached.

IMMTIME

If the application instance is immovable for a fixed period, this indicates the time at which the instance will be eligible for moving again. If this has a value, the IMMREASN field should indicate why the connection is temporarily immovable. If the connection is not temporarily immovable, the value is blank.

MOVABLE

This indicates whether this application instance is considered movable or not.