IMS Version 9

QUERY

Format

QUERY AREA

Read syntax diagramSkip visual syntax diagram                    .-NAME(*)-------------------.
>>-+-QUERY-+--AREA--+---------------------------+--+-----------------+-->
   '-QRY---'        |       .-,-------------.   |  '-OPTION(REFRESH)-'
                    |       V               |   |
                    '-NAME(---+-areaname--+-+-)-'
                              '-areaname*-'

>--+-------------------------+---------------------------------->
   |       .-,-----------.   |
   |       V             |   |
   '-SHOW(---+-ALL-----+-+-)-'
             +-CI------+
             +-STATUS--+
             '-UTILITY-'

>--+-------------------------------+---------------------------><
   |         .-,---------------.   |
   |         V                 |   |
   '-STATUS(---+-EEQE--------+-+-)-'
               +-IC----------+
               +-MAS---------+
               +-NOTOPEN-----+
               +-OFR---------+
               +-OPEN--------+
               +-PRELOAD-----+
               +-PREOPEN-----+
               +-RECALL------+
               +-RECOVERY----+
               +-RECOVNEEDED-+
               +-SAS---------+
               +-SHARED------+
               +-STOPPED-----+
               +-UTIL--------+
               '-VSO---------'

|QUERY DB | |

|
Read syntax diagramSkip visual syntax diagram|                  .-NAME(*)-----------------.
|>>-+-QUERY-+--DB--+-------------------------+------------------->
|   '-QRY---'      |       .-,-----------.   |
|                  |       V             |   |
|                  '-NAME(---+-dbname--+-+-)-'
|                            '-dbname*-'
|
|>--+-------------------------+--+---------------------------+--->
|   |       .-,-----------.   |  |         .-,-----------.   |
|   |       V             |   |  |         V             |   |
|   '-SHOW(---+-ALL-----+-+-)-'  '-STATUS(---+-ALLOCF--+-+-)-'
|             +-ACCTYPE-+                    +-ALLOCS--+
|             '-STATUS--'                    +-BACKOUT-+
|                                            +-EEQE----+
|                                            +-LOCK----+
|                                            +-NOTINIT-+
|                                            +-NOTOPEN-+
|                                            +-OFR-----+
|                                            +-OLR-----+
|                                            +-OPEN----+
|                                            +-RECALL--+
|                                            +-RECOV---+
|                                            +-RNL-----+
|                                            +-STOSCHD-+
|                                            '-STOUPDS-'
|
|>--+-------------------------+---------------------------------><
|   |       .-,-----------.   |
|   |       V             |   |
|   '-TYPE(---+-DEDB----+-+-)-'
|             +-DLI-----+
|             +-MSDB----+
|             +-PART----+
|             +-PHDAM---+
|             +-PHIDAM--+
|             '-PSINDEX-'
|
|

QUERY IMSPLEX

Read syntax diagramSkip visual syntax diagram                       .-NAME(*)----------------------.
>>-+-QUERY-+--IMSPLEX--+------------------------------+--------->
   '-QRY---'           |       .-,----------------.   |
                       |       V                  |   |
                       '-NAME(---+-imsplexname--+-+-)-'
                                 '-imsplexname*-'

>--+--------------------------------+--------------------------->
   |       .-,----------.           |
   |       V            |           |
   +-TYPE(---+-AOP----+-+-)---------+
   |         +-BATCH--+             |
   |         +-CQS----+             |
   |         +-DBRC---+             |
   |         +-IMS----+             |
   |         +-IMSCON-+             |
   |         +-OM-----+             |
   |         +-OTHER--+             |
   |         +-RM-----+             |
   |         '-SCI----'             |
   |         .-,----------------.   |
   |         V                  |   |
   '-STATUS(---+-ABENDED------+-+-)-'
               +-ACTIVE-------+
               +-NOTREACHABLE-+
               +-OLD----------+
               '-READY--------'

>--+-------------------------+---------------------------------><
   |       .-,-----------.   |
   |       V             |   |
   '-SHOW(---+-ALL-----+-+-)-'
             +-JOB-----+
             +-OS------+
             +-STATUS--+
             +-SUBTYPE-+
             +-TYPE----+
             '-VERSION-'

QUERY LE

Read syntax diagramSkip visual syntax diagram>>-+-QUERY-+--LE--+----------------+--+------------------+------>
   '-QRY---'      '-TRAN(tranname)-'  '-LTERM(ltermname)-'

>--+----------------+--+------------------+--------------------->
   '-USERID(userid)-'  '-PGM(programname)-'

            .-,-------------.
            V               |
>--SHOW--(----+-ALL-------+-+--)-------------------------------><
              +-LERUNOPTS-+
              +-LTERM-----+
              +-PGM-------+
              +-TRAN------+
              '-USERID----'

QUERY MEMBER

Read syntax diagramSkip visual syntax diagram                                        .-,----------.
                                        V            |
>>-+-QUERY-+--MEMBER--TYPE (IMS)--SHOW(---+-ALL----+-+-)-------><
   '-QRY---'                              +-ATTRIB-+
                                          +-MODID--+
                                          +-STATUS-+
                                          '-TYPE---'

QUERY OLC

Read syntax diagramSkip visual syntax diagram                                           .-,-----------.
                                           V             |
>>-+-QUERY-+--OLC--LIBRARY(OLCSTAT)--SHOW(---+-ACTVLIB-+-+-)---><
   '-QRY---'                                 +-ALL-----+
                                             +-DSN-----+
                                             +-LASTOLC-+
                                             +-MBRLIST-+
                                             '-MODID---'

|QUERY OLREORG | |

|
Read syntax diagramSkip visual syntax diagram||                       .-NAME(*)--------------.
|>>-+-QUERY-+--OLREORG--+----------------------+----------------->
|   '-QRY---'           |       .-,--------.   |
|                       |       V          |   |
|                       '-NAME(---partname-+-)-'
|
|>--+----------------------------+--+------------------------+--><
|   |         .-,------------.   |  |       .-,----------.   |
|   |         V              |   |  |       V .-STATUS-. |   |
|   '-STATUS(---+-RUNNING--+-+-)-'  '-SHOW(---+-ALL----+-+-)-'
|               +-OWNED----+                  +-RATE---+
|               +-NOTOWNED-+                  '-BYTES--'
|               '-UNKNOWN--'
|
||
|

QUERY STRUCTURE

Read syntax diagramSkip visual syntax diagram                         .-NAME(*)------------------------.
>>-+-QUERY-+--STRUCTURE--+--------------------------------+----->
   '-QRY---'             |       .-,------------------.   |
                         |       V                    |   |
                         '-NAME(---+-structurename--+-+-)-'
                                   '-structurename*-'

>--+----------------------------+------------------------------><
   |       .-,--------------.   |
   |       V                |   |
   '-SHOW(---+-ALL--------+-+-)-'
             +-STATISTICS-+
             '-TYPE-------'

QUERY TRAN

Read syntax diagramSkip visual syntax diagram                    .-NAME(*)-------------------.
>>-+-QUERY-+--TRAN--+---------------------------+--------------->
   '-QRY---'        |       .-,-------------.   |
                    |       V               |   |
                    '-NAME(---+-tranname--+-+-)-'
                              '-tranname*-'

>--+---------------------------+--+------------------------+---><
   |        .-,------------.   |  |       .-,----------.   |
   |        V              |   |  |       V            |   |
   +-CLASS(---class_number-+-)-+  '-SHOW(---+-AFFIN--+-+-)-'
   +-QCNT(-+-LT-+-,number)-----+            +-ALL----+
   |       +-LE-+              |            +-CLASS--+
   |       +-GT-+              |            +-CPRI---+
   |       +-GE-+              |            +-LCT----+
   |       +-EQ-+              |            +-LPRI---+
   |       '-NE-'              |            +-MAXRGN-+
   |         .-,-----------.   |            +-NPRI---+
   |         V             |   |            +-PARLIM-+
   '-STATUS(---+-BAL-----+-+-)-'            +-PLCT---+
               +-CONV----+                  +-PSB----+
               +-CPIC----+                  +-QCNT---+
               +-DYN-----+                  +-RGC----+
               +-FPE-----+                  +-SEGNO--+
               +-FPP-----+                  +-SEGSZ--+
               +-IOPREV--+                  '-STATUS-'
               +-LCK-----+
               +-QERR----+
               +-RMT-----+
               +-RESP----+
               +-SUSPEND-+
               +-STOQ----+
               +-STOSCHD-+
               +-TRACE---+
               '-USTO----'

Environments and Keywords

Table 88, Table 89, Table 90, Table 91, Table 92, Table 93, Table 94, Table 95, and Table 96 list the environments (DB/DC, DBCTL, and DCCTL) from which the QUERY command and keywords can be issued.

Table 88. Valid Environments for QUERY AREA Command and Keywords
|Command / Keyword |DB/DC |DBCTL |DCCTL
|QUERY AREA |X |X |
|NAME |X |X |
|OPTION |X |X |
|SHOW |X |X |
|STATUS |X |X |
Table 89. Valid Environments for QUERY DB Command and Keywords
|Command / Keyword |DB/DC |DBCTL |DCCTL
|QUERY DB |X |X |
|NAME |X |X |
|SHOW |X |X |
|STATUS |X |X |
|TYPE |X |X |
Table 90. Valid Environments for QUERY IMSPLEX Command and Keywords
Command / Keywords DB/DC DBCTL DCCTL
QUERY IMSPLEX 1
NAME
SHOW
STATUS
TYPE
Note:
  1. There are no environment indicators for the QUERY IMSPLEX command itself because it does not run in any IMS control or dependent region's address space. QUERY IMSPLEX is processed in an OM command processing environment.
Table 91. Valid Environments for the QUERY LE Command and Keywords
Command / Keywords DB/DC DBCTL DCCTL
QUERY LE X X X
LTERM X X X
PGM X X X
SHOW X X X
TRAN X X X
USERID X X X
Table 92. Valid Environments for the QUERY MEMBER Command and Keywords
Command / Keywords DB/DC DBCTL DCCTL
QUERY MEMBER X X X
ALL X X X
ATTRIB X X X
SHOW X X X
STATUS X X X
TYPE X X X
Table 93. Valid Environments for the QUERY OLC Command and Keywords
Command / Keywords DB/DC DBCTL DCCTL
QUERY OLC X X X
LIBRARY X X X
SHOW X X X
Table 94. Valid Environments for the QUERY OLREORG Command and Keywords
Command / Keywords DB/DC DBCTL DCCTL
OLREORG X X
NAME X X
STATUS X X
SHOW X X
Table 95. Valid Environments for the QUERY STRUCTURE Command and Keywords
Command / Keywords DB/DC DBCTL DCCTL
QUERY STRUCTURE 1
ALL
NAME
SHOW
STATISTICS
TYPE
Note:
  1. There are no environment indicators for the QUERY STRUCTURE command itself because it does not run in any IMS control or dependent region's address space. QUERY STRUCTURE is processed in an RM command processing environment.
Table 96. Valid Environments for the QUERY TRAN Command and Keywords
Command / Keywords DB/DC DBCTL DCCTL
QUERY TRAN X X
CLASS X X
NAME X X
QCNT X X
SHOW X X
STATUS X X
| | |

QUERY AREA

|

QUERY AREA is an IMSplex command that displays information about DEDB |areas and area data set information. The command can only be specified |through the Operations Manager (OM) API and can only be processed |by DB/DC and DBCTL environments. In addition, the QUERY AREA command is valid on the XRF alternate as well as the RSR tracker.

|

The command syntax for this command is defined in XML and is |available to automation programs which communicate with OM.

|
|
NAME()
|
Specifies the names of the specific areas that are to be processed |or the group of areas whose names match the generic or wildcard |parameter specified. | |

If the STATUS filter is not specified, all the area names that |match the NAME parameter are returned. The NAME keyword is optional |and the default is NAME(*).

|
|
OPTION()
|
Specifies the additional functions to be performed. | |

The filters supported with the OPTION keyword are: |

|
| |
REFRESH
|
|Refreshes the control interval information for |the sequential dependent space and the independent overflow part |of the direct addressable space for the area. OPTION(REFRESH) returns the CI information even if SHOW(CI) is not specified. OPTION(REFRESH) results in an I/O request that is performed only at the command |master IMS if the area is open at the master. If the command is |routed to multiple IMSs in the IMSplex, all non-master IMSs return |local CI information. The age of the local information shown on |the non-master IMS systems is at most as old as the value set on |the IOVFI=IMS control region parameter. | |

The CI information is returned only if the area is open at the |IMS. If the area is not open, blanks will be returned in the output |CI columns SDAT, SDAU, LDAT, and LDAU. If the area is not open at |the command master IMS, no refresh of the control intervals is performed. |The QRY AREA NAME(areaname) SHOW(CI) OPTION(REFRESH) must be routed to the IMS where the area is open to get the |current SDEP and IOVF CI information.

| |

If the default NAME(*) is used with the REFRESH keyword, or if |large numbers of areas are processed with the REFRESH keyword, performance |may be affected depending on the size and number of areas involved. |If large areas, numerous areas, or both are involved, the control |regions processing the command may appear stopped.

| |
| |
|
|
SHOW()
|
Specifies the area output fields to be returned. The area |name, the DEDB name, and the area data set information are always |returned along with the name of the IMS that created the output |for the area and the completion code. | |

The filters supported with the SHOW keyword are: |

|
|
ALL
|
Returns all the output fields. |
|
CI
|
Control intervals. | |

Returns the total and unused control intervals defined for the sequential |dependent space and the total and unused control intervals for the |independent overflow part of the direct addressable space.

|
|
STATUS
|
Local area status. | |

If the area has an EEQE status, the count of I/O errors or write |error EEQE for the area are also returned.

|
| |
UTILITY
|
Returns the utility information about the utility that has |the area open. The utility name, the total and available buffers |in the private pool, and the utility UOW are returned. |
| |
|
|
STATUS()
|
Selects areas for display that match the NAME parameter and |possess at least one of the specified area status. | |

This allows for additional filtering by area status. The output |returned when the STATUS filter is specified includes the status |of the area that caused the area name to be displayed even if the SHOW(STATUS) is not specified.

| |

Status parameters are the same as the value displayed in the QUERY AREA output.

|
|
| |

QUERY AREA Output Fields

|

Table 71 shows |the QUERY AREA output fields. The columns in the table are as follows: |

|
|
Short Label
|
Contains the short label generated in the XML output. |
|
Keyword
|
Identifies the keyword on the command that caused the field |to be generated. N/A appears for output fields that are always returned. |
|
Scope
|
Identifies the scope of the output field. |
|
Meaning
|
Provides a brief description of the output field. |
|
Table 97. Output Fields for QUERY AREA Command
|Short Label |Keyword |Scope |Meaning
|ADS |N/A |N/A |ADS name |
|The Area data set name or names associated with the |AREA.
|AREA |N/A |N/A |Area name |
|The Area name is always returned.
|CC |N/A |N/A |Completion code |
|The completion code indicates whether or not IMS was |able to process the command for the specified resource. The completion |code is always returned. See the return, reason, and completion |codes table for QUERY AREA.
|DB |N/A |N/A |DEDB name |
|The DEDB name associated with the Area.
|LDAT |CI |LCL |Local value of the total control intervals for |the independent overflow part of the direct addressable space. This |value only appears if the area is open.
|LDAU |CI |LCL |Local value of the unused control intervals for the |independent overflow part of the direct addressable space. This |value only appears if the area is open and the IOVF count ITASK |was not disabled when IOVFI=1 on the IMS Control Region startup |procedure was specified. When the command is processed on an RSR |tracking IMS system, no information will be returned. | |

This value is refreshed during command processing if OPTION(IOVF) |was entered on the QUERY AREA command. If OPTION(IOVF) was not specified, the value reflects |the updated value from the last IOVF count ITASK.

|LEQ |STATUS |LCL |Local value of the total control intervals for |the independent overflow part of the direct addressable space. This |value only appears if the area is open.
|LPBA |UTILITY |LCL |Available number of private buffers in private pool.
|LPBT |UTILITY |LCL |Total number of private buffers in private pool.
|LSDT |CI |LCL |Local value of the total control |intervals defined for the sequential dependent space. This value only |appears if the area is open and SDEPs have been defined.
|LSDU |CI |LCL |Local value of the unused control intervals defined |for the sequential dependent space. This value only appears if the |area is open, SDEPs have been defined, and unused SDEPs are available.
|LSTT |STATUS |LCL |Local area status |
|All area status conditions that apply are returned.
|LUOW |UTILITY |LCL |The current utility UOW for HSREORG and HSSP, |otherwise it is blank.
|LUTIL |UTILITY |LCL |Utility name that has area OPEN.
|MBR |N/A |N/A |IMSplex member that built the output line |
|IMS identifier of the IMS that built the output. The |IMS identifier is always returned.
| | |

QUERY AREA STATUS

|

Table 98 lists |the database status conditions that may be returned when SHOW(STATUS) is specified.

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Table 98. Status Conditions for QUERY AREA
Status Meaning
EEQE Area has EEQEs.
IC Area image copy is active.
MAS Area is on a multi-area structure.
NOTOPEN Area is not open.
OFR Area has online forward recovery in progress |to bring it up to current tracking level.
OPEN Area is open.
PRELOAD Area is defined to be preloaded.
PREOPEN Area is defined to be preopened.
RECALL Area is in recall.
RECOVERY Area recovery in progress.
RECOVNEEDED Area needs recovery.
SAS Area is on a single area structure.
SHARED Area is shared.
STOPPED Area is stopped.
UTIL Area is open by a utility.
VSO Area is a VSO area.
|

The following table, Table 99, |lists the ADS status conditions that can be returned for an ADS |associated with an AREA when SHOW(STATUS) is specified.

| |||||||||||||||||||||||||||||||||||
Table 99. ADS Status Conditions for QUERY AREA
Status Meaning
COPY-PHASE The CREATE utility is active on this ADS and |is in the COPY phase. The CREATE utility must complete before any |action can be processed for the ADS.
FORMAT-PHASE The CREATE utility is active on this ADS and |is in the FORMAT phase. The CREATE utility must complete before |any action can be processed for the ADS.
LONGBUSY Area in long busy state or long busy recovery |mode.
PREOPEN-FAIL XRF PREOPEN failed for this ADS.
SEVERE-ERROR The ADS had a severe I/O error (write error to |2nd CI).
UNAVAIL The ADS is marked unavailable due to I/O errors.
| |

Return, Reason, and Completion Codes for the QUERY AREA Command

|

An IMS return and reason code is returned |to OM by the QUERY AREA command. The OM return and reason codes that may be returned |as a result of the QUERY AREA command are standard for all commands entered through the |OM API. See IMS Version 9: Common Service Layer Guide and Reference for a list of the |OM codes and the code meanings.

|

Table 72 includes the return |and reason codes and a brief explanation of the QUERY AREA command. Table 101 includes |an explanation of the completion codes. Errors unique to the processing |of QUERY AREA command are returned as completion codes. A completion code |is returned for each action against an individual resource.

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Table 100. Return and Reason Code for the QUERY AREA Command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY AREA command completed successfully.
|X'00000008' X'0000200C' The QUERY AREA command is not processed because no resources matched any |status specified on the STATUS( ) keyword.
X'00000008' X'00002014' The QUERY AREA command is not processed because in invalid character is |found in the area name parameter.
X'00000008' X'00002040' More than one filter or keyword value is specified |on the QUERY AREA command. Either more than one keyword or an invalid combination |of filters was specified. Check the input command and reenter the correct |combinations.
X'0000000C' X'00003000' The QUERY AREA command was successful for at least one resource name. The QUERY AREA command was not successful for one or more resource names. |The completion code indicates the reason for the error with the |resource name. The completion codes that can be returned by the QUERY AREA command are listed in the QUERY AREA Completion Code table.
X'0000000C' X'00003004' The QUERY AREA command was not successful for all the resource name(s) specified. |The completion code indicates the reason for the error with the |resource name. The completion codes that can be returned by the QUERY AREA command are listed in the QUERY AREA completion code table.
|X'00000010' X'00004024' The QUERY AREA command cannot be processed on a non-Fast Path system.
X'00000014' X'00005004' The QUERY AREA command processing terminated as a DFSOCMD response buffer |could not be obtained.
X'00000014' X'00005FFF' The QUERY AREA command processing terminated due to an internal error.
| |||||||||||||||||||
Table 101. Completion Codes for the QUERY AREA Command
Completion Code Meaning
0 The QUERY AREA command completed successfully for the resource.
10 Resource not found |
|The resource name is unknown to the client that is processing |the request. The resource name may have been typed in error or the resource |may not be active at this time. Confirm that the correct spelling |of the resource name is specified on the command.
| |

QUERY AREA Compared to Other Commands

|

Table 102 shows different instances of the QUERY AREA command and other IMS commands that perform similar functions.

| |||||||||||||||
Table 102. QUERY AREA Compared to Similar IMS Commands
QUERY AREA Command SImilar IMS Command
QUERY AREA /DIS AREA area1...arean | ALL, /DIS STATUS AREA
| |

Examples for QUERY AREA Command

|

This section provides |OM API and TSO SPOC input and output examples and explanations for |the QUERY command.

| | |

Example 1 for QUERY AREA

|

|

TSO SPOC input: |

|
QRY AREA NAME(DB21AR10) SHOW(STATUS,CI)
|

TSO SPOC output: |

|
AreaName ADSName  MbrName  DBName     CC  SDep-T  SDep-U   Dir-T Dir-U EQCnt LclStat
|DB21AR0           IMS2     DEDBJN21    0                                     PREOPEN,NOTOPEN
|DB21AR0           SYS3     DEDBJN21    0    1303    1302   74    74          PREOPEN,OPEN,SHARED
|DB21AR0  DB21AR01 SYS3                 0                               10
|DB21AR0  DB21AR02 SYS3                 0                               10
|

OM API input: |

|
CMD(QRY AREA NAME(DB21AR10) SHOW(STATUS,CI))
|

OM API output: |

|
<imsout>
|<ctl>
|<omname>OM1OM   </omname>
|<omvsn>1.2.0</omvsn>
|<xmlvsn>1   </xmlvsn>
|<statime>2003.132 16:10:52.861123</statime>
|<stotime>2003.132 16:10:52.862301</stotime>
|<staseq>B968A1B61BEC302F</staseq>
|<stoseq>B968A1B61C35D38E</stoseq>
|<rqsttkn1>USRT005 10091052</rqsttkn1>
|<rc>00000000</rc>
|<rsn>00000000</rsn>
|</ctl>
|<cmd>
|<master>IMS2    </master>
|<userid>USRT005 </userid>
|<verb>QRY </verb>
|<kwd>AREA            </kwd>
|<input>QRY AREA NAME(DB21AR0) SHOW(CI,STATUS) </input>
|</cmd>
|<cmdrsphdr>
|<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="1"
| scroll="no" len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="ADS" llbl="ADSName" scope="LCL" sort="a" key="2" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="3" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="DB" llbl="DBName" scope="LCL" sort="n" key="0" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes"
| len="4" dtype="INT" align="right" skipb="no" />
|<hdr slbl="LSDT" llbl="SDep-T" scope="LCL" sort="n" key="0"
| scroll="yes" len="7" dtype="INT" align="right" skipb="no" />
|<hdr slbl="LSDU" llbl="SDep-U" scope="LCL" sort="n" key="0"
| scroll="yes" len="7" dtype="INT" align="right" skipb="no" />
|<hdr slbl="LDAT" llbl="Dir-T" scope="LCL" sort="n" key="0" scroll="yes"
| len="7" dtype="INT" align="right" skipb="no" />
|<hdr slbl="LDAU" llbl="Dir-U" scope="LCL" sort="n" key="0" scroll="yes"
| len="7" dtype="INT" align="right" skipb="no" />
|<hdr slbl="LEQ" llbl="EQCnt" scope="LCL" sort="n" key="0" scroll="yes" 
| len="5" dtype="INT" align="right" skipb="yes" />
|<hdr slbl="LSTT" llbl="LclStat" scope="LCL" sort="n" key="0"
| scroll="yes" len="*" dtype="CHAR" align="left" skipb="no" />
|</cmdrsphdr>
|<cmdrspdata>
|<rsp>AREA(DB21AR0 ) MBR(IMS2    ) DB(DEDBJN21) CC(   0) LSDT( ) LSDU( )
| LDAT( ) LDAU( ) LSTT(PREOPEN,NOTOPEN) </rsp>
|<rsp>AREA(DB21AR0 ) MBR(SYS3    ) DB(DEDBJN21) CC(   0) LSDT(   1303)
| LSDU(   1302) LDAT(     74) LDAU(     74) LSTT(PREOPEN,OPEN,SHARED) 
|</rsp>
|<rsp>AREA(DB21AR0 ) ADS(DB21AR01) MBR(SYS3    ) DB( ) CC(   0) LEQ(  10) </rsp>
|<rsp>AREA(DB21AR0 ) ADS(DB21AR02) MBR(SYS3    ) DB( ) CC(   0) LEQ(  10) </rsp>
|</cmdrspdata>
|</imsout>
|

Explanation: The command returns the CI and STATUS information |for the area, DB21AR0, from all the IMSs in the IMSPlex. Any ADS |information, if available, is also returned by each IMS.

|| | |

Example 2 for QUERY AREA Command

|

|

TSO SPOC input: |

|
QRY AREA NAME(DB21AR1*) STATUS(SHARED)
|

TSO SPOC output: |

|
Log for . . : QRY AREA NAME(DB21AR1*) STATUS(SHARED)
|IMSplex . . . . . : PLEX1
|Routing . . . . . :
|Start time. . . . : 2003.132 09:13:37.93
|Stop time . . . . : 2003.132 09:13:37.94
|Return code . . . : 0200000C
|Reason code . . . : 00003000
|Command master. . : IMS2
|
|                Return     Reason
|MbrName     Code       Code
|--------    ------     ------ 
|IMS2        00000008   0000200C
|
|AreaName ADSName  MbrName  DBName     CC EQCnt LclStat
|DB21AR10          SYS3     DEDBJN21    0       PREOPEN,OPEN,SHARED
|DB21AR10 DB21AR10 SYS3                 0    10 
|DB21AR11          SYS3     DEDBJN21    0       PREOPEN,OPEN,SHARED
|DB21AR11 DB21AR11 SYS3                 0    10 
|

OM API input: |

|
CMD(QRY AREA NAME(DB21AR1*) STATUS(SHARED))
|

OM API output: |

|
<imsout>
|<ctl>
|<omname>OM1OM   </omname>
|<omvsn>1.2.0</omvsn>
|<xmlvsn>1   </xmlvsn>
|<statime>2003.132 16:13:37.940282</statime>
|<stotime>2003.132 16:13:37.940959</stotime>
|<staseq>B968A2538A73A707</staseq>
|<stoseq>B968A2538A9DF027</stoseq>
|<rqsttkn1>USRT005 10091337</rqsttkn1>
|<rc>0200000C</rc>
|<rsn>00003000</rsn> 
|</ctl>
|<cmderr>
|<mbr name="IMS2    ">
|<typ>IMS     </typ>
|<styp>DBDC    </styp>
|<rc>00000008</rc>
|<rsn>0000200C</rsn>
|</mbr>
|</cmderr>
|<cmd>
|<master>IMS2    </master>
|<userid>USRT005 </userid>
|<verb>QRY </verb>
|<kwd>AREA            </kwd>
|<input>QRY AREA NAME(DB21AR1*) STATUS(SHARED) </input>
|</cmd>
|<cmdrsphdr>
|<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="1"
| scroll="no" len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="ADS" llbl="ADSName" scope="LCL" sort="a" key="2" scroll="no" 
| len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="3" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="DB" llbl="DBName" scope="LCL" sort="n" key="0" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes"
| len="4" dtype="INT" align="right" skipb="no" />
|<hdr slbl="LEQ" llbl="EQCnt" scope="LCL" sort="n" key="0" scroll="yes"
| len="5" dtype="INT" align="right" skipb="yes" />
|<hdr slbl="LSTT" llbl="LclStat" scope="LCL" sort="n" key="0"
| scroll="yes" len="*" dtype="CHAR" align="left" skipb="no" />
|</cmdrsphdr>
|<cmdrspdata>
|<rsp>AREA(DB21AR10) MBR(SYS3    ) DB(DEDBJN21) CC(   0)
| LSTT(PREOPEN,OPEN,SHARED) </rsp>
|<rsp>AREA(DB21AR10) ADS(DB21AR10) MBR(SYS3    ) DB( ) CC(   0) LEQ( 10) </rsp>
|<rsp>AREA(DB21AR11) MBR(SYS3    ) DB(DEDBJN21) CC(   0)
| LSTT(PREOPEN,OPEN,SHARED) </rsp>
|<rsp>AREA(DB21AR11) ADS(DB21AR11) MBR(SYS3    ) DB( ) CC(   0) LEQ( 10) </rsp>
|</cmdrspdata>
|</imsout>
|

Explanation: The command returns all the areas that match the |wildcard name and have a status of SHARED. The status is also returned. |The ADS information for the AREAs is also returned if it is available. |Command response lines are not returned from IMS2 because no AREAs |match the status specified. A return and reason code is returned |from IMS2.

|| | |

QUERY DB

|

QUERY DB is an IMSplex command that displays information about databases. |The command can only be specified through the OM API and can only |be processed in DB/DC and DBCTL environments. In addition, QUERY DB is valid on the XRF alternate as well as the RSR tracker.

|

The command syntax for QUERY DB is defined in XML and is available to automation programs |which communicate with OM.

|
|
NAME()
|
Specifies the names of the specific databases that are to |be processed or indicates that the command is to be applied to all |the databases in the system. NAME(*) is the default. | |

If the STATUS filter is not specified, all the database names |that match the NAME parameter are returned.

| |

Wildcard parameters can be specified. The database names that |match the generic or wildcard parameters are processed. Response |lines are returned for all the databases names that are processed.

| |

The database name specified can be a HALDB master or a HALDB |partition. If the database name is the HALDB master, response lines |are returned for the HALDB master and all of its partitions. If |the database name is the HALDB partition, response lines are returned |for the HALDB master and the partition name if the HALDB master |has not been taken offline.

| |

If the database name specified is a DEDB name, response lines |are returned for the DEDB name and all the DEDB areas.

|
|
SHOW()
|
Specifies the database output fields to be returned. The database |name and type are always returned along with the name of the IMS |that created the output for the database and the completion code. |The filters supported with the SHOW keyword are: | |
|
ALL
|
Returns all the output fields. |
|
ACCTYP
|
Type of access to database which can be one of the following: | |
    |
  • BRWS - Read only
  • |
  • EXCL - Exclusive
  • |
  • READ - Read
  • |
  • UPD - Update
|
|
STATUS
|
Local database status. |
|
|
|
STATUS()
|
Selects databases for display that match the NAME parameter |and possess at least one of the specified database status. This |allows for additional filtering by database status. | |

The output returned when the STATUS filter is specified includes |the status of the database that caused the database name to be displayed |even if the SHOW(STATUS) is not specified.

| |

Status parameters are the same as the value displayed in the QUERY DB output.

|
| |
TYPE()
|
Selects databases for display that match the NAME parameter |and specific TYPE filter. The supported TYPE filters are: | | | |

TYPE can be specified with the STATUS filter. If both TYPE and |STATUS filters are specified, a response line is returned for each |database that matches the NAME parameter, the TYPE, and STATUS filter |specified.

|
| |
| |

QUERY DB Output Fields

|

Table 103 shows the QUERY DB output fields. The columns in the table are as follows: |

|
|
Short Label
|
Contains the short label generated in the XML output. |
|
Keyword
|
Identifies the keyword on the command that caused the field |to be generated. N/A appears for output fields that are always returned. |
|
Scope
|
Identifies the scope of the output field. |
|
Meaning
|
Provides a brief description of the output field. |
|
Table 103. Output Fields for QUERY DB Command
|Short Label |Keyword |Scope |Meaning
|AREA |N/A |N/A |Area name. The Area name is returned if there are |one or more response lines for DEDB areas in the output.
|CC |N/A |N/A |Completion code. The completion code indicates whether |or not IMS was able to process the command for the specified resource. |The completion code is always returned. Refer to the return, reason, |and completion codes for QUERY DB.
|DB |N/A |N/A |Database name. The database name is always returned.
|LACC |ACCTYP |LCL |Type of access to database which can be one of the |following: | |
    |
  • BRWS - Read only
  • |
  • EXCL - Exclusive
  • |
  • READ - Read
  • |
  • UPD - Update
|LSTT |STATUS |LCL |Local database status. All database status conditions |that apply are returned.
|MBR |N/A |N/A |IMSplex member that built the output line. The IMS |identifier of the IMS that built the output. The IMS identifier |is always returned.
|PART |N/A |N/A |HALDB partition name. The partition name is returned |if there is one or more response lines for HALDB partitions in the |output.
|TYP |N/A |N/A |The type of the database. | |
    |
  • AREA - indicates the response line is for a DEDB area
  • |
  • blank - if database status is NOTINIT
  • |
  • DEDB - indicates the database is a DEDB
  • |
  • DL/I - indicates the database is a full function non-partitioned |database
  • |
  • MSNR - indicates the database is an MSDB non-related database
  • |
  • MSRD - indicates the database is an MSDB related dynamic database
  • |
  • MSRF - indicates the database is an MSDB related fixed database
  • |
  • PART - indicates the database is a HALDB partition
  • |
  • PHDAM - indicates the database is the master of a partitioned |HDAM database
  • |
  • PHIDAM - indicates the database is the master of a Partitioned |HIDAM database
  • |
  • PSINDEX - indicates the database is the master of a partitioned |secondary index database
| | |

QUERY DB Status

|

Table 104 lists |the database status conditions that may be returned when SHOW(STATUS) is specified.

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Table 104. Database Status Conditions for the QUERY DB Command
Status Meaning
ALLOCF Database has an allocation failure.
ALLOCS Database is allocated successfully.
BACKOUT Incomplete backout exists for the database which |prevents the use of the database.
EEQE One or more extended error queue elements exist |for the database.
LOCK Database is locked.
NOTINIT Database directory initialization failed.
NOTOPEN Database is not open.
OFR Database has online forward recovery in progress |to bring it up to current tracking level.
|OLR Database partition has Online Reorganization |in progress locally.
OPEN Database is open.
|RECALL Database recall is in progress.
RECOV Database recovery is in progress.
|RNL Randomizer not loaded for the DEDB database.
STOSCHD Database scheduling is stopped.
STOUPDS Database updates are stopped because an UPDATE DB STOP(UPDATES) command or a /DBDUMP DATABASE command was issued.
| |

Return, Reason, and Completion Codes for the QUERY DB Command

|

An |IMS return and reason code is returned to OM by the QUERY DB command. The OM return and reason codes that may be returned |as a result of the QUERY DB command are standard for all commands entered through the |OM API. See IMS Version 9: Common Service Layer Guide and Reference for a list of the |OM codes and the code meanings.

|

Table 105 includes the return |and reason codes and a brief explanation of the QUERY DB command. Table 106 includes |an explanation of the completion codes. Errors unique to the processing |of QUERY DB command are returned as completion codes. A completion code |is returned for each action against an individual resource.

| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Table 105. Return and Reason Codes for the QUERY DB Command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY DB command completed successfully.
|X'00000004' X'00001010' The QUERY DB command is not processed because no resources were found |that matched the NAME parameter and the STATUS or TYPE filter.
X'00000008' X'00002014' The QUERY DB command is not processed because an invalid character is |found in the database name parameter.
X'00000008' X'00002040' More than one filter or keyword value is specified |on the QUERY DB command. Either more than one keyword or an invalid combination |of filters was specified. Check the input command and reenter the |correct combinations.
X'0000000C' X'00003000' The QUERY DB command was successful for at least one resource name. The QUERY DB command was not successful for one or more resource names. |The completion code indicates the reason for the error with the |resource name. The completion codes that can be returned by the QUERY DB command are listed in the QUERY DB completion code table.
X'0000000C' X'00003004' The QUERY DB command was not successful for all the resource name(s) specified. |The completion code indicates the reason for the error with the |resource name. The completion codes that can be returned by the QUERY DB command are listed in the QUERY DB completion code table.
X'00000014' X'00005004' The QUERY DB command processing terminated as a DFSOCMD response buffer |could not be obtained.
X'00000014' X'00005FFF' The QUERY DB command processing terminated due to an internal error.
| |||||||||||||||||||
Table 106. Completion Codes for the QUERY DB Command
Completion Code Meaning
0 The QUERY DB command completed successfully for the resource.
10 Resource not found |
|The resource name is unknown to the client that is processing |the request. The resource name may have been typed in error or the resource |may not be active at this time. Confirm the correct spelling of the |resource name specified on the command.
| |

QUERY DB Compared to Other Commands

|

Table 107 shows different instances |of the QUERY DB command and other IMS commands that perform similar functions.

| |||||||||||||||
Table 107. QUERY DB Command Compared to Similar Commands
QUERY DB Command Similar IMS Commands
QUERY DB /DIS DB dbname1...dbnamen | ALL, /DIS STATUS DB
| |

Examples for QUERY DB Command

|

This section provides |OM API and TSO SPOC input and output examples and explanations for |the QUERY command.

| | |

Example 1 for QUERY DB Command

|

|

TSO SPOC input: |

|
QRY DB NAME(BE3PARTS,DEDBJN21,DBHDOJ01) SHOW(ALL)
|

TSO SPOC output: |

|
DBName   AreaName PartName MbrName    CC TYPE     LAcc LclStat
|BE3PARTS                   IMSA        0 DL/I     UPD  NOTOPEN
|BE3PARTS                   IMS1        0 DL/I     EXCL NOTOPEN 
|DBHDOJ01                   IMSA        0 PHDAM    UPD          
|DBHDOJ01          PDHDOJA  IMSA        0 PART     UPD  NOTOPEN
|DBHDOJ01          PDHDOJB  IMSA        0 PART     UPD  NOTOPEN
|DBHDOJ01                   IMS1        0 PHDAM    UPD         
|DBHDOJ01          PDHDOJA  IMS1        0 PART     UPD  NOTOPEN
|DBHDOJ01          PDHDOJB  IMS1        0 PART     UPD  NOTOPEN
|DEDBJN21                   IMSA        0 DEDB     UPD  NOTOPEN
|DEDBJN21 DB21AR0           IMSA        0 AREA          NOTOPEN
|DEDBJN21 DB21AR1           IMSA        0 AREA          NOTOPEN
|DEDBJN21                   IMS1        0 DEDB     UPD  NOTOPEN
|DEDBJN21 DB21AR0           IMS1        0 AREA          NOTOPEN
|DEDBJN21 DB21AR1           IMS1        0 AREA          NOTOPEN
|

OM API input: |

|
CMD (QRY DB NAME(BE3PARTS,DEDBJN21,DBHDOJ01) SHOW(ALL))
|

OM API output: |

|
<imsout>
|<ctl>
|<omname>OM1OM   </omname>
|<omvsn>1.2.0</omvsn>
|<xmlvsn>1   </xmlvsn>
|<statime>2003.128 19:20:29.755526</statime>
|<stotime>2003.128 19:20:29.756748</stotime>
|<staseq>B963C4A21E086F82</staseq>
|<stoseq>B963C4A21E54C862</stoseq>
|<rqsttkn1>USRT005 10122029</rqsttkn1>
|<rc>00000000</rc>
|<rsn>00000000</rsn>
|</ctl>
|<cmd>
|<master>IMSA    </master>
|<userid>USRT005 </userid>
|<verb>QRY </verb>
|<kwd>DB              </kwd>
|<input>QRY DB NAME(BE3PARTS,DEDBJN21,DBHDOJ01) SHOW(ALL) </input>
|</cmd>
|<cmdrsphdr>
|<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="3"
| scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="PART" llbl="PartName" scope="LCL" sort="a" key="4"
| scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes"
| len="4" dtype="INT" align="right" skipb="no" />
|<hdr slbl="TYP" llbl="TYPE" scope="LCL" sort="n" key="0" scroll="yes"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="LACC" llbl="LAcc" scope="LCL" sort="n" key="0" scroll="yes"
| len="*" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="LSTT" llbl="LclStat" scope="LCL" sort="n" key="0"
| scroll="yes" len="*" dtype="CHAR" align="left" skipb="no" />
|</cmdrsphdr>
|<cmdrspdata>
|<rsp>DB(BE3PARTS)MBR(IMSA    ) CC(   0) TYP(DL/I    ) LACC(UPD)
| LSTT(NOTOPEN) </rsp>
|<rsp>DB(DEDBJN21)MBR(IMSA    ) CC(   0) TYP(DEDB    ) LACC(UPD)
| LSTT(NOTOPEN) </rsp>
|<rsp>DB(DEDBJN21)AREA(DB21AR0 ) MBR(IMSA    ) CC(   0) TYP(AREA)
| LSTT(NOTOPEN) </rsp>
|<rsp>DB(DEDBJN21)AREA(DB21AR1 ) MBR(IMSA    ) CC(   0) TYP(AREA)
| LSTT(NOTOPEN) </rsp>
|<rsp>DB(DBHDOJ01)MBR(IMSA    ) CC(   0) TYP(PHDAM   ) LACC(UPD) </rsp>
|<rsp>DB(DBHDOJ01)PART(PDHDOJA ) MBR(IMSA    ) CC(   0) TYP(PART) LACC(UPD) LSTT(NOTOPEN) </rsp>
|<rsp>DB(DBHDOJ01)PART(PDHDOJB ) MBR(IMSA    ) CC(   0) TYP(PART)
| LACC(UPD) LSTT(NOTOPEN) </rsp>
|<rsp>DB(BE3PARTS)MBR(IMS1    ) CC(   0) TYP(DL/I    ) LACC(EXCL)
|<rsp>DB(DEDBJN21)MBR(IMS1    ) CC(   0) TYP(DEDB    ) LACC(UPD)
| LSTT(NOTOPEN) </rsp>
|<rsp>DB(DEDBJN21)AREA(DB21AR0 ) MBR(IMS1    ) CC(   0) TYP(AREA)
| LSTT(NOTOPEN) </rsp>
|<rsp>DB(DEDBJN21)AREA(DB21AR1 ) MBR(IMS1    ) CC(   0) TYP(AREA)
| LSTT(NOTOPEN) </rsp>
|<rsp>DB(DBHDOJ01)MBR(IMS1    ) CC(   0) TYP(PHDAM   ) LACC(UPD) </rsp>
|<rsp>DB(DBHDOJ01)PART(PDHDOJA ) MBR(IMS1    ) CC(   0) TYP(PART)
| LACC(UPD) LSTT(NOTOPEN) </rsp> 
|<rsp>DB(DBHDOJ01)PART(PDHDOJB ) MBR(IMS1    ) CC(   0) TYP(PART)
| LACC(UPD) LSTT(NOTOPEN) </rsp>
|</cmdrspdata>
|</imsout>
|

Explanation: The QRY DB NAME(BE3PARTS,DEDBJN21,DBHDOJ01) SHOW(ALL) command returns all the information for the databases BE3PARTS, |DEDBJN21 and DBHDOJ01. The database DEDBJN21 is a DEDB and so the |DEDB database and all its areas are also returned. The database |DBHDOJ01 is a partitioned HDAM database master and so the master |database and all its partition are returned.

|| | |

Example 2 for QUERY DB

|

|

TSO SPOC input: |

|
QRY DB TYPE(PSINDEX)
|

TSO SPOC output: |

|
DBName   PartName MbrName    CC TYPE 
|D2XHDJ05          IMSA        0 PSINDEX
|D2XHDJ05 P2XHDJA  IMSA        0 PART
|D2XHDJ05          IMS1        0 PSINDEX
|D2XHDJ05 P2XHDJA  IMS1        0 PART
|D2XHIDK5          IMSA        0 PSINDEX
|D2XHIDK5 P2XIDKA  IMSA        0 PART
|D2XHIDK5          IMS1        0 PSINDEX
|D2XHIDK5 P2XIDKA  IMS1        0 PART
|

OM API input: |

|
CMD(QRY DB TYPE(PSINDEX))
|

OM API output: |

|
<imsout>
|<ctl>
|<omname>OM1OM   </omname>
|<omvsn>1.2.0</omvsn>
|<xmlvsn>1   </xmlvsn> 
|<statime>2003.128 19:36:03.155700</statime>
|<stotime>2003.128 19:36:03.157109</stotime>
|<staseq>B963C81C46EF4688</staseq>
|<stoseq>B963C81C47475E88</stoseq>
|<rqsttkn1>USRT005 10123603</rqsttkn1>
|<rc>00000000</rc>
|<rsn>00000000</rsn>
|</ctl>
|<cmd>
|<master>IMSA    </master>
|<userid>USRT005 </userid>
|<verb>QRY </verb>
|<kwd>DB              </kwd>
|<input>QRY DB TYPE(PSINDEX) </input>
|</cmd>
|<cmdrsphdr>
|<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no"
|len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="3"
|scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="PART" llbl="PartName" scope="LCL" sort="a" key="4"
|scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no"
|len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes"
|len="4" dtype="INT" align="right" skipb="no" />
|<hdr slbl="TYP" llbl="TYPE" scope="LCL" sort="n" key="0" scroll="yes"
|len="8" dtype="CHAR" align="left" skipb="no" />
|</cmdrsphdr>
|<cmdrspdata>
|<rsp>DB(D2XHDJ05)MBR(IMSA    ) CC(   0) TYP(PSINDEX ) </rsp>
|<rsp>DB(D2XHDJ05)PART(P2XHDJA ) MBR(IMSA    ) CC(   0) TYP(PART) </rsp>
|<rsp>DB(D2XHIDK5)MBR(IMSA    ) CC(   0) TYP(PSINDEX ) </rsp>
|<rsp>DB(D2XHIDK5)PART(P2XIDKA ) MBR(IMSA    ) CC(   0) TYP(PART) </rsp>
|<rsp>DB(D2XHDJ05)MBR(IMS1    ) CC(   0) TYP(PSINDEX ) </rsp>
|<rsp>DB(D2XHDJ05)PART(P2XHDJA ) MBR(IMS1    ) CC(   0) TYP(PART) </rsp>
|<rsp>DB(D2XHIDK5)MBR(IMS1    ) CC(   0) TYP(PSINDEX ) </rsp>
|<rsp>DB(D2XHIDK5)PART(P2XIDKA ) MBR(IMS1    ) CC(   0) TYP(PART) </rsp>
|</cmdrspdata> 
|</imsout>
|

Explanation: The QRY DB TYPE(PSINDEX) command returns information of all the databases defined |as TYPE(PSINDEX). The master database name and all its partitions along with |the completion code, the IMS that processed the command, and the database |type are returned.

|| | |

Example 3 of QUERY DB

|

|

TSO SPOC input: |

|
QRY DB STATUS(STOUPDS)
|

TSO SPOC output: |

|
DBName   PartName MbrName    CC TYPE     LclStat
|BANKATMS          IMS1        0          NOTINIT,NOTOPEN,STOSCHD,STOUPDS
|DBHDOJ01 PDHDOJA  IMSA        0 PART     NOTOPEN,STOUPDS
|DBHDOJ01 PDHDOJA  IMS1        0 PART     NOTOPEN,STOUPDS
|

OM API input: |

|
CMD(QRY DB STATUS(STOUPDS))
|

OM API output: |

|
<imsout>
|<ctl>
|<omname>OM1OM   </omname>
|<omvsn>1.2.0</omvsn>
|<xmlvsn>1   </xmlvsn>
|<statime>2003.128 20:00:38.874790</statime>
|<stotime>2003.128 20:00:38.876039</stotime>
|<staseq>B963CD9BA1EA6F66</staseq>
|<stoseq>B963CD9BA238752D</stoseq>
|<rqsttkn1>USRT005 10130038</rqsttkn1>
|<rc>00000000</rc>
|<rsn>00000000</rsn>
|</ctl>
|<cmd>
|<master>IMSA    </master>
|<userid>USRT005 </userid>
|<verb>QRY </verb>
|<kwd>DB              </kwd>
|<input>QRY DB STATUS(STOUPDS) </input>
|</cmd>
|<cmdrsphdr>
|<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="3"
| scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="PART" llbl="PartName" scope="LCL" sort="a" key="4" 
| scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes"
| len="4" dtype="INT" align="right" skipb="no" />
|<hdr slbl="TYP" llbl="TYPE" scope="LCL" sort="n" key="0" scroll="yes"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="LSTT" llbl="LclStat" scope="LCL" sort="n" key="0"
| scroll="yes" len="*" dtype="CHAR" align="left" skipb="no" />
|</cmdrsphdr>
|<cmdrspdata>
|<rsp>DB(DBHDOJ01)PART(PDHDOJA ) MBR(IMSA    ) CC(   0) TYP(PART    )
| LSTT(NOTOPEN,STOUPDS) </rsp>
|<rsp>DB(BANKATMS)MBR(IMS1    ) CC(   0) TYP(        )
| LSTT(NOTINIT,NOTOPEN,STOSCHD,STOUPDS) </rsp>
|<rsp>DB(DBHDOJ01)PART(PDHDOJA ) MBR(IMS1    ) CC(   0) TYP(PART    )
| LSTT(NOTOPEN,STOUPDS) </rsp>
|</cmdrspdata>
|</imsout>
|

Explanation: The QRY DB STATUS(STOUPDS) command returns information of all the databases that have |the status STOUPDS. The database name, the completion code, the |IMS that processed the command, and the database status are returned. |Because the database, PDHDOJA, is a partition database that has |the STOUPDS status, the HALDB master name is also returned in the |DBNAME column.

|| | |

Example 4 for QUERY DB

|

|

TSO SPOC input: |

|
QRY DB  NAME(PDHDOJA,PDHDOKA)
|

TSO SPOC output: |

|
DBName   PartName MbrName    CC TYPE
|         PDHDOJA  IMSA        0 PART
|         PDHDOJA  IMS1        0 PART
|DBHDOK01 PDHDOKA  IMSA        0 PART
|DBHDOK01 PDHDOKA  IMS1        0 PART
|

OM API input: |

|
CMD(QRY DB  NAME(PDHDOJA,PDHDOKA))
|

OM API output: |

|
<imsout>
|<ctl>
|<omname>OM1OM   </omname>
|<omvsn>1.2.0</omvsn>
|<xmlvsn>1   </xmlvsn>
|<statime>2003.128 20:31:10.151252</statime>
|<stotime>2003.128 20:31:10.152706</stotime>
|<staseq>B963D46E12E54D25</staseq>
|<stoseq>B963D46E13402A48</stoseq>
|<rqsttkn1>USRT005 10133110</rqsttkn1>
|<rc>00000000</rc>
|<rsn>00000000</rsn>
|</ctl>
|<cmd>
|<master>IMSA    </master>
|<userid>USRT005 </userid>
|<verb>QRY </verb>
|<kwd>DB              </kwd>
|<input>QRY DB  NAME(PDHDOJA,PDHDOKA) </input>
|</cmd>
|<cmdrsphdr>
|<hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="AREA" llbl="AreaName" scope="LCL" sort="a" key="3"
| scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="PART" llbl="PartName" scope="LCL" sort="a" key="4"
| scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" />
|<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no"
| len="8" dtype="CHAR" align="left" skipb="no" />
|<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes"
| len="4" dtype="INT" align="right" skipb="no" />
|<hdr slbl="TYP" llbl="TYPE" scope="LCL" sort="n" key="0" scroll="yes"
| len="8" dtype="CHAR" align="left" skipb="no" />
|</cmdrsphdr>
|<cmdrspdata>
|<rsp>DB(        )PART(PDHDOJA ) MBR(IMSA    ) CC(   0) TYP(PART    )
|</rsp>
|<rsp>DB(DBHDOK01)PART(PDHDOKA ) MBR(IMSA    ) CC(   0) TYP(PART    )
|</rsp>
|<rsp>DB(        )PART(PDHDOJA ) MBR(IMS1    ) CC(   0) TYP(PART    )
|</rsp>
|<rsp>DB(DBHDOK01)PART(PDHDOKA ) MBR(IMS1    ) CC(   0) TYP(PART    )
|</rsp>
|</cmdrspdata>
|</imsout>
|

Explanation: The QUERY DB NAME(PDHDOJA,PDHDOKA) command is requesting information of the two partition databases, |PDHDOKA and PDHDOJA. The partition name is returned in the PartName |column and the HALDB master database name is returned in the DBName |column (if a master exists). The HALDB master for the database, |PDHDOJA, is offline so the database name is returned as blanks. |The database type, completion code, and IMS that processed the command |is also returned.

|

QUERY IMSPLEX

QUERY IMSPLEX is an IMSplex command that displays information about one or more IMSplex members. If Version 7 IMSs are part of an IMSplex, the QUERY IMSPLEX command will not show those IMSs even though they are a part of the IMSplex.

This command can be issued only through the OM API.

NAME()
Specifies the name of the IMSplexes for which member information is to be returned. The IMSplex name may be a generic parameter, to allow easy specification of a group of IMSplexes whose names match a generic parameter mask.
SHOW()
Specifies the output fields to be returned. If SHOW is not specified, only the IMSplex names, IMSplex member names, IMSplex member that builds the output line, and completion codes are returned. This provides a method for a system management application to obtain a list of all IMSplex member names that are currently known in the IMSplexes.
ALL
Returns all output fields
JOB
Jobname of the IMSplex member
OS
Name of the OS image on which the IMSplex member is executing.
STATUS
IMSplex member status.
SUBTYPE
IMSplex member subtype.
TYPE
IMSplex member type.
VERSION
IMSplex member version.
STATUS()
Displays IMSplex members that display at least one of the specified status.
ABENDED
IMSplex member has abended
ACTIVE
IMSplex member is active
NOTREACHABLE
The local SCI responsible for the member is not currently active. The status displayed is the current status for the member.
Note:
The status output is NOT-REACHABLE (with a hyphen).
OLD
The SCI responsible for the member is not currently active. The status displayed is the last known status for the member. The actual status may be different.
READY
IMSplex member is ready to receive messages and requests that are routed by TYPE.
TYPE()
Displays IMSplex members that possess at least one of the specified member types.
AOP
Automated Operator Program. Examples of AOPs are a SPOC application that an operator uses to interact with an IMSplex or a program that is monitoring an IMSplex.
BATCH
IMS batch job.
CQS
Common Queue Server address space.
DBRC
DBRC address space.
IMS
IMS region.
IMSCON
An address space that serves as an interface between IMS and a protocol that is not directly supported by IMS (for example, TCP/IP).
OM
Operations Manager address space.
OTHER
Other non-IMS address space or job.
RM
Resource Manager address space.
SCI
Structured Call Interface address space.

QUERY IMSPLEX Output Fields

Table 108 shows the output fields for an QUERY IMSPLEX command. The columns in the table are as follows:

Short Label
Contains the short label generated in the XML output.
Keyword
Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned.
Meaning
Provides a brief description of the output field.
Table 108. Output Fields for QUERY IMSPLEX Command
Short Label Keyword Meaning
IMSMBR N/A IMSplex member name. The IMSplex member name is always returned.
IMSPLX N/A IMSplex name. The IMSplex name is always returned.
MBR N/A IMSplex member that build the output line. The OM identifier of the OM that built the output line.
CC N/A Completion code for the line of output. The completion code is always returned.
STT STATUS IMSplex member status. See Table 109 for more information.
JOB JOB Jobname of IMSplex member.
OS OS Name of OS image on which the IMSplex member is executing.
STYP SUBTYPE Subtype of IMSplex member. See Table 111 for an explanation of the possible subtypes.
TYP TYPE IMSplex member type.
VER VERSION IMSplex member version.

QUERY IMSPLEX Status

Table 109 shows the possible IMSplex member status. The table contains information about status such as the STATUS keyword to specify to select members with the specified status, the status that is returned, and the meaning of the status.

Table 109. QUERY IMSPLEX Status Table
Satus Keyword Status Meaning
ABENDED ABENDED IMSplex member has abended.
ACTIVE ACTIVE IMSplex member is active.
NOTREACHABLE NOT-REACHABLE The local SCI responsible for the member is currently not active. The status displayed is the current status for the member.
OLD OLD The SCI responsible for the member is not currently active. The status displayed is the last known status for the member. The actual status may be different.
READY READY IMSplex member is ready to receive messages and requests that are routed by TYPE.

QUERY IMSPLEX Types

Table 110 shows the possible IMSplex member types. The table contains information about member types such as the TYPE keyword to specify to select members with the specified type, the type that is returned, and the meaning of the member type.

Table 110. QUERY IMSPLEX Member Types
Type Keyword Member Type Meaning
AOP aop Automated Operator Program. An example of an AOP is a SPOC (Single Point of Control) that an operator uses to interact with the IMSplex. Another example of an AOP is a program that is monitoring the IMSplex.
BATCH batch IMS batch job.
CQS cqs Common Queue Server address space. CQS manages shared queues and may also manage resources on a resource structure.
DBRC dbrc DBRC address space.
IMS ims IMS region.
IMSCON imscon IMS connect. An address space that serves as an interface between IMS and a protocol that is not directly supported by IMS.
OM om Operations Manager address space. Operations Manager supports IMS operations in an IMSplex.
OTHER other Other non-IMS address space or job.
RM rm Resource Manager address space. Resource manager supports global resources in an IMSplex.
SCI sci Structured Call Interface address space.

QUERY IMSPLEX Subtypes

Table 111 shows the possible IMSplex member subtypes. The table contains information about member types, the member subtypes associated with them, and the meaning of the member subtype. Members omitted from this table do not define a member subtype.

Table 111. QUERY IMSPLEX Member Subtypes
Member Type Member Subtype Meaning
IMS DBDC IMS DB/DC address space.
IMS DBCTL IMS DBCTL address space. DBCTL supports database functions.
IMS DCCTL IMS DCCTL address space. DCCTL supports data communications functions.
IMS FDBR IMS Fast Database Recovery. An IMS control region that recovers database resources when an IMS database manager fails.
RM SNGLRM RM is defined without a resource structure, so only a single RM is allowed in the IMSplex.
RM MULTRM RM is defined with a resource structure, so multiple RMs are allowed in the IMSplex.

Return, Reason, and Completion Codes for QUERY IMSPLEX

The return and reason codes that can be returned as a result of the QUERY IMSPLEX command are standard for all commands entered through the OM API. Refer to the OM Return and Reason code section in the IMS Version 9: Common Service Layer Guide and Reference for the list of codes and their meanings.

Table 112 contains the return, reason, and completion codes for the QUERY IMSPLEX command. Included in the tables is a brief explanation of the codes.

Table 112. Return and Reason Codes for the QUERY IMSPLEX Command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY IMSPLEX command completed successfully.
X'02000008' X'00002048' The QUERY IMSPLEX command has more than one filter value specified. Only one of the TYPE or STATUS filters can be specified.
X'02000008' X'0000203C' An invalid keyword parameter value was specified.
X'0200000C' X'00003000' The QUERY IMSPLEX command is successful for at least one resource name. The QUERY IMSPLEX command is not successful for one or more resource names. The completion code indicates the reason for the error with the resource name. The completion codes that can be returned by the QUERY IMSPLEX command are listed in the QUERY IMSPLEX completion code table.
X'0200000C' X'00003004' No resources were found to be returned. The resource name(s) specified may be invalid or there were no resources that match the filter specified.
X'02000014' X'00005020' The QUERY IMSPLEX command processing terminated. OM was unable to obtain storage for a system AWE while processing the command.
X'02000014' X'0000502C' The QUERY IMSPLEX command processing terminated. OM was unable to obtain storage for the command output header.
X'02000014' X'00005030' The QUERY IMSPLEX command processing terminated. OM was unable to obtain storage for the command output response.
X'02000014' X'00005040' The QUERY IMSPLEX command processing terminated due to an SCI error.

Errors unique to the processing of this command are returned as a completion codes. A completion code is returned for each action against an individual resource.

Table 113 contains completion codes can be returned on a QUERY IMSPLEX command.

Table 113. Completion Codes for the QUERY IMSPLEX Command
Completion Code Meaning
0 The QUERY IMSPLEX command completed successfully for the resource.
4 The IMSplex name is unknown to the client that is processing the request. The imsplex name may have been typed in error or the imsplex may not be active at this time. If this is a wildcard request there were no matches for the name. Confirm the correct spelling of the resource name is specified on the command.

Examples for QUERY IMSPLEX Command

This section provides OM API and TSO SPOC input and output examples and explanations for the QUERY command.

Example 1 for QUERY IMSPLEX Command

TSO SPOC input:

QRY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS,TYPE)

TSO SPOC output:

Response for: QUERY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS)
IMSplex  MbrName    CC Member   JobName  Type  Subtype  Status
CSLPLEX1 OM1OM       0 IMS2     IMS2     IMS   DBDC     READY,ACTIVE
CSLPLEX1 OM1OM       0 CQS1CQS  CQSRE1   CQS            ACTIVE
CSLPLEX1 OM1OM       0 SYS3     IMS1     IMS   DBDC     READY,ACTIVE
CSLPLEX1 OM1OM       0 OM1OM    OM1      OM             READY,ACTIVE
CSLPLEX1 OM1OM       0 IMS3     IMS3     IMS   DBDC     READY,ACTIVE
CSLPLEX1 OM1OM       0 USRT011  USRT011  AOP            ACTIVE
CSLPLEX1 OM1OM       0 RM1RM    RM1      RM    MULTRM   READY,ACTIVE
CSLPLEX1 OM1OM       0 SCI1SC   SCI1     SCI            READY,ACTIVE

OM API input:

CMD(QRY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS,TYPE))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 15:05:18.859217</statime>
<stotime>2002.163 15:05:18.860443</stotime>
<staseq>B7C4A41E663D11C3</staseq>
<stoseq>B7C4A41E6689B9C3</stoseq>
<rqsttkn1>USRT011 10080518</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<userid>USRT011 </userid>
<verb>QRY </verb>
<kwd>IMSPLEX         </kwd>
<input>QUERY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS,TYPE)</input>
</cmd>
<cmdrsphdr>
<hdr slbl="IMSPLX" llbl="IMSplex" scope="LCL" sort="A" key="1" scroll="NO"  len="8"
dtype="CHAR" align="left"  />
<hdr slbl="MBR"    llbl="MbrName" scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left"  />
<hdr slbl="CC"     llbl="CC"      scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT"  align="right" />
<hdr slbl="IMSMBR" llbl="Member"  scope="LCL" sort="N" key="0" scroll="NO"  len="8"
dtype="CHAR" align="left"  />
<hdr slbl="JOB"    llbl="JobName" scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left"  />
<hdr slbl="TYP"    llbl="Type"    scope="LCL" sort="N" key="0" scroll="YES" len="5"
dtype="CHAR" align="left"  />
<hdr slbl="STYP"   llbl="Subtype" scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left"  />
<hdr slbl="STT"    llbl="Status"  scope="GBL" sort="N" key="0" scroll="YES" len="*"
dtype="CHAR" align="left"  />
</cmdrsphdr>
<cmdrspdata>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(IMS2)    CC(   0) JOB(IMS2)    TYP(IMS)
STYP(DBDC) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(CQS1CQS) CC(   0) JOB(CQSRE1)  TYP(CQS)
STYP(  ) STT(ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(SYS3)    CC(   0) JOB(IMS1)    TYP(IMS)
STYP(DBDC) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(OM1OM)   CC(   0) JOB(OM1)     TYP(OM)
STYP(  ) STT(EADY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(IMS3)    CC(   0) JOB(IMS3)    TYP(IMS)
STYP(DBDC) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(USRT011) CC(   0) JOB(USRT011) TYP(AOP)
STYP(  ) STT(ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(RM1RM)   CC(   0) JOB(RM1)     TYP(RM)
STYP(MULTRM) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM)  IMSMBR(SCI1SC)  CC(   0) JOB(SCI1)    TYP(SCI)
STYP(  ) STT(READY,ACTIVE)</rsp>
</cmdrspdata>
</imsout>

Explanation: The QUERY IMSPLEX command displays the IMSplex members that compose IMSplex CSLPLEX1. This IMSplex contains three IMSs (IMS1, IMS2, and IMS3), a TSO SPOC (USRT011), a CQS (CQSRE1), RM (RM1), and OM (OM1). OM1 is the command master that built the output.

Example 2 for QUERY IMSPLEX Command

TSO SPOC input:

QRY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS,TYPE)

TSO SPOC output:

 Response for: QUERY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS,TYPE)
IMSplex  MbrName    CC Member   JobName  Type  Subtype  Status
CSLPLEX1 OM1OM       0 IMS2     IMS2     IMS   DBDC     READY,ACTIVE 
CSLPLEX1 OM1OM       0 CQS1CQS  CQSRE1   CQS            ACTIVE  
CSLPLEX1 OM1OM       0 SYS3     IMS1     IMS   DBDC     READY,ACTIVE 
CSLPLEX1 OM1OM       0 OM1OM    OM1      OM             READY,ACTIVE
CSLPLEX1 OM1OM       0 IMS3     IMS3     IMS   DBDC     READY,ACTIVE
CSLPLEX1 OM1OM       0 USRT011  USRT011  AOP            ACTIVE
CSLPLEX1 OM1OM       0 RM1RM    RM1      RM    MULTRM   READY,ACTIVE 
CSLPLEX1 OM1OM       0 SCI1SC   SCI1     SCI            READY,ACTIVE

OM API input:

CMD (QRY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS,TYPE))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname><omvsn>1.1.0</omvsn>
<xmlvsn>1</xmlvsn>
<statime>2002.163 15:05:18.859217</statime>
<stotime>2002.163 15:05:18.860443</stotime>
<staseq>B7C4A41E663D11C3</staseq>
<stoseq>B7C4A41E6689B9C3</stoseq>
<rqsttkn1>USRT011 10080518</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl> 
<cmd>
<userid>USRT011 </userid>
<verb>QRY </verb>
<kwd>IMSPLEX         </kwd>
<input>QUERY IMSPLEX NAME(CSLPLEX1) SHOW(JOB,SUBTYPE,STATUS,TYPE)</input>
</cmd>
<cmdrsphdr>
<hdr slbl="IMSPLX" llbl="IMSplex" scope="LCL" sort="A" key="1" scroll="NO"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="MBR"    llbl="MbrName" scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"     llbl="CC"      scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT"  align="right" />
<hdr slbl="IMSMBR" llbl="Member"  scope="LCL" sort="N" key="0" scroll="NO"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="JOB"    llbl="JobName" scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left" />
<hdr slbl="TYP"    llbl="Type"    scope="LCL" sort="N" key="0" scroll="YES" len="5"
dtype="CHAR" align="left" />
<hdr slbl="STYP"   llbl="Subtype" scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left" />
<hdr slbl="STT"    llbl="Status"  scope="GBL" sort="N" key="0" scroll="YES" len="*"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(IMS2)    CC(   0) JOB(IMS2)   TYP(IMS)
STYP(DBDC) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(CQS1CQS) CC(   0) JOB(CQSRE1) TYP(CQS) 
STYP(   ) STT(ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(SYS3)    CC(   0) JOB(IMS1)   TYP(IMS)
STYP(DBDC) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(OM1OM)   CC(   0) JOB(OM1)    TYP(OM)  
STYP(   ) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(IMS3)    CC(   0) JOB(IMS3)   TYP(IMS)
STYP(DBDC) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(USRT011) CC(   0) JOB(USRT011) TYP(AOP) 
STYP(    ) STT(ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(RM1RM)   CC(   0) JOB(RM1)    TYP(RM) 
STYP(MULTRM) STT(READY,ACTIVE)</rsp>
<rsp>IMSPLX(CSLPLEX1) MBR(OM1OM) IMSMBR(SCI1SC)  CC(   0) JOB(SCI1)   TYP(SCI)
STYP(    ) STT(READY,ACTIVE)</rsp>
</cmdrspdata>
</imsout>

Explanation: The QUERY IMSPLEX command displays the IMSplex members that compose IMSplex CSLPLEX1. This IMSplex contains three IMSs (IMS1, IMS2, and IMS3), a TSO SPOC (USRT011), a CQS (CQSRE1), RM (RM1), and OM (OM1). OM1 is the command master that built the output.

QUERY LE

The QUERY LE command allows the user to display Language Environment (LE) runtime parameter overrides defined by a previous UPDATE LE command. The query can use filters on transaction code, LTERM, userid, or program name. Any combination of parameters may be used to qualify the application instance. All entries found that match the criteria are returned to the user. The user specifies on the command which output fields should be returned in the command response. The user can ask for all information that includes transaction code, LTERM name, userid, program name, and runtime parameters. See UPDATE for more information about the UPDATE LE command.

This command may be specified only through the Operations Manager API.

The command syntax for this command is defined in XML and is available to automation programs that communicate with OM.

The following parameters support a generic or wildcard parameter. A generic parameter is a 1-8 character name that includes an asterisk or a percent sign. An asterisk can be replaced by a zero or more characters to create a valid resource name. A percent sign can be replaced by exactly one character to create a valid resource name.

LTERM()
Specifies the 1-8 character name of the LTERM or LTERMs matching the generic or wildcard parameter.
PGM()
Specifies the 1-8 character name of the program or programs matching the generic or wildcard parameter.
SHOW()
Specifies the output fields to be returned. At least one SHOW field is required on the command.
ALL
Returns all the output fields. This is the same as if the following was specified: SHOW(TRAN,LTERM,USERID,PGM,LERUNOPTS).
LERUNOPTS
Returns all of the LE override parameters associated with the transaction, LTERM, userid, or program name.
LTERM
Returns the logical terminal name field.
PGM
Returns the program name field.
TRAN
Returns the transaction name field.
USERID
Returns the user identifier field.
TRAN()
Specifies the 1-8 character name of the transaction or transactions matching the generic or wildcard parameter. If the TRAN, LTERM, USERID, or PGM resource filters are not specified, all parameter overrides are returned.
USERID()
Specifies the 1-8 character name of the userid or userids matching the generic or wildcard parameter. If the TRAN, LTERM, USERID, or PGM resource filters are not specified, all parameter overrides are returned.

QUERY LE Output Fields

Table 114 shows the QUERY LE output fields. The columns in the table are as follows:

Short Label
Contains the short label generated in the XML output.
Keyword
Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned.
Meaning
Provides a brief description of the output field.

Table 114. Output Fields for QUERY LE Command
Short Label Keyword Meaning
CC N/A Completion code for the line of output. Completion code is always returned.
LTRM LTERM LTERM Name requested by the QUERY.
MBR N/A IMSPlex member (IMS identifier) that built the output line. Member name is always returned.
PGM PGM Program Name requested by the QUERY.
PRM LERUNOPTS The LE override parameters for the specified resource filters.
TRAN TRAN Transaction Name requested by the QUERY.
UID USERID Userid requested by the QUERY.

Return, Reason, and Completion Codes for QUERY LE

An IMS return and reason code is returned to OM by the QUERY LE command. The OM return and reason codes that may be returned as a result of the QUERY LE command are standard for all commands entered through the OM API. Table 115 includes the return and reason codes and a brief explanation of the codes. Table 116 includes an explanation of the completion code.

Table 115. Return and Reason Codes for the QUERY LE command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY LE command completed successfully.
X'00000008' X'0000200C' No resources found to return. Either the entry was previously deleted or a keyword filter was typed incorrectly.
X'00000008' X'00002014' An invalid character was specified in the filter name.
X'00000010' X'00004040' The parameter override header has not been initialized. Retry the command after restart is complete.
X'00000014' X'00005000' Unable to get storage from IMODULE GETSTOR.
X'00000014' X'00005010' Unable to obtain latch.
X'00000014' X'00005FFF' Internal IMS Error - Should not occur.

Table 116. Completion code for the QUERY LE command
Completion code Meaning
0 The QUERY LE command completed successfully for the specified resource.

Examples for QUERY LE Command

This section provides OM API and TSO SPOC input and output examples and explanations for the QUERY command.

Example 1 for QUERY LE Command

Assume the following filters are specified on QRY LE commands:

  1. TRAN(PART) SHOW(ALL) Returns entries #1, 2, 3, 5, 6, 8.
  2. TRAN(PART) LTERM(TERM1) SHOW(ALL) Returns entries #3, 5, 6.
  3. LTERM(TERM2) USERID(BETTY) SHOW(ALL) Returns entry #7.
  4. TRAN(PART) LTERM(TERM1) USERID(BETTY) SHOW(ALL) Does not return any entries.
  5. TRAN(PART) LTERM(TERM*) SHOW(ALL) Returns entries #3, 5, 6, 8.
  6. USERID(B*) SHOW(ALL) Returns entries #2, 5, 6, 7.

Rules for matching an entry which results in it being returned on QUERY command:

Table 117 is a logical representation of the parameter override table entries prior to any of the above query commands being processed.

Table 117. Parameter Override Table Entries for Example 1
Entry# TRAN LTERM USERID PROGRAM LERUNOPTS
1 PART DFSSAM02 aaaa
2 PART BETTY bbbb
3 PART TERM1 cccc
4 DFSSAM02 dddd
5 PART TERM1 BARBARA eeee
6 PART TERM1 BOB ffff
7 TERM2 BETTY gggg
8 PART TERM2 iiii

Example 2 for QUERY LE Command

TSO SPOC input:

QRY LE SHOW(ALL)

TSO SPOC output:

SYS3 0                        IAPMDI29 CCCC
SYS3 0 IAPMDI26      USRT001      RPTOPTS=((ON),NOOVR),RPTSTG=(((OFF),NOOVR)
SYS3 0 IAPMDI27 IMS1 USRT001  IAPMDI27 AAAA   

OM API input:

CMD(QRY LE SHOW(ALL))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 17:34:01.196902</statime>
<stotime>2002.163 17:34:01.197368</stotime> 
<staseq>B7C4C55B67566505</staseq>
<stoseq>B7C4C55B67738365</stoseq>
<rqsttkn1>USRT002 10103401</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>SYS3    </master>
<userid>USRT002 </userid>
<verb>QRY </verb>
<kwd>LE              </kwd>
<input>QRY LE SHOW(ALL)          </input>
</cmd>
<cmdrsphdr> 
<hdr slbl="MBR"  llbl="MbrName"   scope="LCL" sort="A" key="1" scroll="NO" len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"   llbl="CC"        scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT" align="right" /> 
<hdr slbl="TRAN" llbl="Trancode"  scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left" />
<hdr slbl="LTRM" llbl="Lterm"     scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR " align="left" /> 
<hdr slbl="UID"  llbl="Userid"    scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR " align="left" />
<hdr slbl="PGM"  llbl="Program"   scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left" />
<hdr slbl="PRM"  llbl="LERunOpts" scope="LCL" sort="N" key="0" scroll="YES" len="*"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>MBR(SYS3    ) CC(   0) TRAN(        ) LTRM(      ) UID(        ) PGM(IAPMDI29)
PRM(CCCC    ) </rsp> 
<rsp>MBR(SYS3    ) CC(   0) TRAN(IAPMDI26) LTRM(      ) UID(USRT001 ) PGM(        )
PRM(RPTOPTS=((ON),NOOVR),RPTSTG=((OFF),NOOVR)       )</rsp>
<rsp>MBR(SYS3    ) CC(   0) TRAN(IAPMDI27) LTRM(IMS1  ) UID(USRT001 ) PGM(IAPMDI27)
PRM(AAAA    ) </rsp>
</cmdrspdata> 
</imsout>

Explanation: The SHOW(ALL) parameter is specified, so all four filters and the runtime option string are shown for each table entry. Furthermore, no filters are specified in the command, so all table entries are shown. In this example, there are three table entries. The first specifies one filter (program) and the parameter string for this entry is CCCC. The second entry specifies two filters, trancode and userid, and its parameter string is RPTOPTS=((ON),NOOVR),RPTSTG=((OFF),NOOVR). The last entry specifies all four filters and a parameter string of AAAA.

Example 3 for QUERY LE Command

TSO SPOC input:

QRY LE SHOW(LTERM,USERID)

TSO SPOC output:

MbrName    CC Lterm    Userid
SYS3        0                         
SYS3        0          USRT001        
SYS3        0 IMS1     USRT001

OM API input:

CMD(QRY LE SHOW(LTERM,USERID))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 17:36:27.588393</statime>
<stotime>2002.163 17:36:27.589261</stotime>
<staseq>B7C4C5E703729D6F</staseq>
<stoseq>B7C4C5E703A8D467</stoseq>
<rqsttkn1>USRT002 10103627</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>SYS3    </master>
<userid>USRT002 </userid>
<verb>QRY </verb>
<kwd>LE              </kwd>
<input>QRY LE SHOW(LTERM,USERID)          </input>
</cmd>
<cmdrsphdr>
<hdr slbl="MBR"  llbl="MbrName" scope="LCL" sort="A" key="1" scroll="NO"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"   llbl="CC"      scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT" align="right" />
<hdr slbl="LTRM" llbl="Lterm"   scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR " align="left" />
<hdr slbl="UID"  llbl="Userid"  scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR " align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>MBR(SYS3    ) CC(   0) LTRM(        ) UID(        ) </rsp>
<rsp>MBR(SYS3    ) CC(   0) LTRM(        ) UID(USRT001 ) </rsp>
<rsp>MBR(SYS3    ) CC(   0) LTRM(IMS1    ) UID(USRT001 ) </rsp>
</cmdrspdata>
</imsout>

Explanation: This command uses the SHOW parameter to limit the amount of data that is shown for each entry in the table. All three table entries are shown, but only the LTERM and TRAN filters are shown for each one. The first entry has neither an LTERM filter nor a USERID filter defined, so it is blank except for the MbrName and CC.

Example 4 for QUERY LE Command

TSO SPOC input:

QRY LE USERID(USRT*) SHOW(LTERM,USERID)

TSO SPOC output:

MbrName    CC Lterm    Userid
SYS3        0          USRT001   
SYS3        0 IMS1     USRT001

OM API input:

CMD(QRY LE USERID(USRT*) SHOW(LTERM,USERID))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname> 
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn> 
<statime>2002.163 17:50:24.925819</statime>
<stotime>2002.163 17:50:24.926381</stotime>
<staseq>B7C4C9058F87B484</staseq>
<stoseq>B7C4C9058FAAD324</stoseq>
<rqsttkn1>USRT002 10105024</rqsttkn1> 
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>SYS3    </master> 
<userid>USRT002 </userid> 
<verb>QRY </verb> 
<kwd>LE   </kwd>
<input>QRY LE USERID(USRT*) SHOW(LTERM,USERID)  </input>  
</cmd> 
<cmdrsphdr> 
<hdr slbl="MBR"  llbl="MbrName" scope="LCL" sort="A" key="1" scroll="NO"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"   llbl="CC"      scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT" align="right" /> 
<hdr slbl="LTRM" llbl="Lterm"   scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR " align="left" />
<hdr slbl="UID"  llbl="Userid"  scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR " align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>MBR(SYS3    ) CC(   0) LTRM(        ) UID(USRT001 ) </rsp> 
<rsp>MBR(SYS3    ) CC(   0) LTRM(IMS1    ) UID(USRT001 ) </rsp>  
</cmdrspdata> 
</imsout>

Explanation: This command uses both the USERID filter and the SHOW parameter to limit the amount of data shown in the output. The USERID(USRT*) parameter limits the output to only those table entries that define a USERID filter that fits the specified pattern (USRT*). The SHOW parameter limits how much information is returned about each table entry In this case, only the LTERM and USERID are shown.

QUERY MEMBER

The QUERY MEMBER command displays status or attribute information about one or more members of the IMSplex. For IMS Version 9, TYPE(IMS) is the only type supported. QUERY MEMBER can be specified only through the OM API.

SHOW()
Specifies the output fields to be returned.
ALL
Returns all the output fields.
ATTRIB
Displays the IMSplex member attributes. These are static definitions.
MODID
Displays the online change modify id. The modify id is incremented by each successful online change. During a global online change, an IMS's local modify id indicates whether the IMS has reached the online change commit phase 2 and is synchronized with the OLCSTAT data set. If the modify id is initialized to zero by the Global Online Change utility, the modify id represents the number of global online changes that have successfully completed.

The local modify id on an XRF alternate system indicates whether the XRF alternate has gotten the X'70' log record, performed online change, and is synchronized with the OLCSTAT data set. If the XRF alternate's modid matches the OLCSTAT data set modid as displayed by the QUERY OLC LIBRARY (OLCSTAT) command, the XRF alternate is synchronized with the OLCSTAT data set.

STATUS
Displays the IMSplex member status. IMSplex member status can change dynamically.
TYPE
Shows the IMSplex member type. The IMSplex member type can be IMS, for the IMS address space.
TYPE()
Specifies the IMSplex member type for which information will be displayed.

QUERY MEMBER Output Fields

Table 118 shows information about the QUERY MEMBER TYPE(IMS) output fields. The columns in the table are as follows:

Short Label
Contains the short label generated in the XML output.
Keyword
Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned.
Scope
Identifies the scope of the output field.
Meaning
Provides a brief description of the output field.
Table 118. Output Fields for QUERY MEMBER Command
Short Label Keyword Scope Meaning
CC N/A N/A Completion code for the line of output. The completion code is always returned.
MBR N/A N/A IMSplex member that built the output line. IMS identifier of IMS that built the output. The IMS identifier is always returned.
LATTR ATTRIB LCL Local IMS attributes. See QUERY MEMBER Attributes for more information.
MODI MODID LCL Online change modify id, which is incremented by 1 for each online change.
LSTT STATUS LCL Local IMS status. See QUERY MEMBER Status for more information.
STT STATUS GBL Global IMS status. See QUERY MEMBER Status for more information.
TYP TYPE LCL IMSplex member type. The IMSplex member type can be IMS, for the IMS address space.

QUERY MEMBER Attributes

Table 119 shows the possible IMS attributes. The table contains information about attributes such as the attribute that is returned, the scope of the attribute, and the meaning of the attribute. Global attributes are returned with the ATTR short label. Local attributes are returned with the LATTR short label.

Table 119. Attributes for QUERY MEMBER Command
Attribute Scope Meaning
GBLOLC LCL Global online change is enabled.
|RMENVNO LCL No RM environment is running.
RSRTRK LCL Remote Site Recovery tracker.
SHAREDQ LCL Shared queues are enabled.

QUERY MEMBER Status

Table 120 shows the possible member status. The table contains information about status such as the status that is returned, the scope of the status, and the meaning of the status. Global status is returned with the STT short label. Local status is returned with the LSTT short label. A scope of LCL means that the status is local to the IMS specified and is returned with the LSTT short label. A scope of GBL means that the status is global to all the IMSs and is returned with the STT short label.

Table 120. Status for QUERY MEMBER Command
Status Scope Meaning
LEOPT LCL Language Environment options are enabled for this IMS.
OLCABRTC LCL Online change abort completed.

A TERMINATE OLC command or /MODIFY ABORT command is entered. Online change abort phase completed locally for this IMS. The IMS is taken out of the online change state.

OLCABRTI LCL Online change abort in progress.

A TERMINATE OLC command or /MODIFY ABORT command is entered. Online change abort phase is in progress locally for this IMS.

OLCCMT1C LCL or GBL Online change commit phase 1 completed.

An INITIATE OLC PHASE(COMMIT) command or /MODIFY COMMIT command is entered. Online change commit phase 1 completed either locally for the IMS, or globally for all of the IMSs in the IMSplex. After all of the IMSs have attempted commit phase 1, the online change master updates the OLCSTAT data set and the online change is considered to be complete.

Classic commands from the system console, an IMS terminal, or the MTO are queued while the IMS is in this state. Queued commands are processed after the online change is committed or aborted. If the classic command is entered from the system console, the WTOR does not appear until this IMS is out of the online change state.

OLCCMT1I LCL or GBL Online change commit phase 1 in progress.

An INITIATE OLC PHASE(COMMIT) command or /MODIFY COMMIT command is entered. Online change commit phase 1 is in progress either locally for this IMS or globally for all the IMSs in the IMSplex.

OLCCMT2C LCL or GBL Online change commit phase 2 completed.

An INITIATE OLC PHASE(COMMIT) command or a /MODIFY COMMIT command is entered. Online change commit phase completed either locally for this IMS or globally for all the IMSs in the IMSplex.

Classic commands from the system console, an IMS terminal, or the MTO are queued while the IMS is in this state. Queued commands are processed after the online change is committed or aborted. If the classic command is entered from the system console, the WTOR does not appear until this IMS is out of the online change state.

OLCCMT2F LCL Online change commit phase 2 failed.

An INITIATE OLC PHASE(COMMIT) command or a /MODIFY COMMIT command is entered. Online change commit phase 2 failed locally for this IMS. This IMS may be stuck in an online change state, where the TERMINATE OLC command or /MODIFY ABORT command does not work. If that is the case, cancel the IMS and warm start IMS. This IMS can warm start, since it successfully participated in the online change except for commit phase 2.

OLCCMT2I LCL or GBL Online change commit phase 2 in progress.

An INITIATE OLC PHASE(COMMIT) command or a /MODIFY COMMIT command is entered. Online change commit phase 2 is in progress either locally for this IMS or globally for all the IMSs in the IMSplex.

OLCMSTR GBL Online change phase master.

An INITIATE OLC PHASE(PREPARE), an INITIATE OLC PHASE(COMMIT), or a TERMINATE OLC command is entered. This IMS is the master of the online change phase currently in progress, either prepare, commit, or terminate. A different IMS may be master of each phase of online change.

OLCPREPC LCL or GBL Online change prepare phase completed.

An INITIATE OLC PHASE(PREPARE) command or a /MODIFY PREPARE command is entered. Online change prepare phase completed locally for this IMS or globally for all the IMSs in the IMSplex.

OLCPREPF LCL Online change prepare phase failed.

An INITIATE OLC PHASE(PREPARE) command is entered. Online change prepare phase failed locally for this IMS. A TERMINATE OLC is requIred to delete the MWA created for the online change and also to delete the online change process that was initiated with RM.

OLCPREPI LCL or GBL Online change prepare phase in progress.

An INITIATE OLC PHASE(PREPARE) command or a /MODIFY PREPARE command is entered. Online change prepare phase is in progress locally for this IMS or globally for all the IMSs in the IMSplex.

OLCTERMC GBL Online change terminate completed.

A TERMINATE OLC command was entered. Online change termination is completed for the IMSs in the IMSplex.

OLCTERMF LCL TERMINATE FAILED:

A TERMINATE OLC command is directed to the IMS that is not in an online change state. An MWA is created to coordinate the TERMINATE OLC command. The TERMINATE OLC command fails due to an RM, SCI, or CQS error and the MWA is set to a 'Terminate Failed' state. A subsequent TERMINATE OLC command is required to delete the MWA in this state.

OLCTERMI GBL Online change terminate in progress.

A TERMINATE OLC command is entered. Online change termination is in progress for the IMSs in the IMSplex. Online change termination aborts the online change.

If all of the IMSs are in an online change prepare state, TERMINATE OLC aborts the online change and removes all of the IMSs from the online change state.

If an error occurs before the OLCSTAT data set is updated, then TERMINATE OLC aborts the online change. The online change abort phase is performed on the IMSs where abort is needed. All of the IMSs are removed from the online change state.

XRFALT LCL XRF alternate system.

Return, Reason, and Completion Codes for QUERY MEMBER

The return and reason codes that can be returned as a result of the QUERY MEMBER command are standard for all commands entered through the OM API. Refer to the OM Return and Reason code section in the IMS Version 9: Common Service Layer Guide and Reference for the list of codes and their meanings.

Table 121 contains the return and reason codes that can be returned to OM for a QUERY MEMBER command. It also includes a brief explanation of the codes.

Table 121. Return and Reason Codes for QUERY MEMBER Command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY MEMBER TYPE(IMS) command completed successfully.
X'00000014' X'00005004' The QUERY MEMBER command failed because a DFSOCMD response buffer could not be obtained.

Errors unique to the processing of this command are returned as a completion codes. A completion code is returned for each action against an individual member.

Table 122 contains the completion code that can be returned on a QUERY MEMBER command.

Table 122. Completion Codes for QUERY MEMBER
Completion Code Meaning
0 The QUERY MEMBER TYPE(IMS) command completed successfully for this IMS.

Examples for QUERY MEMBER Command

This section provides OM API and TSO SPOC input and output examples and explanations for the QUERY command.

Example 1 for QUERY MEMBER TYPE(IMS) Command

TSO SPOC input:

QRY MEMBER TYPE(IMS) SHOW(ALL)

TSO SPOC output:

MbrName    CC Type  Status LclAttr LclStat    ModId
SYS3        0 IMS                                 1 

OM API input:

CMD(QRY MEMBER TYPE(IMS) SHOW(ALL))

OM API output:

<imsout>
<ctl> 
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn> 
<xmlvsn>1   </xmlvsn>
<statime>2002.163 16:32:12.998765</statime>
<stotime>2002.163 16:32:12.999775</stotime> 
<staseq>B7C4B78AFD86D562</staseq>
<stoseq>B7C4B78AFDC5FA80</stoseq>
<rqsttkn1>USRT002 10093212</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn> 
</ctl> 
<cmd>
<master>SYS3    </master>
<userid>USRT002 </userid>
<verb>QRY </verb>
<kwd>MEMBER  </kwd>
<input>QRY MEMBER TYPE(IMS) SHOW(ALL)</input> 
</cmd>
<cmdrsphdr>
<hdr slbl="MBR"   llbl="MbrName" scope="LCL" sort="a" key="1" scroll="no"  len="8"
dtype="CHAR" align="left" /> 
<hdr slbl="CC"    llbl="CC"      scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" />
<hdr slbl="TYP"   llbl="Type"    scope="LCL" sort="n" key="0" scroll="yes" len="5"
dtype="CHAR" align="left" />
<hdr slbl="STT"   llbl="Status"  scope="GBL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
<hdr slbl="LATTR" llbl="LclAttr" scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
<hdr slbl="LSTT"  llbl="LclStat" scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
<hdr slbl="MODI"  llbl="ModId"   scope="LCL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="right" /></cmdrsphdr> 
<cmdrspdata>
<rsp>MBR(SYS3    ) CC(   0) TYP(IMS) MODI(       1) </rsp> 
</cmdrspdata>
</imsout>

Explanation: IMS member SYS3 is active in the IMSplex.

Example 2 for QUERY MEMBER TYPE(IMS) Command

TSO SPOC input:

QRY MEMBER TYPE(IMS) SHOW(ALL)

TSO SPOC output:

MbrName    CC Type  Status LclAttr LclStat    ModId
SYS3        0 IMS                  LEOPT          1    

OM API input:

CMD(QRY MEMBER TYPE(IMS) SHOW(ALL))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 16:42:10.557119</statime>
<stotime>2002.163 16:42:10.557503</stotime>
<staseq>B7C4B9C4DDCBF28D</staseq>
<stoseq>B7C4B9C4DDE3F02D</stoseq>
<rqsttkn1>USRT002 10094210</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>SYS3    </master>
<userid>USRT002 </userid>
<verb>QRY </verb>
<kwd>MEMBER </kwd>
<input>QRY MEMBER TYPE(IMS) SHOW(ALL) </input> 
</cmd>
<cmdrsphdr>
<hdr slbl="MBR"   llbl="MbrName" scope="LCL" sort="a" key="1" scroll="no"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"    llbl="CC"      scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" />
<hdr slbl="TYP"   llbl="Type"    scope="LCL" sort="n" key="0" scroll="yes" len="5"
dtype="CHAR" align="left" />
<hdr slbl="STT"   llbl="Status"  scope="GBL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
<hdr slbl="LATTR" llbl="LclAttr" scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" /> 
<hdr slbl="LSTT"  llbl="LclStat" scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
<hdr slbl="MODI"  llbl="ModId"   scope="LCL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="right" />
</cmdrsphdr>
<cmdrspdata>
<rsp>MBR(SYS3    ) CC(   0) TYP(IMS) LSTT(LEOPT) MODI(       1) </rsp>
</cmdrspdata>
</imsout>

Explanation: IMS member SYS3 is active in the IMSplex. The local status shows that LE runtime option overrides are enabled.

Example 3 for QUERY MEMBER TYPE(IMS) Command

TSO SPOC input:

QRY MEMBER TYPE(IMS) SHOW(ALL)

TSO SPOC output:

 Response for: QUERY MEMBER TYPE(IMS) SHOW(ALL)
MbrName    CC Type  Status LclAttr        LclStat    ModId 
IMS2        0 IMS          SHAREDQ,GBLOLC                1 
IMS3        0 IMS          SHAREDQ,GBLOLC                1 
SYS3        0 IMS          SHAREDQ,GBLOLC                1

OM API input:

CMD (QRY MEMBER TYPE(IMS) SHOW(ALL))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 15:13:05.255654</statime>
<stotime>2002.163 15:13:06.479196</stotime>
<staseq>B7C4A5DB308E6544</staseq>
<stoseq>B7C4A5DC5B45C385</stoseq>
<rqsttkn1>USRT011 10081304</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl> 
<cmd>
<master>IMS3 </master>
<userid>USRT011</userid>
<verb>QRY</verb>
<kwd>MEMBER</kwd>
<input>QUERY MEMBER TYPE(IMS) SHOW(ALL)</input>
</cmd>
<cmdrsphdr>
<hdr slbl="MBR"   llbl="MbrName" scope="LCL" sort="a" key="1" scroll="no"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"    llbl="CC"      scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT"  align="right" />
<hdr slbl="TYP"   llbl="Type"    scope="LCL" sort="n" key="0" scroll="yes" len="5"
dtype="CHAR" align="left" />
<hdr slbl="STT"   llbl="Status"  scope="GBL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
<hdr slbl="LATTR" llbl="LclAttr" scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
<hdr slbl="LSTT"  llbl="LclStat" scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left"/>
<hdr slbl="MODI"  llbl="ModId"   scope="LCL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="right"/>
</cmdrsphdr>
<cmdrspdata>
<rsp>MBR(IMS3    ) CC(   0) TYP(IMS) LATTR(SHAREDQ,GBLOLC) MODI(       1) </rsp>
<rsp>MBR(IMS2    ) CC(   0) TYP(IMS) LATTR(SHAREDQ,GBLOLC) MODI(       1) </rsp>
<rsp>MBR(SYS3    ) CC(   0) TYP(IMS) LATTR(SHAREDQ,GBLOLC) MODI(       1) </rsp>
</cmdrspdata>
</imsout>

Explanation: IMS members SYS3, IMS2, and IMS3 are active in the IMSplex. All three IMSs have shared queues enabled and global online change enabled.

QUERY OLC

|For an IMS running with RM (RMENV=Y), the QUERY OLC command returns information about the OLCSTAT DS that is |shared by all of the IMS systems participating in global online |change. The command response is the same for all of the IMS systems. QUERY OLC is valid for an IMS enabled for global online change but |it is not valid for an IMS enabled for local online change. QUERY OLC is not supported on an XRF alternate, an RSR tracker, or |an FDR region. It can only be specified through the OM API.

|The QUERY OLC LIBRARY command displays information about global online change, such |as the current online change libraries and the IMSs that are current |with the online change libraries. QUERY OLC LIBRARY(OLCSTAT) displays the contents of the global online change status |data set, OLCSTAT. Specifying the SHOW keyword may optionally show |the current active online change libraries, the list of IMSs that |are current with the online change libraries, the modify id, and |the last online change that was done.

|For an IMS running without RM services (RMENV=N), |the QUERY OLC command returns information about the local OLCSTAT DS of |an IMS system. The command response is different for each IMS because |each IMS is required to have a unique OLCSTAT DC. In a no RM environment, |if more than one IMS is specified in the route list for the QUERY OLC, only the OLCSTAT DS information for the command IMS master is |returned. To obtain OLCSTAT DS information from each IMS that is |running without RM, the QUERY OLC command must be issued separately to each IMS. To determine which |IMSs are defined with RMENVNO, issue a QUERY MEMBER SHOW(ATTRIB) command.

The command syntax for this command is defined in XML and is available to automation programs which communicate with OM.

LIBRARY
Online change library. The library can be the following:
OLCSTAT
OLCSTAT data set contents.
SHOW()
Specifies the library information returned.
ALL
Returns all the output fields.
ACTVLIB
Displays the suffixed online change library names that are currently active. This includes ACBLIBA or ACBLIBB, FMTLIBA or FMTLIBB, and MODBLKSA or MODBLKSB. These are the online change libraries the IMS online system must use at IMS initialization time.
DSN
OLCSTAT data set name.
LASTOLC
Displays the last online change that was successfully performed. If an IMS was down during the last online change and its restart type does not conflict with the last online change that was performed, it will be permitted to warmstart. The last online change type is blank, if no online changes have been done. The last online change type is one or more of the following, if at least one online change has been done:
  • ACBLIB
  • FMTLIB
  • MODBLKS
MBRLIST
Displays the list of IMSs that are current with the online change libraries. These are the IMSs that will be permitted to warmstart. The IMSs either participated in the last online change, or coldstarted since the last online change.
MODID
Modify id. The modify id -1 represents the number of global online changes that have been performed.

QUERY OLC Output Fields

Table 123 shows the QUERY OLC output fields. The columns in the table are as follows:

Short Label
Contains the short label generated in the XML output.
Keyword
Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned.
Scope
Identifies the scope of the output field.
Meaning
Provides a brief description of the output field.
Table 123. Output Fields for the QUERY OLC Command
Short Label Keyword Scope Meaning
MBR N/A N/A IMSplex member that built output line. IMS identifier of the IMS that build the output. IMS identifier is always returned.
CC N/A N/A Completion code for the line of output. The completion code indicates whether or not IMS was able to process the command for the specified library. Refer to Table 125 for more information. The completion code is always returned.
LIB N/A GBL Library name. Can be OLCSTAT.
ACBL ACTVLIB GBL Current ACBLIB library. A means the current ACBLIB library is ACBLIBA. B means the current ACBLIB library is ACBLIBB.
FMTL ACTVLIB GBL Current FMTLIB library. A means the current FMTLIB library is FMTLIBA. B means the current FMTLIB library is FMTLIBB.
MODB ACTVLIB GBL Current MODBLKS and MATRIX libraries. A means the current libraries are MODBLKSA and MATRIXA. B means the current libraries are MODBLKSB and MATRIXB.
DSN DSN GBL OLCSTAT data set name.
LAST LASTOLC GBL The last successful online change that was successfully performed. If an IMS was down during the last online change and its restart type does not conflict with the last online change that was performed, it will be permitted to warmstart. The online change type may include one or more of the following:
  • ACBLIB
  • FMTLIB
  • MODBLKS
MBRL MBRLIST GBL List of IMSplex members that are current with the online change libraries. These are the IMSs that will be permitted to warmstart. The IMSs either participated in the last online change, or coldstarted since the last online change.
MODI MODID GBL Current modify id. The modify id - 1 is the number of successful global online changes that have been performed.

Return, Reason, and Completion Codes for QUERY OLC

The return and reason codes that can be returned as a result of the QUERY OLC command are standard for all commands entered through the OM API. Refer to the OM Return and Reason code section in the IMS Version 9: Common Service Layer Guide and Reference for the list of codes and their meanings.

Table 124 contains the return and reason codes that can be returned to OM from a QUERY OLC command.

Table 124. Return and Reason Codes for the QUERY OLC Command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY OLC command completed successfully.
X'00000004' X'00001000' The QUERY OLC command was not processed on the IMS system as the IMS system is not the command master. No information is returned.
X'00000010' X'0000400C' The QUERY OLC command failed because it is invalid for an XRF alternate.
X'00000010' X'00004014' The QUERY OLC command failed because it is invalid for an RSR tracker.
X'00000010' X'0000401C' The QUERY OLC command failed because it is invalid for an FDR region.
X'00000010' X'0000410C' The QUERY OLC command is rejected, because global online change is not enabled. Local online change is enabled. Use the /DISPLAY MODIFY command for local online change. If your IMSplex is made up of some IMSs that support global online change and some that support local online change, route the QUERY OLC command to an IMS that is enabled for global online change. Issue the QUERY MEMBER TYPE(IMS) SHOW(ATTRIB) command to choose an IMS that has global online change enabled.
X'00000010' X'00004114' The QUERY OLC LIBRARY(OLCSTAT) command failed because of an error accessing the OLCSTAT data set.

A DFS2843 message is sent to the OM output exit as unsolicited output.

X'00000010' X'00004118' The QUERY OLC LIBRARY(OLCSTAT) command failed because of an error allocating the OLCSTAT data set.

A DFS2848 message is sent to the OM output exit as unsolicited output.

X'00000010' X'0000411C' The QUERY OLC LIBRARY(OLCSTAT) command failed because of an error in the OLCSTAT data set contents. One or more of the values is invalid.

A DFS2844 message is sent to the OM output exit as unsolicited output.

X'00000014' X'00005004' The QUERY OLC command processing failed because a DFSOCMD response buffer could not be obtained.
X'00000014' X'00005FFF' The QUERY OLC command failed because of an internal IMS error.

Errors unique to the processing of this command are returned as a completion codes. A completion code is returned for each action against an individual library.

Table 125 contains the completion codes that can be returned on a QUERY OLC command.

Table 125. Completion Codes for the QUERY OLC Command
Completion Code Meaning
0 The QUERY OLC command completed successfully for the library.

Examples for QUERY OLC Command

This section provides OM API and TSO SPOC input and output examples and explanations for the QUERY command.

Example 1 for QUERY OLC Command

TSO SPOC input:

QRY OLC LIBRARY(OLCSTAT) SHOW(ACTVLIB,MODID,MBRLIST)

TSO SPOC output:

 Response for: QUERY OLC LIBRARY(OLCSTAT) SHOW(ACTVLIB,MODID,MBRLIST)
MbrName    CC Library    ACBLIB   FMTLIB  MODBLKS    Modid MbrList          
MS3        0 OLCSTAT         B        A        B        1 IMS3,IMS2,SYS3   

OM API input:

CMD (QRY OLC LIBRARY(OLCSTAT) SHOW(ACTVLIB,MODID,MBRLIST))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 15:22:43.468642</statime>
<stotime>2002.16315:22:45.400709</stotime>
<staseq>B7C4A8029DD62884</staseq>
<stoseq>B7C4A80475885248</stoseq>
<rqsttkn1>USRT011 10082243</rqsttkn1>
<rc>0200000C</rc>
<rsn>00003000</rsn>
</ctl>
<cmderr>
<mbr name="IMS2    ">
<typ>IMS     </typ>
<styp>DBDC</styp>
<rc>00000004</rc>
<rsn>00001000</rsn>
</mbr>
<mbr name="SYS3    ">
<typ>IMS     </typ>
<styp>DBDC   </styp>
<rc>00000004</rc>
<rsn>00001000</rsn>
</mbr>
</cmderr>
<cmd>
<master>IMS3    </master>
<userid>USRT011 </userid>
<verb>QRY </verb>
<kwd>OLC  </kwd>
<input>QUERY OLC LIBRARY(OLCSTAT) SHOW(ACTVLIB,MODID,MBRLIST)</input>
</cmd>
<cmdrsphdr>
<hdr slbl="MBR"  llbl="MbrName" scope="LCL" sort="a" key="1" scroll="no" len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"   llbl="CC"      scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT"  align="right" />
<hdr slbl="LIB"  llbl="Library" scope="GBL" sort="a" key="1" scroll="no"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="ACBL" llbl="ACBLIB"  scope="GBL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="right" />
<hdr slbl="FMTL" llbl="FMTLIB"  scope="GBL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="right" />
<hdr slbl="MODB" llbl="MODBLKS" scope="GBL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="right" />
<hdr slbl="MODI" llbl="Modid"   scope="GBL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="right" />
<hdr slbl="MBRL" llbl="MbrList" scope="GBL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left"/>
</cmdrsphdr>
<cmdrspdata>
<rsp>MBR(IMS3    ) CC(   0) LIB(OLCSTAT ) ACBL(B) FMTL(A) MODB(B) MODI(       1)
MBRL(IMS3,IMS2,SYS3) </rsp>
</cmdrspdata>
</imsout> 

Explanation: QUERY OLC LIBRARY(OLCSTAT) displays the contents of the OLCSTAT data set, which contains global online change status. This command displays the active online change libraries, the modify id, and the list of IMS members that are current with the online change libraries and may therefore warm list. The output shows that the ACBLIBB data set is active, the FMTLIBB data set is active, the MODBLKSB data set is active, and the modify id is 2. SYS3 was the command master that built the output.

Example 2 for QUERY OLC Command

TSO SPOC input:

QRY OLC LIBRARY(OLCSTAT) SHOW(DSN)

TSO SPOC output:

MbrName    CC Library  DSName
IMS3        0 OLCSTAT  IMSTESTL.IMS02.OLCSTAT   

OM API input:

CMD (OLC LIBRARY(OLCSTAT) SHOW(DSN))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 15:28:36.353742</statime>
<stotime>2002.16315:28:36.426823</stotime>
<staseq>B7C4A953276CE286</staseq>
<stoseq>B7C4A95339447348</stoseq>
<rqsttkn1>USRT011 10082836</rqsttkn1>
<rc>0200000C</rc><rsn>00003000</rsn>
</ctl>
<cmderr>
<mbr name="IMS2    ">
<typ>IMS     </typ>
<styp>DBDC    </styp>
<rc>00000004</rc>
<rsn>00001000</rsn>
</mbr>
<mbr name="SYS3    ">
<typ>IMS     </typ>
<styp>DBDC    </styp>
<rc>00000004</rc>
<rsn>00001000</rsn>
</mbr>
</cmderr>
<cmd>
<master>IMS3    </master>
<userid>USRT011 </userid>
<verb>QRY </verb>
<kwd>OLC  </kwd>
<input>QUERY OLC LIBRARY(OLCSTAT) SHOW(DSN)</input>
</cmd>
<cmdrsphdr>
<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="1" scroll="no"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"  llbl="CC"      scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT"  align="right" />
<hdr slbl="LIB" llbl="Library" scope="GBL" sort="a" key="1" scroll="no"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="DSN" llbl="DSName"  scope="GBL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>MBR(IMS3   ) CC(   0) LIB(OLCSTAT ) DSN(IMSTESTL.IMS02.OLCSTAT) </rsp>
</cmdrspdata>
</imsout>

Explanation: This QUERY OLC command displays the OLCSTAT data set name. IMS3 was the command master that built the output.

| | |

QUERY OLREORG

|

|The QUERY OLREORG command is valid only from OM API. Responses from each IMS that |the command was routed to are consolidated by OM. If particular |names are specified on the NAME parameter, response lines are returned |for each partname that was specified. For NAME(*), response lines |are returned only for the HALDB partitions that have online reorganizations |in progress at each IMS.|

|

A non-zero return code and non-zero reason code will be returned |when the command is routed to an XRF (Extended Restart Facility) |alternate system and when the command is routed to an RSR (Remote |Site Recovery) tracking system.

|

Restriction: This command does not support keyword |synonyms. Only one version of each keyword can be specified for |each command issued.

|

The output for this command is defined in XML and is available |to automation programs which communicate with OM.

|

Related Reading: See the Appendix of the IMS Version 9: Common Service Layer Guide and Reference for |sample IMS command XML.

|
|
NAME()
|
Displays |the online reorganization status for the specified HALDB partitions. | |
|
PARTNAME
|
The name of a HALDB PHDAM or PHIDAM partition. The wildcard |character (*) is NOT allowed except as NAME(*) for all defined HALDB |partitions. NAME(*) is the default. |
|
|
|
SHOW()
|
Specifies the output fields to return. If SHOW is not specified |only the partname is returned. | |
|
ALL
|
|Returns STATUS, RATE, and BYTES on each response |line.| |
|
BYTES
|
Returns the number of bytes that have been moved to the output |data set. |
|
RATE
|
Returns the rate from 1 to 100, at which the HALDB OLR is running. |
|
STATUS
|
Online reorganization status. |
|
|
|
STATUS()
|
|Displays online reorganizations that possess at least one of the specified statuses. If STATUS is not specified then any online reorganization with a status of either RUNNING, OWNED, or NOTOWNED is returned.| | |
|
NOTOWNED
|
Specifies that the output is for the online reorganizations |that have been temporarily stopped by the |TERMINATE OLREORG| command and therefore, are not owned by any IMS. |
|
OWNED
|
Specifies that the output is for HALDB OLRs that are owned |by other IMS'. Those owned by this IMS display a STATUS of RUNNING. The OLRs that are running on the IMS where the command is |being processed display RUNNING. OLRs running on other IMS subsystems displayed a STATUS of OWNED. |
|
RUNNING
|
|Specifies the output is for the HALDB OLRs that are owned |by each IMS for the specified partname or partnames. |This option can be used to determine which IMS has an online reorganization |running for which partname.| |
|
UNKNOWN
|
|Specifies that the output is for those partnames on each |IMS where status of the HALDB OLR cannot be determined. This inability |to determine the status can be due to situations such as: the HALDB |master being taken offline by a /DBR DB command, or the IMS not being authorized to the named partname because |of an IRLM failure.| |
|
|
|
| |

QUERY OLREORG Output Fields

|

Table 126 shows the QUERY OLREORG output fields. The columns in the table are as follows: |

|
|
Short Label
|
Contains the short label generated in the XML output. |
|
Show Keyword
|
Identifies the keyword on the command that caused the field |to be generated. | |

N/A appears for output fields that are always returned.

|
|
Meaning
|
Provides a brief description of the output field. |
|
| ||||||||||||||||||||||||||||||||||||||||||
Table 126. Output Fields of QUERY OLREORG
Short Label Show Keyword Meaning
PART N/A Partition name.
MBR N/A The IMS from which the command was issued.
CC N/A Completion code.
LSTT STATUS Status of HALDB OLR.
RATE RATE The speed at which HALDB OLR runs. A value of |1 to 100 percent.
BYTES BYTES Number of bytes moved.
| |

Return, Reason, and Completion Codes for QUERY OLREORG

|

|

|The OM return and reason codes that might |be returned as a result of the QUERY OLREORG command are standard for all commands entered through the |OM API.|

|

Table 72 includes the return |and reason codes and a brief explanation of the QUERY OLREORG command. Table 128 includes |an explanation of the completion codes. Errors unique to the processing |of QUERY OLREORG command are returned as completion codes. A completion code |is returned for each action against a HALDB partition.

Table 127. Return and Reason Code for the QUERY OLREORG Command
|Return Code |Reason Code |Meaning
|X'00000000' |X'00000000' |The QUERY OLREORG command completed successfully.
|X'00000008' |X'00002004' |Invalid command keyword.
|X'00000010' |X'00004030' |Command Invalid for LSO=Y.
| |X'00004014' |Command issued on an RSR tracker.
| |X'0000400C' |Command issued on an XRF alternate.
|X'00000014' |X'00005000' |A GETMAIN error occurred.
| | |||||||||||||||||||||||||||||||||||
Table 128. Completion Codes for the QUERY OLREORG Command
Completion Code Meaning
0 The QUERY OLREORG command completed successfully for the partition.
10 Resource name invalid.
14 Resource not a partition name.
1C Resource is a partitioned secondary index.
24 No HALDB OLR is in progress.
CB Partition not in specified status.
| |

Example for QUERY OLREORG Command

|

This section provides OM API and TSO SPOC input and output |examples and explanations for the QUERY OLREORG command.

|

TSO SPOC input: |

|
QRY OLREORG NAME(*) SHOW(ALL)
|

TSO SPOC output: |

|
|    Partition MbrName    CC LCLSTAT  RATE        BYTES
|    PDHDOKA   IMSA        0 RUNNING     5       115260
|    PDHDOKB   IMSA        0 RUNNING     5          634|
|

OM API input: |

|
CMD (QRY OLREORG NAME(*) SHOW(ALL))
|

OM API output: |

|
<imsout> 
|<ctl> 
|<omname>OM1OM   </omname>
|<omvsn>1.2.0</omvsn>
|<xmlvsn>1   </xmlvsn>
|<statime>2003.168 21:05:23.374319</statime>
|<stotime>2003.168 21:05:23.376148</stotime>
|<staseq>B99626AE9E0EF969</staseq>
|<stoseq>B99626AE9E8140A4</stoseq>
|<rqsttkn1>USRT005 10140523</rqsttkn1>
|<rc>00000000</rc>
|<rsn>00000000</rsn>
|</ctl> 
|<cmd>
|<master>IMSA    </master>
|<userid>USRT005 </userid>
|<verb>QRY </verb>
|<kwd>OLREORG         </kwd> 
|<input>QRY OLREORG NAME(*) SHOW(ALL) </input>
|</cmd> 
|<cmdrsphdr>
|<hdr slbl="PART" llbl="Partition" scope="LCL" sort="A" key="1"
| scroll="NO" len="9" dtype="CHAR" align="left" />
|<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="N" key="0" scroll="NO"
| len="8" dtype="CHAR" align="left" />
|<hdr slbl="CC" llbl="CC" scope="LCL" sort="N" key="0" scroll="YES"
| len="4" dtype="INT" align="right" />
|<hdr slbl="LSTT" llbl="LCLSTAT" scope="LCL" sort="NO" key="0"
| scroll="YES" len="*" dtype="CHAR" align="left" />
|<hdr slbl="RATE" llbl="RATE" scope="LCL" sort="N" key="0" scroll="YES"
| len="4" dtype="INT" align="right" /> 
|<hdr slbl="BYTES" llbl="BYTES-MOVED" scope="LCL" sort="NO" key="0"
| scroll="YES" len="20" dtype="INT" align=="right" />
|</cmdrsphdr> 
|<cmdrspdata> 
|<rsp> PART(PDHDOKA ) MBR(IMSA    ) CC(   0) LSTT(RUNNING ) RATE(  5)
| BYTES(      115260) </rsp> 
|<rsp> PART(PDHDOKB ) MBR(IMSA    ) CC(   0) LSTT(RUNNING ) RATE(  5) 
| BYTES(         634) </rsp> 
|</cmdrspdata>
|</imsout>
|

Explanation: The QUERY OLREORG command is routed to IMSA. The command is issued to obtain |the information on all of the OLRs that are in progress at IMSA. |The output that is returned contains the following information: |

|

QUERY STRUCTURE

The QUERY STRUCTURE command displays information about IMS coupling facility structure(s) used by members of an IMSplex.

In IMS Version 9, this command is supported only by RM to return information about a resource structure.

The command syntax for this command is defined in XML and is available to automation programs which communicate with OM.

NAME()
Specifies the names of the structures for which information is to be returned. The structure name may be a generic parameter, to allow easy specification of a group of structures whose names match a generic parameter mask.
SHOW()
Specifies the output fields to be returned. If SHOW is not specified, only the structure names, IMSplex member that builds the output line, and completion codes are returned. This provides a method for a system management application to obtain a list of all structure names. This can be used to determine the resource structure that is managed by RM. The parameters supported with the SHOW keyword are as follows:
ALL
Returns all the output fields.
STATISTICS
Displays statistics information for the structures that match the specification in the NAME() parameter.
TYPE
Returns the type of the specified structure. For example, the type may be RSRC, which identifies a resource structure.

QUERY STRUCTURE Output Fields

Table 129 contains information about the output fields for QUERY STRUCTURE. The columns in the table are as follows:

Short Label
Contains the short label generated in the XML output.
Keyword
Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned.
Meaning
Provides a brief description of the output field.
Table 129. Output Fields for the QUERY STRUCTURE Command
Short Label Keyword Meaning
STRNM N/A Resource structure name. The structure name is always returned.
MBR N/A IMSplex member that built the output line. The RM identifier of the RM that built the output line.
CC N/A Completion code for the line of output. The completion code is always returned.
TYP TYPE Structure type. In IMS Version 9, only resource type RSRC is supported.
LEA STATISTICS Number of list entries that are allocated in the structure.
LEI STATISTICS Number of list entries in use in the structure.
ELMA STATISTICS Number of data elements that are allocated in the structure.
ELMI STATISTICS Number of data elements in use in the structure.
RATIO STATISTICS Entry to element ratio. It is in the format of list entries/data elements.

Return, Reason, and Completion Codes for QUERY STRUCTURE

The return and reason codes that can be returned as a result of the QUERY STRUCTURE command are standard for all commands entered through the OM API. Refer to the OM Return and Reason code section in the IMS Version 9: Common Service Layer Guide and Reference for the list of codes and their meanings.

Table 130 contains the return and reason codes that can be returned to OM from a QUERY STRUCTURE command.

Table 130. Return and Reason Codes for the QUERY STRUCTURE Command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY STRUCTURE command completed successfully.
X'0300000C' X'00003000' The QUERY STRUCTURE command is successful for at least one resource name. The QUERY STRUCTURE command is not successful for one or more resource names. The Completion Code indicates the reason for the error with the resource name. The Completion Codes that can be returned by the QUERY STRUCTURE command are listed in the QUERY STRUCTURE completion code table.
X'0300000C' X'00003004' No requests were successful. The resource name(s) specified may be invalid or there were no resources that match the filter specified.
X'03000014' X'0000502C' The QUERY STRUCTURE command processing terminated. RM was unable to obtain storage for the command output header.
X'03000014' X'00005030' The QUERY STRUCTURE command processing terminated. RM was unable to obtain storage for the command output response.
X'03000014' X'00005200' The QUERY STRUCTURE command processing terminated due to an unexpected CQS error.

Errors unique to the processing of this command are returned as a completion codes. A completion code is returned for each action against an individual resource.

Table 131 contains the completion codes that can be returned on a QUERY STRUCTURE command.

Table 131. Completion Codes for the QUERY STRUCTURE Command
Completion Code Meaning
0 The QUERY STRUCTURE command completed successfully for the resource.
4 The structure name is unknown to the client that is processing the request. The structure name may have been typed in error or the structure may not be defined or allocated at this time. If this is a wildcard request there were no matches for the name. Confirm the correct spelling of the structure name is specified on the command.

Example for QUERY STRUCTURE

This section provides OM API and TSO SPOC input and output examples and explanations for the QUERY STRUCTURE command.

Example 1 for QUERY STRUCTURE Command

TSO SPOC input:

QRY STRUCTURE SHOW(STATISTICS)

TSO SPOC output:

StructureName    MbrName    CC LeAlloc LeInuse ElmAlloc ElmInuse LE/EL  
IMSRSRC01        RM1RM       0    3577     676     3574       24 0001/0001 

OM API input:

CMD (QRY STRUCTURE SHOW(STATISTICS))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1</xmlvsn>
<statime>2002.16314:31:34.901057</statime>
<stotime>2002.16314:31:34.941134</stotime>
<staseq>B7C49C9433D410C1</staseq>
<stoseq>B7C49C943D9CEC44</stoseq>
<rqsttkn1>USRT011 10073134</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl> 
<cmd>
<master>RM1RM   </master>
<userid>USRT011</userid>
<verb>QRY </verb>
<kwd>STRUCTURE</kwd>
<input>QUERY STRUCTURE SHOW(ALL)</input>
</cmd>
<cmdrsphdr>
<hdr slbl="STRNM" llbl="StructureName" scope="LCL" sort="A" key="1" scroll="NO"
len="16" dtype="CHAR" align="left"/>
<hdr slbl="MBR"   llbl="MbrName"  scope="LCL" sort="N" key="0" scroll="NO" len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"    llbl="CC"       scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT"  align="right" />
<hdr slbl="TYP"   llbl="Type"     scope="LCL" sort="N" key="0" scroll="YES" len="8"
dtype="CHAR" align="left" />
<hdr slbl="LEA"   llbl="LeAlloc"  scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT"  align="right" />
<hdr slbl="LEI"   llbl="LeInuse"  scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT"  align="right" />
<hdr slbl="ELMA"  llbl="ElmAlloc" scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT"  align="right" />
<hdr slbl="ELMI"  llbl="ElmInuse" scope="LCL" sort="N" key="0" scroll="YES" len="4"
dtype="INT"  align="right" />
<hdr slbl="RATIO" llbl="LE/EL"    scope="LCL" sort="N" key="0" scroll="YES" len="9"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>STRNM(IMSRSRC01) MBR(RM1RM) CC(   0) TYP(RSRC) LEA(3577) LEI( 676) ELMA(3574)
ELMI(  24) RATIO(0001/0001)</rsp>
</cmdrspdata>
</imsout>

Explanation: This command displays all of the resource structures in the IMSplex and their statistics. Only one resource structure is defined, IMSRSRC01. The list entries allocated on the resource structure is 3577, the list entries in use on the structure is 680. The data elements allocated is 3574, the data elements in use is 32. The list entry to data element ratio on the resource structure is one to one. Not many list entries or data elements are in use on the resource structure, so the resource structure is not approaching full.

QUERY TRAN

|The QUERY TRAN command displays information about transactions (for example, | class, status, queue count and others) across the IMSplex. This |command can be specified only through the OM API and is valid on |an XRF alternate.

|The transaction information displayed depends on |whether or not the IMS issuing the QUERY TRAN command is running with RM services. If QUERY TRAN is issued by an IMS command master running without RM, all |transaction information local to that IMS is returned. If QUERY TRAN is issued by an IMS command master running with RM, the IMS |command master retreives global information from CQS or RM as specified.

|If QUERY TRAN is routed for global information to all IMSs in an environment |where some IMSs use RM services and other IMSs do not, the command |results will vary because any of the IMS systems can be the command |master. The RM environment of the IMS command master affects the |type of transaction information that is displayed. You may want |to route QUERY TRAN to specific IMS systems if some IMSs are using RM. Here are |two examples of why you may receive different command results: |

|
    |
  1. The IMSplex has non-cloned systems and the transaction is only |defined by an IMS that has RMENV=N. The IMS command master is running |with RM services, but because the transaction is not defined to |RM, no global information is obtained. The results are two response |lines: | |
  2. |
  3. The IMSplex has non-cloned systems. If global queue counts are |requested, and the IMS command master does not have RM running, |no global queue counts are returned for transactions that are not |defined locally at the command master. All other IMSs return only |their local information.
CLASS()
Displays transactions that possess at least one of the specified classes. This allows for additional filtering by CLASS value. If a STATUS, CLASS, or QCNT filter is not specified, all of the transactions matching the transaction name are returned.

The output returned when the CLASS filter is specified includes the class value of the transaction that caused the transaction name to be displayed even if the SHOW(CLASS) option is not specified.

NAME()
Displays the transactions or group of transactions whose name matches the generic or wildcard parameter specified. If a STATUS, CLASS, or QCNT filter is not specified, all of the transactions matching the transaction name are returned.
QCNT()
Selects transactions that have a queue count less than (LT), less than or equal to (LE), greater than (GT), greater than or equal to (GE), equal to (EQ), or not equal to (NE) the specified numbers. The specified number cannot be a 1 when LT is specified. This allows additional filtering by QCNT value.

Transactions with a queue count of 0 are not returned when the QCNT filter is specified. When a filter of QCNT(LT,n) is specified, transactions with a queue count greater than 0 and less than 'n' are returned. If a STATUS, CLASS, or QCNT filter is not specified, all of the transactions matching the transaction name are returned.

The QCNT filter is valid in both a shared queues environment and a non shared queues environment.

In a shared queues environment, if QCNT is specified, the performance implication is that the shared queues are read. In this environment, the QRY TRAN QCNT command is processed only by the master IMS as the queues are global. The command master returns all the transactions on the shared queues that match the queue count filter specified. If QCNT is specified with a wildcard transaction name, the performance implication is that all of the shared queues transaction messages on the Coupling Facility must be read.

In a non shared queues environment, the local queue count values are used to determine the transactions to be displayed. In this environment, the QRY TRAN QCNT command is processed by each IMS the command is routed to as the queues are local. Each IMS returns all the transactions it found locally that match the queue count filter specified.

The output returned when the QCNT filter is specified includes the queue count of the transaction that caused the transaction name to be displayed even if the SHOW(QCNT) option is not specified.

SHOW()
Specifies the transaction output fields to be returned. The transaction name is always returned along with the name of the IMS that created the output for the transaction and the completion code. If SHOW is not specified, only the transaction names are returned provided the QCNT, CLASS or STATUS filter is not specified. This provides a method for a system management application to obtain a list of transactions matching the transaction name that are currently known in the IMSplex.
ALL
Returns all the output fields both local and global values except the affinity of the messages on the shared queues. This affinity that is shown when the AFFIN option is specified is valid only with the QCNT filter and is ignored for the other flavors of the QRY TRAN command. Global values are only returned for those status fields and attributes for which global information is kept for the IMSplex. In IMS Version 9, only the QCNT attribute may have both local and global values.
AFFIN
IMS affinity of the messages on the shared queues. The only SHOW option supported when the QCNT() filter is specified is the AFFIN option. No other SHOW options are supported with the QCNT() filter due to performance reasons.

AFFIN is valid only in a shared queues environment and is ignored in a non-shared queues environment.

CLASS
Scheduling class used to determine which message regions can process the transaction locally on a particular IMS.
CPRI
Local current scheduling priority.
LCT
Limit count in the local IMS.
LPRI
Local limit scheduling priority.
MAXRGN
Local maximum region count.
NPRI
Local normal scheduling priority.
PARLIM
Local parallel processing limit count. If load balancing is disabled a numeric value of 65535 is returned. If load balancing is enabled, the PARLIM value between 0-37327 is returned.
PLCT
Local processing limit count.
PSB
PSB name associated with the transaction.
QCNT
Local transaction message queue count.
RGC
Number of regions the transaction is currently scheduled in the local IMS.
SEGNO
Local application program output segment limit allowed in the message queues for each GU call.
SEGSZ
Local application program output segment size limit allowed in the message queues for each GU call.
STATUS
Local transaction status.
STATUS()
Selects transactions for display that possess at least one of the specified transaction status. This allows for additional filtering by transaction status. If a STATUS, CLASS, or QCNT filter is not specified, all of the transactions matching the transaction name are returned.

The output returned when the STATUS filter is specified includes the status of the transaction that caused the transaction name to be displayed even if the SHOW(STATUS) option is not specified.

RM does not keep any global status for transactions, so all status is local. In a follow-on release, RM will keep certain types of global transaction status. At that time, filtering by transaction status will filter on both local and global status.

BAL
Transaction is eligible for load balancing (for example, with parallel limits specified).
CONV
This is a conversational transaction.
CPIC
This CPI-C transaction was built dynamically on this IMS system and can process only on this IMS system.
DYN
Transaction was built in a shared queues environment, is not defined to this IMS, and therefore, cannot be scheduled in this IMS subsystem.
FPE
This transaction is Fast Path exclusive.
FPP
This transaction is Fast Path potential.
IOPREV
Indicates that a BMP program containing GSAM cannot completed scheduling because I/O prevention has not completed. Further I/O requests to data sets are inhibited.
LCK
Transaction locked by a /LOCK TRANSACTION command.
QERR
I/O error has occurred on this queue for this MSC remote transaction.
RESP
Response mode transaction.
RMT
Remote transaction.
SUSPEND
Transaction has messages on the suspend queue.
STOQ
Transaction is stopped for queueing. This might be due to a previous UPDATE TRAN, /PURGE TRAN or /STO TRAN command.
STOSCHD
Transaction is stopped for scheduling. This might be due to a previous UPDATE TRAN, /PSTOP TRAN or /STO TRAN command or an application abend.
TRACE
Transaction is being traced.
USTO
Transaction scheduling stopped because of unavailable data.

QUERY TRAN Compared to Other Commands

Table 132 shows different instances of the QUERY TRAN command and other IMS commands that display similar information.

Table 132. QUERY TRAN Compared to Other Similar Commands
QUERY TRAN Command Similar IMS Command
QUERY TRAN NAME(tranname) SHOW(ALL) /DISPLAY TRAN tranname
QUERY TRAN SHOW(ALL) /DISPLAY TRAN ALL
QUERY TRAN NAME(tranname) SHOW(QCNT) /DISPLAY TRAN tranname QCNT
QUERY TRAN NAME(tranname) STATUS(IOPREV,LCK,QERR,SUSPEND,STOQ, STOSCHD,USTO) SHOW(STATUS) /DISPLAY STATUS TRANSACTION

QUERY TRAN Output Fields

Table 133 shows the output fields for the QUERY TRAN command. The columns in the table are as follows:

Short Label
Contains the short label generated in the XML output.
Keyword
Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned.
Scope
Identifies the scope of the output field.
Meaning
Provides a brief description of the output field.
Table 133. Output Fields for the QUERY TRAN Command
Short Label Keyword Scope Meaning
TRAN N/A N/A Transaction name. A transaction defines the processing characteristics of messages destined for an application program. The transaction name is always returned.
MBR N/A N/A IMSplex member that built the output line. IMS identifier of IMS that built the output. The IMS identifier is always returned.
CC N/A N/A Completion code. The completion code indicates whether or not IMS was able to process the command for the specified resource. The completion code is always returned. Refer Table 135 for more information.
AFIN AFFIN GBL Affinity of the messages on the shared queues. AFFIN displays the IMSid/RSEname of the IMS system that the message can be processed on.
LCLS CLASS LCL Scheduling class used to determine which message regions can process the transaction locally on a particular IMS.
LCP CPRI LCL Local current scheduling priority. The current scheduling priority is used to calculate which transaction is selected for scheduling.
LLCT LCT LCL Limit count in the local IMS. The limit count is the number that, when compared to the number of input transactions queued and waiting to be processed, determines whether the normal or limit priority value is assigned to this transaction.
LLP LPRI LCL Local limit scheduling priority. The limit scheduling priority is the priority to which this transaction is raised when the number of input transactions enqueued and waiting to be processed is equal to or greater than the limit count value.
LMRG MAXRGN LCL Local maximum region count. The maximum region count is the maximum number of message processing program (MPP) regions that can be concurrently scheduled to process a transaction that is eligible for parallel scheduling.
LNP NPRI LCL Local normal scheduling priority. The normal scheduling priority is the priority assigned to this transaction when the number of input transactions enqueued and waiting to be processed is less than the limit count value.
LPLM PARLIM LCL Local parallel processing limit count. The parallel limit count is the maximum number of messages that can currently be queued, but not yet processed, by each active message region currently scheduled for this transaction. An additional message region is scheduled whenever the transaction queue count exceeds the PARLIM value multiplied by the number of regions currently scheduled for this transaction.
LPLCT PLCT LCL Local processing limit count. The processing limit count is the number of transaction messages a program can process in a single scheduling.
PSB PSB LCL PSB name associated with the transaction.
Q QCNT GBL Global transaction message queue count on the shared queues. Q is only displayed if shared queues are used.
LQ QCNT LCL Local transaction message queue count.
RGC RGC LCL Number of regions the transaction is currently scheduled in the local IMS.
LSNO SEGNO LCL Local application program output segment limit allowed in message queues for each GU call.
LSSZ SEGSZ LCL Local application program output segment size limit allowed in the message queues for each GU call.
LSTT STATUS LCL Local transaction status.

Return, Reason, and Completion Codes for QUERY TRAN

The return and reason codes that can be returned as a result of the QUERY TRAN command are standard for all commands entered through the OM API. Refer to the OM Return and Reason code section in the IMS Version 9: Common Service Layer Guide and Reference for the list of codes and their meanings.

Table 134 contains the return and reason codes that can be returned to OM from a QUERY TRAN command.

Table 134. Return and Reason Codes for the QUERY TRAN Command
Return Code Reason Code Meaning
X'00000000' X'00000000' The QUERY TRANcommand completed successfully.
X'00000004' X'00001000' The QUERY TRANcommand was not processed on the IMS system as the IMS system is not the command master. No resource information is returned.
X'00000004' X'00001004' The QUERY TRAN command was processed for a few resources and a partial list of resources is returned. The command terminated as the resource count to be returned exceeded the maximum number of resources that can be returned by a QUERY TRAN command.

The maximum number of resources that can be returned by a QUERY TRAN command is 5000. Re-issue the command with a generic mask or other filters so the number of resources to be returned is less than 5000.

X'00000004' |X'00001010' No resources were found to be returned. The resource name(s) specified may be invalid or there were no resources that match the filter specified.
X'00000008' X'00002040' The QUERY TRAN command has more than one filter value specified or an invalid filter value is specified for the QCNT filter. Only one of the CLASS, STATUS or QCNT filters may be specified. A value of 0 may have been specified for QCNT with LE, GE or, EQ. Or a value of 1 may have been specified for QCNT with LT.
X'00000008' X'0000204C' The CLASS value specified is invalid. Confirm the correct CLASS value is specified on the command.
X'0000000C' X'00003000' The QUERY TRAN command is successful for at least one resource name. The QUERY TRAN command is not successful for one or more resource names. The Completion Code indicates the reason for the error with the resource name. The Completion Codes that can be returned by the QUERY TRAN command are listed in the QUERY TRAN completion code table.
X'0000000C' X'00003004' The QUERY TRAN command is not successful for all the resource name(s) specified. The Completion Code indicates the reason for the error with the resource name. The Completion Codes that can be returned by the QUERY TRAN command are listed in the QUERY TRAN completion code table.
X'00000010' X'00004014' The QUERY TRAN command processing terminated as the TRAN keyword is not valid on the RSR tracker.
X'00000010' X'00004018' The QUERY TRAN command processing terminated as the RM resource structure is not available.
X'00000010' X'00004100' The QUERY TRAN command processing terminated as the resource structure is full.
X'00000010' X'00004104' The QUERY TRAN command processing terminated as there is no RM address space.
X'00000010' X'00004108' The QUERY TRAN command processing terminated as there is no SCI address space.
X'00000014' X'00005004' The QUERY TRAN command processing terminated as a DFSOCMD response buffer could not be obtained.
X'00000014' X'00005008' The QUERY TRAN command processing terminated as the DFSPOOL storage could not be obtained.
X'00000014' X'00005100' The QUERY TRAN command processing terminated due to a RM error.
X'00000014' X'00005108' The QUERY TRAN command processing terminated due to a SCI error.

Errors unique to the processing of this command are returned as a completion codes. A completion code is returned for each action against an individual resource.

Table 135 contains completion codes that can be returned on a QUERY TRAN command.

Table 135. Completion Codes for the QUERY TRAN Command
Completion Code Meaning
0 The QUERY TRAN command completed successfully for the resource.
10 The resource name is unknown to the client that is processing the request. The resource name may have been typed in error or the resource may not be active at this time. If this is a wildcard request there were no matches for the name. Confirm the correct spelling of the resource name is specified on the command.
50 The QUERY TRAN command could not be completed for the resource as CQS is not available. Make sure CQS is available before re-issuing the command.
51 The QUERY TRAN command could not be completed for the resource as there is no resource structure or it is unavailable.
52 The QUERY TRAN command could not be completed for the resource as the resource structure is full.
90 The QUERY TRAN command could not be completed for the resource due to an IMS internal error.
94 The QUERY TRAN command could not be completed for the resource due to a RM error.
98 The QUERY TRAN command could not be completed for the resource due to a CQS error.

Examples for QUERY TRAN Command

This section provides OM API and TSO SPOC input and output examples and explanations for the QUERY command.

Example 1 for QUERY TRAN Command

TSO SPOC input:

QRY TRAN NAME(OLCFT117,OLCTMSA*,OLCTB14*) SHOW(QCNT,CLASS,STATUS)  

TSO SPOC output:

Trancode MbrName    CC LCls    LQCnt LclStat 
OLCFT117 SYS3        0    1        0 FPE,RESP 
OLCTB140 SYS3        0    1        0 BAL      
OLCTB141 SYS3        0    5        0          
OLCTB148 SYS3        0    1        0 CONV     
OLCTMSA1 SYS3        0    1        0 RMT   

OM API input:

CMD(QRY TRAN NAME(OLCFT117,OLCTMSA*,OLCTB14*) SHOW(QCNT,CLASS,STATUS))

OM API output:

<imsout>
<ctl> 
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.163 17:00:12.393828</statime>
<stotime>2002.163 17:00:12.395024</stotime>
<staseq>B7C4BDCC96164DAB</staseq>
<stoseq>B7C4BDCC96610D2B</stoseq> 
<rqsttkn1>USRT002 10100012</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>SYS3    </master>
<userid>USRT002 </userid>
<verb>QRY </verb>
<kwd>TRAN            </kwd>
<input>QRY TRAN NAME(OLCFT117,OLCTMSA*,OLCTB14*) 
 SHOW(QCNT,CLASS,STATUS)</input> 
</cmd>
<cmdrsphdr>
<hdr slbl="TRAN" llbl="Trancode" scope="LCL" sort="a" key="1" scroll="no" len="8"
dtype=" CHAR" align="left" />
<hdr slbl="MBR"  llbl="MbrName"  scope="LCL" sort="a" key="4" scroll="no" len="8"
dtype="CHAR" align="left" /> 
<hdr slbl="CC"   llbl="CC"       scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" /> 
<hdr slbl="LCLS" llbl="LCls"     scope="LCL" sort="n" key="0" scroll="yes" len="3"
dtype="INT" align="right" />
<hdr slbl="LQ"   llbl="LQCnt"    scope="LCL" sort="d" key="3" scroll="yes" len="8"
dtype="INT" align="right" />
<hdr slbl="LSTT" llbl="LclStat"  scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>TRAN(OLCFT117) MBR(SYS3    ) CC(   0) LCLS(  1) LQ(    0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(OLCTMSA1) MBR(SYS3    ) CC(   0) LCLS(  1) LQ(    0) LSTT(RMT) </rsp>
<rsp>TRAN(OLCTB140) MBR(SYS3    ) CC(   0) LCLS(  1) LQ(    0) LSTT(BAL) </rsp>
<rsp>TRAN(OLCTB141) MBR(SYS3    ) CC(   0) LCLS(  5) LQ(    0) </rsp>
<rsp>TRAN(OLCTB148) MBR(SYS3    ) CC(   0) LCLS(  1) LQ(    0)  LSTT(CONV) </rsp>
</cmdrspdata>
</imsout>

Explanation: A QUERY TRAN command can be issued to obtain information about transactions on one or more IMSs in the IMSplex. This QUERY TRAN command is issued in an IMSplex with one active IMS SYS3 that is not shared queues enabled. The command returns all transactions that match the name OLCFT117 and wild card names OLCTMSA* and OLCTB14*. The output returned is based on the SHOW keyword options. The IMS SYS3 returns the local queue count, local class, and local status for each transaction found that match the NAME parameters. Because the IMS is not shared queues enabled, no global queue count response line is returned.

Example 2 for QUERY TRAN Command

TSO SPOC input:

QRY TRAN NAME(PART*) SHOW(QCNT,STATUS,CLASS,PSB)

TSO SPOC output:

Trancode MbrName    CC PSBname      QCnt LCls    LQCnt LclStat
PART     IMS3        0                 1                              
PART     IMS2        0 DFSSAM02             4        0                
PART     IMS3        0 DFSSAM02             4        0                
PART     SYS3        0 DFSSAM02             4        0                
PARTROOT IMS3        0                 0                              
PARTROOT IMS2        0 PARTAPP              1        0                
PARTROOT IMS3        0 TPARTAPP             1        0                
PARTROOT SYS3        0 TPARTAPP             1        0 

OM API input:

CMD ( QRY TRAN NAME(PART*) SHOW(QCNT,STATUS,CLASS,PSB)    )

OM API output:

<imsout>                                        
<ctl>                                           
<omname>OM1OM   </omname>                       
<omvsn>1.1.0</omvsn> 
<xmlvsn>1   </xmlvsn>
<statime>2002.174 23:20:59.381371</statime>
<stotime>2002.174 23:20:59.532136</stotime>
<staseq>B7D2E76D3DE7BD2C</staseq>
<stoseq>B7D2E76D62B68A49</stoseq>
<rqsttkn1>USRT005 10162059</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn> 
</ctl> 
<cmd> 
<master>IMS3  </master>
<userid>USRT005 </userid>
<verb>QRY </verb>
<kwd>TRAN </kwd>
<input>QRY TRAN NAME(PART*) SHOW(QCNT,STATUS,CLASS,PSB)    </input>
</cmd>
<cmdrsphdr>
<hdr slbl="TRAN" llbl="Trancode" scope="LCL" sort="a" key="1" scroll="no"  len="8"
dtype=" CHAR" align="left" />
<hdr slbl="MBR"  llbl="MbrName"  scope="LCL" sort="a" key="4" scroll="no"  len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"   llbl="CC"       scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" />
<hdr slbl="PSB"  llbl="PSBname"  scope="LCL" sort="n" key="0" scroll="yes" len="8"
dtype="CHAR" align="left" />
<hdr slbl="Q"    llbl="QCnt"     scope="GBL" sort="d" key="2" scroll="yes" len="8"
dtype="INT" align="right" />
<hdr slbl="LCLS" llbl="LCls"     scope="LCL" sort="n" key="0" scroll="yes" len="3"
dtype="INT" align="right" />
<hdr slbl="LQ"   llbl="LQCnt"    scope="LCL" sort="d" key="3" scroll="yes" len="8"
dtype="INT" align="right" />
<hdr slbl="LSTT" llbl="LclStat"  scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>TRAN(PARTROOT) MBR(IMS3    ) CC(   0) Q(    0) </rsp>
<rsp>TRAN(PARTROOT) MBR(IMS3    ) CC(   0) PSB(TPARTAPP) LCLS(  1) LQ(  0) </rsp>
<rsp>TRAN(PART    ) MBR(IMS3    ) CC(   0) Q(    1) </rsp>
<rsp>TRAN(PART    ) MBR(IMS3    ) CC(   0) PSB(DFSSAM02) LCLS(  4) LQ(  0) </rsp>
<rsp>TRAN(PARTROOT) MBR(SYS3    ) CC(   0) PSB(TPARTAPP) LCLS(  1) LQ(  0) </rsp>
<rsp>TRAN(PART    ) MBR(SYS3    ) CC(   0) PSB(DFSSAM02) LCLS(  4) LQ(  0) </rsp>
<rsp>TRAN(PARTROOT) MBR(IMS2    ) CC(   0) PSB(PARTAPP ) LCLS(  1) LQ(  0) </rsp>
<rsp>TRAN(PART    ) MBR(IMS2    ) CC(   0) PSB(DFSSAM02) LCLS(  4) LQ(  0) </rsp>
</cmdrspdata>
</imsout>

Explanation: The QUERY TRAN command returns information on the transactions that match the name parameter. This command is issued in an IMSplex that has 3 IMSs - IMS2, IMS3 and SYS3. The resource manager (RM) is using a resource structure and all IMSs are shared queues enabled. The command returns the transactions that match the wildcard name PART*. The output is based on the SHOW options specified. Each IMS processes the command while local information is requested with the SHOW keyword. Each IMS returns its local information for the PSB name, Class, local queue count, and local status associated with the transactions it found that matched the NAME PART*. The master IMS, IMS3, returned the global queue count information from shared queues for all transactions that match the NAME parameter PART*.

Example 3 for QUERY TRAN Command

TSO SPOC input:

QRY TRAN QCNT(GT,0) SHOW(AFFIN)

TSO SPOC output:

Trancode MbrName    CC     QCnt Affinity       
PART     IMS3        0        2                
SMQ6     IMS3        0        1 SYS3                    

OM API input:

CMD ( QRY TRAN QCNT(GT,0) SHOW(AFFIN))

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn> 
<xmlvsn>1   </xmlvsn>
<statime>2002.174 23:39:11.140576</statime>
<stotime>2002.174 23:39:11.191856</stotime>
<staseq>B7D2EB7E6CAE0127</staseq>
<stoseq>B7D2EB7E79330E8D</stoseq>
<rqsttkn1>USRT005 10163911</rqsttkn1>
<rc>0200000C</rc>
<rsn>00003000</rsn>
</ctl>
<cmderr>
<mbr name="SYS3    ">
<typ>IMS     </typ>
<styp>DBDC    </styp>
<rc>00000004</rc>
<rsn>00001000</rsn>
</mbr>
<mbr name="IMS2    ">
<typ>IMS     </typ>
<styp>DCCTL   </styp>
<rc>00000004</rc>
<rsn>00001000</rsn>
</mbr>
</cmderr>
<cmd>
<master>IMS3    </master>
<userid>USRT005 </userid>
<verb>QRY </verb>
<kwd>TRAN </kwd> 
<input>QRY TRAN QCNT(GT,0) SHOW(AFFIN)  </input> 
</cmd>
<cmdrsphdr>
<hdr slbl="TRAN" llbl="Trancode" scope="LCL" sort="a" key="1" scroll="no" len="8"
dtype=" CHAR" align="left" />
<hdr slbl="MBR"  llbl="MbrName"  scope="LCL" sort="a" key="4" scroll="no" len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"    llbl="CC"      scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" />
<hdr slbl="Q"     llbl="QCnt"    scope="GBL" sort="d" key="2" scroll="yes" len="8"
dtype="INT" align="right" />
<hdr slbl="AFIN" llbl="Affinity" scope="GBL" sort="n" key="0" scroll="yes" len="7"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>TRAN(PART    ) MBR(IMS3    ) CC(   0) Q(    2) AFIN(       ) </rsp>
<rsp>TRAN(SMQ6    ) MBR(IMS3    ) CC(   0) Q(    1) AFIN(SYS3   ) </rsp>
</cmdrspdata>
</imsout>

Explanation: The QUERY TRAN QCNT(GT,0) command returns all transactions that have a queue count greater than 0. This command is issued in an IMSplex with 3 IMSs - IMS2, IMS3 and SYS3. RM is using the resource structure and all IMSs are shared queues enabled. In a shared queues environment, the QUERY TRAN QCNT(GT,0) command is only processed by the master IMS because it can obtain the global queue counts. All transactions that have a queue count greater than 0 are returned by the master IMS which is IMS3. When SHOW(AFFIN) is specified, any affinity of the messages to an IMS is returned. In this example, transactions SMQ6 has a message queued that can be processed only on the IMS SYS3.

Example 4 for QUERY TRAN Command

TSO SPOC input:

QRY TRAN NAME(FPTR*) STATUS(FPE,RESP)

TSO SPOC output:

Trancode MbrName    CC LclStat    
FPTRN01  IMS3        0 RESP                  
FPTRN01  SYS3        0 RESP                  
FPTRN02  IMS3        0 FPE,RESP              
FPTRN02  SYS3        0 FPE,RESP              
FPTRN03  IMS3        0 FPE,RESP              
FPTRN03  SYS3        0 FPE,RESP              
FPTRN04  IMS3        0 FPE,RESP              
FPTRN04  SYS3        0 FPE,RESP              
FPTRN05  IMS3        0 FPE,RESP              
FPTRN05  SYS3        0 FPE,RESP              
FPTRN06  IMS3        0 FPE,RESP              
FPTRN06  SYS3        0 FPE,RESP

OM API input:

CMD ( QRY TRAN NAME(FPTR*) STATUS(FPE,RESP)  )

OM API output:

<imsout>                                       
<ctl>                                          
<omname>OM1OM   </omname>                      
<omvsn>1.1.0</omvsn>                                      
<xmlvsn>1   </xmlvsn>                                     
<statime>2002.174 23:47:42.864254</statime>               
<stotime>2002.174 23:47:42.865685</stotime>               
<staseq>B7D2ED667137E629</staseq>                         
<stoseq>B7D2ED6671915729</stoseq>                         
<rqsttkn1>USRT005 10164742</rqsttkn1>                     
<rc>0200000C</rc>                                         
<rsn>00003000</rsn>                                       
</ctl>                                                    
<cmderr>                                                  
<mbr name="IMS2    ">                                     
<typ>IMS     </typ>                                       
<styp>DCCTL   </styp>                                     
<rc>00000008</rc>                                         
<rsn>0000200C</rsn>                                       
</mbr>                                                    
</cmderr>                                                 
<cmd>                                                     
<master>IMS3    </master>                                 
<userid>USRT005 </userid>                                 
<verb>QRY </verb>                                         
<kwd>TRAN  </kwd>                               
<input>QRY TRAN NAME(FPTR*) STATUS(FPE,RESP)  </input>
</cmd>
<cmdrsphdr>
<hdr slbl="TRAN" llbl="Trancode" scope="LCL" sort="a" key="1" scroll="no" len="8"
dtype=" CHAR" align="left" /> 
<hdr slbl="MBR"  llbl="MbrName"  scope="LCL" sort="a" key="4" scroll="no" len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"   llbl="CC"       scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" />
<hdr slbl="LSTT" llbl="LclStat"  scope="LCL" sort="n" key="0" scroll="yes" len="*"
dtype="CHAR" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>TRAN(FPTRN01 ) MBR(IMS3    ) CC(   0) LSTT(RESP) </rsp>
<rsp>TRAN(FPTRN03 ) MBR(IMS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN02 ) MBR(IMS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN06 ) MBR(IMS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN04 ) MBR(IMS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN05 ) MBR(IMS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN01 ) MBR(SYS3    ) CC(   0) LSTT(RESP) </rsp>
<rsp>TRAN(FPTRN03 ) MBR(SYS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN02 ) MBR(SYS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN06 ) MBR(SYS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN04 ) MBR(SYS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
<rsp>TRAN(FPTRN05 ) MBR(SYS3    ) CC(   0) LSTT(FPE,RESP) </rsp>
</cmdrspdata>
</imsout>

Explanation: A QUERY TRAN NAME(FPTR*)STATUS(FPE,RESP) is issued to obtain all transactions that match the wildcard name FPTR* and also have one or more of the following status conditions:

This command is issued in an IMSplex with 3 IMSs - IMS2, IMS3 and SYS3. RM is using the resource structure and all IMSs are shared queues enabled. All IMSs process the command because the status is local. Each IMS returns the transactions that are defined locally that match the wildcard name FPTR* and have the status of FP, RESP, or both. The status condition that resulted in the transaction name being returned is also returned even though SHOW(STATUS) is not specified.

Example 5 for QUERY TRAN Command

TSO SPOC input:

QRY TRAN CLASS(6)  

TSO SPOC output:

Trancode MbrName    CC LCls   
HPCSTCL6 IMS3        0    6       
HPCSTCL6 SYS3        0    6       
OLCTB241 IMS2        0    6       
OLCTB241 IMS3        0    6       
OLCTB241 SYS3        0    6       
SKS6     IMS2        0    6       
SKS6     IMS3        0    6       
SKS6     SYS3        0    6                

OM API input:

CMD ( QRY TRAN CLASS(6)   )

OM API output:

<imsout>
<ctl>
<omname>OM1OM   </omname>
<omvsn>1.1.0</omvsn>
<xmlvsn>1   </xmlvsn>
<statime>2002.174 23:54:03.498534</statime>
<stotime>2002.174 23:54:03.500563</stotime>
<staseq>B7D2EED171826C43</staseq>
<stoseq>B7D2EED172013A43</stoseq>
<rqsttkn1>USRT005 10165403</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>IMS3    </master>
<userid>USRT005 </userid>
<verb>QRY </verb>
<kwd>TRAN            </kwd>
<input>QRY TRAN CLASS(6)  </input>
</cmd>
<cmdrsphdr>
<hdr slbl="TRAN" llbl="Trancode" scope="LCL" sort="a" key="1" scroll="no" len="8"
dtype=" CHAR" align="left" />
<hdr slbl="MBR"  llbl="MbrName"  scope="LCL" sort="a" key="4" scroll="no" len="8"
dtype="CHAR" align="left" />
<hdr slbl="CC"   llbl="CC"       scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" />
<hdr slbl="LCLS" llbl="LCls"     scope="LCL" sort="n" key="0" scroll="yes" len="3"
dtype="INT" align="right" />
</cmdrsphdr>
<cmdrspdata>
<rsp>TRAN(SKS6    ) MBR(IMS3    ) CC(   0) LCLS(  6) </rsp>
<rsp>TRAN(HPCSTCL6) MBR(IMS3    ) CC(   0) LCLS(  6) </rsp>
<rsp>TRAN(OLCTB241) MBR(IMS3    ) CC(   0) LCLS(  6) </rsp>
<rsp>TRAN(SKS6    ) MBR(SYS3    ) CC(   0) LCLS(  6) </rsp>
<rsp>TRAN(HPCSTCL6) MBR(SYS3    ) CC(   0) LCLS(  6) </rsp>
<rsp>TRAN(OLCTB241) MBR(SYS3    ) CC(   0) LCLS(  6) </rsp>
<rsp>TRAN(SKS6    ) MBR(IMS2    ) CC(   0) LCLS(  6) </rsp>
<rsp>TRAN(OLCTB241) MBR(IMS2    ) CC(   0) LCLS(  6) </rsp>
</cmdrspdata>
</imsout>

Explanation: A QUERY TRAN CLASS(6) is issued to obtain all transactions that have a local class value of 6. This command is issued in an IMSplex with 3 IMSs - IMS2, IMS3 and SYS3. RM is using the resource structure and all IMSs are shared queues enabled. All the IMSs that process the command as CLASS, are local. The NAME parameter is not specified so each IMS returns all the transactions defined locally with a class value 6. The class value that resulted in the transaction name being returned is also returned even though SHOW(CLASS) is not specified.

Go to the previous page Go to the next page

IBM Confidential

Downloads | Library | Support | Support Policy | Terms of use | Feedback
Copyright: IBM Corporation 1974, 2004 Copyright IBM Corporation 1974, 2004  timestamp Last updated: March, 2004