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