Script (MQSC) Command Reference: DISPLAY CFSTATUS

DISPLAY CFSTATUS

Use DISPLAY CFSTATUS to display the status of one or more CF application structures. This command is valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.
Synonym: DIS CFSTATUS
DISPLAY CFSTATUS
 
>>-DISPLAY CFSTATUS(generic-structure-name)--------------------->
 
   .-TYPE(SUMMARY)-.
>--+---------------+-------------------------------------------><
   +-TYPE(CONNECT)-+
   '-TYPE(BACKUP)--'
 
 
Keyword and parameter descriptions

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.

TYPE

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

SUMMARY
Display summary status information for the 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.

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.

INBACKUP
The structure is in the process of being backed-up.

INRECOVER
The structure is in the process of being recovered.

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.

ENTSUSED(integer)
The number of CF list entries for this application structure that are in use.

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().

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 or not 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.

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.

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 dataset start RBA for the start of the last successful backup taken for this application structure.

BKUPERBA(hexadecimal)
This is the backup dataset end RBA for the end of the last successful backup taken for this application structure.

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().

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.