DISPLAY CFSTATUS (display CF application structure status) on z/OS

Use the MQSC command DISPLAY CFSTATUS to display the status of one or more CF application structures. This command is valid only on IBM® MQ for z/OS® when the queue manager is a member of a queue sharing group.

Using MQSC commands

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

You can issue this command from sources CR. For an explanation of the source symbols, see Sources from which you can issue MQSC commands on z/OS.

Syntax diagram
Keyword and parameter descriptions for DISPLAY CFSTATUS
Summary status
Connection status
Backup status
SMDS status

Synonym: DIS CFSTATUS

DISPLAY CFSTATUS

Notes:

¹ This option is only supported when the CFSTRUCT is defined with OFFLOAD(SMDS).

Keyword and parameter descriptions for DISPLAY CFSTATUS

The name of the application structure for the status information to be displayed must be specified. This can be a specific application structure name or a generic name. By using a generic name, it is possible to display either:

status information for all application structure definitions
status information for one or more application structures that match the specified name

The type of status information to be returned can also be specified. This can be:

summary status information for the application structure in the queue sharing group
connection status information for each queue manager in the queue sharing group for each matching application structure name
backup status information for each backup taken for each matching application structure defined in the queue sharing group

(generic-structure-name)

The 12-character name of the CF application structure to be displayed. A trailing asterisk (*) matches all structure names with the specified stem followed by zero or more characters. An asterisk (*) on its own specifies all structure names.

The CF structure name must be defined within the queue sharing group.

The CFSTATUS generic name can be the administration CF structure name (CSQ_ADMIN) or any generic form of this name. Data for this structure, however, is only displayed when TYPE is set to SUMMARY.

WHERE

Specify a filter condition to display status information for those CF application structures that satisfy the selection criterion of the filter condition. The filter condition is in three parts: filter-keyword, operator, and filter-value:

filter-keyword

Almost any parameter that is returned by this DISPLAY command. However, you cannot use the TYPE parameter as a filter keyword.

operator

This is used to determine whether a CF application structure satisfies the filter value on the given filter keyword. 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 to display objects the attributes of which contain the specified item.
EX: Does not contain a specified item. If the filter-keyword is a list, you can use this to display objects the attributes of which do not contain the specified item.
CTG: Contains an item which matches a generic string that you provide as a filter-value. If the filter-keyword is a list, you can use this to display objects the attributes of which match the generic string.
EXG: Does not contain any item which matches a generic string that you provide as a filter-value. If the filter-keyword is a list, you can use this to display objects the attributes of which do not match the generic string.

filter-value

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

An explicit value, that is a valid value for the attribute being tested.
You can use operators LT, GT, EQ, NE, LE, GE, only. However, if the value is one from a possible set of values returnable on a parameter (for example, the value ACTIVE on the STATUS parameter), you can only use EQ or NE.
A generic value. This is a character string (such as the character string in the QMNAME parameter) with an asterisk at the end, for example ABC*. The characters must be valid for the attribute you are testing. 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.
An item in a list of values. The value can be explicit or, if it is a character value, it can be explicit or generic. If it is explicit, use CT or EX as the operator. For example, if the value DEF is specified with the operator CT, all items where one of the attribute values is DEF are listed. If it is generic, use CTG or EXG as the operator. If ABC* is specified with the operator CTG, all items where one of the attribute values begins with ABC are listed.

TYPE

Specifies the type of status information required to be displayed. Values are:

SUMMARY: Display summary status information for each application structure. This is the default.
CONNECT: Display connection status information for each application structure for each active queue manager.
BACKUP: Display backup status information for each application structure.
SMDS: Display shared message data set information.

SMDS

qmgr-name: Specifies the queue manager for which the shared message data set status is to be displayed.
*: Displays the status for all shared message data sets associated with the specified CFSTRUCT except those which have both STATUS(NOTFOUND) and ACCESS(ENABLED).

Summary status

For summary status, the following information is returned for each structure that satisfies the selection criteria:

The name of the application structure matching the generic name.
The type of information returned.

CFTYPE

The CF structure type. This is one of the following:

ADMIN: This is the CF administration structure.
APPL: This is a CF application structure.

STATUS

The status of the CF application structure. This is one of the following:

ACTIVE: The structure is active.
FAILED: The structure has failed.
NOTFOUND: The structure is not allocated in the CF, but has been defined to Db2®. Check and resolve any messages in the job log about this structure.
INBACKUP: The structure is in the process of being backed-up.
INRECOVER: The structure is in the process of being recovered.
UNKNOWN: The status of the CF structure is not known because, for example, Db2 might be unavailable.

SIZEMAX (size)

The size in kilobytes of the application structure.

SIZEUSED (integer)

The percentage of the size of the application structure that is in use. Therefore SIZEUSED(25) would indicate that a quarter of the space allocated to this application structure is in use.

ENTSMAX (integer)

The number of CF list entries defined for this application structure.

Note: The number does not include any entries that are in storage class memory (SCM), and which might have been allocated to the structure.

ENTSUSED (integer)

The number of CF list entries for this application structure that are in use.

Note: The number does not include any entries that are in storage class memory (SCM), and which might have been allocated to the structure.

FAILTIME (time)

The time that this application structure failed. The format of this field is hh.mm.ss. This parameter is only applicable when the CF structure is in FAILED or INRECOVER state. If the structure is not in a failed state, this is displayed as FAILTIME().

FAILDATE (date)

The date that this application-structure failed. The format of this field is yyyy-mm-dd. This parameter is only applicable when the CF structure is in FAILED or INRECOVER state. If the structure is not in a failed state, then this is displayed as FAILDATE().

OFFLDUSE

This indicates whether offloaded large message data potentially exists in shared message data sets, Db2 or both.

When the offload method is switched, the previous offload method needs to remains available for retrieving and deleting old messages, so the OFFLDUSE status is changed to indicate BOTH. When a queue manager disconnects normally from a structure that has OFFLDUSE(BOTH) it checks whether there still are any messages which were stored using the old offload method. If not, it changes the OFFLDUSE status to match the current offload method and issues message CSQE245I to indicate that the switch is complete.

This parameter is one of the following:

NONE: No offloaded large messages are present.
SMDS: Offloaded large messages can exist in shared message data sets.
Db2: Offloaded large messages can exist in Db2.
BOTH: Offloaded large messages can exist both in shared message data sets and in Db2.

Connection status

For connection status, the following information is returned for each connection to each structure that satisfies the selection criteria:

The name of the application structure matching the generic name.
The type of information returned.

QMNAME (qmgrname)

The queue manager name.

SYSNAME (systemname)

The name of the z/OS image of the queue manager that last connected to the application structure. These can be different across queue managers depending on the customer configuration setup.

STATUS

A status indicating whether this queue manager is connected to this application structure. This is one of the following:

ACTIVE: The structure is connected to this queue manager.
FAILED: The queue manager connection to this structure has failed.
NONE: The structure has never been connected to this queue manager.
UNKNOWN: The status of the CF structure is not known.

FAILTIME (time)

The time that this queue manager lost connectivity to this application structure. The format of this field is hh.mm.ss. This parameter is only applicable when the CF structure is in FAILED state. If the structure is not in a failed state, this is displayed as FAILTIME().

FAILDATE (date)

The date that this queue manager lost connectivity to this application structure. The format of this field is yyyy-mm-dd. This parameter is only applicable when the CF structure is in FAILED state. If the structure is not in a failed state, this is displayed as FAILDATE().

Backup status

For backup status, the following information is returned for each structure that satisfies the selection criteria:

The name of the application structure matching the generic name.
The type of information returned.

STATUS

The status of the CF application structure. This is one of the following:

ACTIVE: The structure is active.
FAILED: The structure has failed.
NONE: The structure is defined as RECOVER(YES), but has never been backed up.
INBACKUP: The structure is in the process of being backed-up.
INRECOVER: The structure is in the process of being recovered.
UNKNOWN: The status of the CF structure is not known.

QMNAME (qmgrname)

The name of the queue manager that took the last successful backup for this application structure.

BKUPTIME (time)

The end time of the last successful backup taken for this application structure. The format of this field is hh.mm.ss.

BKUPDATE (date)

The date of the last successful backup taken for this application structure. The format of this field is yyyy-mm-dd.

BKUPSIZE (size)

The size in megabytes of the last successful backup taken for this application structure.

BKUPSRBA (hexadecimal)

This is the backup data set start RBA for the start of the last successful backup taken for this application structure.

BKUPERBA (hexadecimal)

This is the backup data set end RBA for the end of the last successful backup taken for this application structure.

LOGS (qmgrname-list)

This is the list of queue managers, the logs of which are required to perform a recovery.

FAILTIME (time)

The time that this CF structure failed. The format of this field is hh.mm.ss. This parameter is only applicable when the CF structure is in FAILED state. If the structure is not in a failed state, this is displayed as FAILTIME().

FAILDATE (date)

The date that this CF structure failed. The format of this field is yyyy-mm-dd. This parameter is only applicable when the CF structure is in FAILED state. If the structure is not in a failed state, this is displayed as FAILDATE().

SMDS status

The DISPLAY CFSTATUS command with TYPE(SMDS) displays status information relating to one or more shared message data sets associated with a specific application structure.

The following data is returned for each selected data set:

SMDS

The queue manager name which owns the shared message data set for which properties are being displayed

STATUS

The current status of the shared message data set. This is one of the following:

NOTFOUND: The data set has never been used, or the attempt to open it for the first time failed. Check and resolve any messages in the job log about this structure.
NEW: The data set is being opened and initialized for the first time, ready to be made active.
ACTIVE: The data set is available for normal use.
FAILED: The data set is in an unusable state and probably requires recovery.
INRECOVER: Data set recovery (using RECOVER CFSTRUCT) is in progress.
RECOVERED: The data set has been recovered or otherwise repaired, and is ready for use again, but requires some restart processing the next time it is opened. This restart processing ensures that obsolete references to any deleted messages have been removed from the coupling facility structure before the data set is made available again. The restart processing also rebuilds the data set space map.
EMPTY: The data set contains no messages. The data set is put into this state if it is closed normally by the owning queue manager at a time when it does not contain any messages. It can also be put into EMPTY state when the previous data set contents are to be discarded because the application structure has been emptied (using RECOVER CFSTRUCT with TYPE PURGE or, for a nonrecoverable structure only, by deleting the previous instance of the structure). The next time the data set is opened by its owning queue manager, the space map is reset to empty, and the status is changed to ACTIVE. As the previous data set contents are no longer required, a data set in this state can be replaced with a newly allocated data set, for example to change the space allocation or move it to another volume.

ACCESS

The current availability state of the shared message data set. This parameter is one of the following:

ENABLED

The data set can be used, and no error has been detected since the time that it was enabled. If the data set has STATUS(RECOVERED) it can only be opened by the owning queue manager for restart purposes, but if it has STATUS(ACTIVE) all queue managers can open it.

SUSPENDED

The data set is unavailable because of an error.

This occurs specifically when the STATUS is set to FAILED either because of an error accessing the data set, or using the ALTER SMDS command.

The queue manager can try to enable access again automatically if the error might no longer be present, for example when recovery completes, or if the status is manually set to RECOVERED. Otherwise, it can be enabled again by a command in order to retry the action which originally failed.

DISABLED

The shared message data set cannot be used because it has been explicitly disabled using a command. It can only be enabled again by using another command to enable it. For more information, see RESET SMDS (reset shared message data sets) on z/OS.

RCVDATE

The recovery start date.

If recovery is currently enabled for the data set, this indicates the date when it was activated, in the form yyyy-mm-dd. If recovery is not enabled, this is displayed as RCVDATE().

RCVTIME

The recovery start time.

If recovery is currently enabled for the data set, this indicates the time when it was activated, in the form hh.mm.ss. If recovery is not enabled, this is displayed as RCVTIME().

FAILDATE

The failure date.

If the data set was put into a failed state, and has not yet been restored to the active state, this indicates the date when the failure was indicated, in the form yyyy-mm-dd. If the data set is in the active state, this is displayed as FAILDATE().

FAILTIME

The failure time.

If the data set was put into a failed state and has not yet been restored to the active state, this indicates the time when the failure was indicated, in the form hh.mm.ss. If the data set is in the active state, this is displayed as FAILTIME().