IBM Version 13 Commands, Volume 1: IMS Commands A - M IMS Manual
PDF
Documento
Pubblicità
Pubblicità
IMS Version 13 Commands, Volume 1: IMS Commands A - M SC19-3648-01 IMS Version 13 Commands, Volume 1: IMS Commands A - M SC19-3648-01 Note Before using this information and the product that it supports, be sure to read the general information under “Notices” on page 857. This edition applies to IMS Version 13 (program number 5635-A04), IMS Database Value Unit Edition, V13.1 (program number 5655-DSM), IMS Transaction Manager Value Unit Edition, V13.1 (program number 5655-TM2), and to all subsequent releases and modifications until otherwise indicated in new editions. © Copyright IBM Corporation 1974, 2014. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents About this information . . . . . . . . vii Prerequisite knowledge . . . . . . . . . . vii IMS function names used in this information . . . vii How new and changed information is identified . . vii How to read syntax diagrams . . . . . . . . viii Accessibility features for IMS Version 13 . . . . . ix How to send your comments . . . . . . . . . x Chapter 1. IMS command language overview . . . . . . . . . . . . . . 1 How to enter IMS commands. . . . . . . . . 2 IMS MFS 3270 master terminal format . . . . . 2 Using Multiple Console Support (MCS) consoles . 5 Outstanding reply numbers on z/OS consoles . . 5 Maximum length of command input from z/OS consoles . . . . . . . . . . . . . . . 5 Multisegment command input . . . . . . . 6 Commands in a DBCTL environment . . . . . 7 Commands from an LU 6.2 device . . . . . . 8 Qualifying network LU names and commands . . 8 Issuing commands to the OM API . . . . . . 9 Batch SPOC format . . . . . . . . . . . 10 Command responses . . . . . . . . . . . 12 Command responses to OM . . . . . . . . 12 Responses to LU 6.2 devices . . . . . . . . 13 Sending messages to the z/OS system console. . . 14 Sending messages to the IMS master terminal . . . 14 IMS terminal command examples . . . . . . . 14 TSO SPOC command examples. . . . . . . . 15 OM API command examples . . . . . . . . 15 IMS type-1 command format . . . . . . . . 16 IMS type-2 command format . . . . . . . . 21 Sending commands to the IMSplex . . . . . . 24 Command processing in an IMSplex . . . . . . 25 Command characteristics . . . . . . . . . . 26 Terminal security defaults for IMS type-1 commands 26 Commands recovered during emergency restart . . 28 Command processing in a dynamic resource definition environment . . . . . . . . . . 29 IMS type-1 commands logged to the secondary master terminal . . . . . . . . . . . . . 30 IMS type-1 commands supported from an AO application . . . . . . . . . . . . . . 31 Command security when using OM . . . . . . 36 Commands mirrored on an XRF alternate . . . . 36 Commands supported on the XRF alternate . . . 38 Commands and keywords supported on an RSR tracking subsystem . . . . . . . . . . . . 40 IMS-supported terminals in an RSR environment . . 42 IMS type-1 commands supported from LU 6.2 devices and OTMA . . . . . . . . . . . . 43 Terminal security defaults for LU 6.2 devices and OTMA . . . . . . . . . . . . . . . . 44 Commands and keywords supported by the OM API . . . . . . . . . . . . . . . . . 44 © Copyright IBM Corp. 1974, 2014 Equivalent IMS type-1 and type-2 commands . . . 47 Equivalent IMS Connect WTOR, z/OS, and type-2 commands. . . . . . . . . . . . . . . 55 Chapter 2. Command keywords and their synonyms . . . . . . . . . . . 63 Chapter 3. Commands and keywords valid in DBCTL . . . . . . . . . . . 85 Chapter 4. Commands and keywords valid in DCCTL . . . . . . . . . . . 87 Chapter 5. List of reserved words . . . 91 Chapter 6. IMS type-1 commands that are valid in ETO . . . . . . . . . . . 95 Chapter 7. /ACTIVATE command . . . . 97 Chapter 8. /ALLOCATE command . . . 99 Chapter 9. /ASSIGN command . . . . 101 Chapter 10. /BROADCAST command 121 Chapter 11. /CANCEL command . . . 127 Chapter 12. /CHANGE commands. . . 129 /CHANGE APPC command . /CHANGE CCTL command . /CHANGE CPLOG command. /CHANGE DESC command . /CHANGE DIR MFS command /CHANGE FDR command . . /CHANGE LINK command . /CHANGE NODE command . /CHANGE SUBSYS command /CHANGE SURV command . /CHANGE TRAN command . /CHANGE UOR command . /CHANGE USER command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 13. /CHECKPOINT command . . . . . . . . . . . . . 129 130 132 132 134 135 136 140 144 145 148 149 151 153 Chapter 14. /CLSDST command . . . 159 Chapter 15. /COMPT command . . . . 163 Chapter 16. /CQCHKPT command . . 167 iii Chapter 17. /CQQUERY command . . 169 Chapter 18. /CQSET command . . . . 173 Chapter 19. CREATE commands . . . 175 | | | | CREATE DB command . . . . . . . . CREATE DBDESC command . . . . . . CREATE IMSCON commands . . . . . . CREATE IMSCON TYPE(DATASTORE) command . . . . . . . . . . . CREATE IMSCON TYPE(PORT) command CREATE OTMADESC command . . . . . CREATE PGM command . . . . . . . CREATE PGMDESC command . . . . . CREATE RTC command . . . . . . . . CREATE RTCDESC command . . . . . . CREATE TRAN command . . . . . . . CREATE TRANDESC command . . . . . . . . . 175 . 183 . 189 . . . . . . . . . . . . . . . . . . 189 197 205 215 226 235 241 246 270 Chapter 20. /DBDUMP command . . . 293 Chapter 21. /DBRECOVERY command 299 Chapter 22. /DELETE command . . . 309 Chapter 23. DELETE commands . . . 311 DELETE DELETE DELETE DELETE DELETE DELETE DELETE DELETE DELETE DELETE DELETE DB command . . . DBDESC command . DEFN command . . LE command . . . OTMADESC command PGM command . . PGMDESC command RTC command . . . RTCDESC command . TRAN command . . TRANDESC command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 24. /DEQUEUE command . . . . . . . . . . . . . . . . . . . 311 319 325 339 346 349 355 360 365 370 376 . . 383 Chapter 25. /DIAGNOSE commands /DIAGNOSE SET command . /DIAGNOSE SNAP command . . . . . . . . . . . . . 391 . . . 391 . 392 Chapter 26. /DISPLAY commands . . . 433 Status and attributes for the /DISPLAY command /DISPLAY ACT command . . . . . . . . /DISPLAY AFFIN command . . . . . . . /DISPLAY AOITKN command . . . . . . /DISPLAY APPC command . . . . . . . /DISPLAY AREA command . . . . . . . /DISPLAY ASMT command . . . . . . . /DISPLAY CCTL command . . . . . . . /DISPLAY CONV command . . . . . . . /DISPLAY CPLOG command . . . . . . . /DISPLAY CQS command . . . . . . . . /DISPLAY DB command . . . . . . . . /DISPLAY DBD command . . . . . . . . iv Commands, Volume 1: IMS Commands A - M . . . . . . . . . . . . 435 448 464 467 468 470 476 485 488 492 493 493 504 /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY /DISPLAY DESC command . . . . . . FDR command . . . . . . . FPV command . . . . . . . HSB command . . . . . . . HSSP command. . . . . . . LINE command . . . . . . . LINK command. . . . . . . LTERM command . . . . . . LUNAME command . . . . . MASTER command . . . . . MODIFY command . . . . . MSNAME command . . . . . NODE command . . . . . . OASN SUBSYS command . . . OLDS command . . . . . . OTMA command . . . . . . OVERFLOWQ command. . . . PGM command . . . . . . . POOL command . . . . . . PSB command . . . . . . . PTERM command . . . . . . Q command . . . . . . . . QCNT command . . . . . . RECOVERY command . . . . RTCODE command . . . . . SHUTDOWN STATUS command . STATUS command . . . . . . STRUCTURE command . . . . SUBSYS command . . . . . . SYSID TRANSACTION command TIMEOVER command . . . . TMEMBER command . . . . . TRACE command . . . . . . TRACKING STATUS command . TRAN command . . . . . . UOR command . . . . . . . USER command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 506 507 509 512 513 517 521 525 530 531 545 547 558 559 562 567 570 573 592 593 595 598 603 609 610 616 623 624 627 628 629 641 651 659 664 667 Chapter 27. /END command . . . . . 675 Chapter 28. /ERESTART command 677 Chapter 29. /EXCLUSIVE command 689 Chapter 30. /EXIT command . . . . . 691 Chapter 31. EXPORT command. . . . 695 Chapter 32. /FORMAT command . . . 727 Chapter 33. /HOLD command . . . . 729 Chapter 34. /IAM command . . . . . 731 Chapter 35. /IDLE command . . . . . 733 Chapter 36. IMPORT command . . . . 737 Chapter 37. INITIATE commands . . . 775 Chapter 43. /MSASSIGN command INITIATE OLC command . . . INITIATE OLC error handling. INITIATE OLREORG command . Chapter 44. /MSVERIFY command . . 853 . . . Chapter 38. /LOCK command . . . . . . . . . . . . . 775 . 815 . 818 Notices . . . . . . . . . . . . . . 857 . . . . 831 Chapter 39. /LOG command . . . . . 837 Chapter 40. /LOOPTEST command Chapter 41. /MODIFY command 849 | Programming interface information . Trademarks . . . . . . . . . Privacy policy considerations . . . . . . . . . . . . . . . . 859 . 859 . 860 839 Bibliography . . . . . . . . . . . . 861 . . . 841 Index . . . . . . . . . . . . . . . 863 Chapter 42. /MONITOR command . . . 847 Contents v vi Commands, Volume 1: IMS Commands A - M About this information These topics provide command syntax and usage information for the IMS™ type-1 and type-2 commands /ACTIVATE through /MSVERIFY. The topics also describe the IMS command language and how to send commands to IMS in different environments. Information about all non-type-1 and non-type-2 IMS commands is in IMS Version 13 Commands, Volume 3: IMS Component and z/OS Commands. This information is available in IBM® Knowledge Center at www.ibm.com/ support/knowledgecenter. Prerequisite knowledge Before using this information, you should have knowledge of either IMS Database Manager (DB) or IMS Transaction Manager (TM). You should also understand basic z/OS® and IMS concepts, your installation's IMS system, and have general knowledge of the tasks involved in project planning. Recommendation: Before using this information, you should be familiar with the following resources: v IMS Version 13 Operations and Automation v z/OS JES2 Commands v z/OS JES3 Commands v z/OS MVS™ System Commands You can learn more about z/OS by visiting the “z/OS basic skills education” topics in IBM Knowledge Center. You can gain an understanding of basic IMS concepts by reading An Introduction to IMS, an IBM Press publication. An excerpt from this publication is available in the IBM Knowledge Center. IBM offers a wide variety of classroom and self-study courses to help you learn IMS. For a complete list of courses available, go to the IMS home page at ibm.com/ims and link to the Training and Certification page. IMS function names used in this information In this information, the term HALDB Online Reorganization refers to the integrated HALDB Online Reorganization function that is part of IMS Version 13, unless otherwise indicated. How new and changed information is identified New and changed information in most IMS library PDF publications is denoted by a character (revision marker) in the left margin. The first edition (-00) of Release Planning, as well as the Program Directory and Licensed Program Specifications, do not include revision markers. Revision markers follow these general conventions: © Copyright IBM Corp. 1974, 2014 vii v Only technical changes are marked; style and grammatical changes are not marked. v If part of an element, such as a paragraph, syntax diagram, list item, task step, or figure is changed, the entire element is marked with revision markers, even though only part of the element might have changed. v If a topic is changed by more than 50%, the entire topic is marked with revision markers (so it might seem to be a new topic, even though it is not). Revision markers do not necessarily indicate all the changes made to the information because deleted text and graphics cannot be marked with revision markers. How to read syntax diagrams The following rules apply to the syntax diagrams that are used in this information: v Read the syntax diagrams from left to right, from top to bottom, following the path of the line. The following conventions are used: – The >>--- symbol indicates the beginning of a syntax diagram. – The ---> symbol indicates that the syntax diagram is continued on the next line. – The >--- symbol indicates that a syntax diagram is continued from the previous line. – The --->< symbol indicates the end of a syntax diagram. v Required items appear on the horizontal line (the main path). required_item v Optional items appear below the main path. required_item optional_item If an optional item appears above the main path, that item has no effect on the execution of the syntax element and is used only for readability. optional_item required_item v If you can choose from two or more items, they appear vertically, in a stack. If you must choose one of the items, one item of the stack appears on the main path. required_item required_choice1 required_choice2 If choosing one of the items is optional, the entire stack appears below the main path. required_item optional_choice1 optional_choice2 viii Commands, Volume 1: IMS Commands A - M If one of the items is the default, it appears above the main path, and the remaining choices are shown below. default_choice required_item optional_choice optional_choice v An arrow returning to the left, above the main line, indicates an item that can be repeated. required_item repeatable_item If the repeat arrow contains a comma, you must separate repeated items with a comma. , required_item repeatable_item A repeat arrow above a stack indicates that you can repeat the items in the stack. v Sometimes a diagram must be split into fragments. The syntax fragment is shown separately from the main syntax diagram, but the contents of the fragment should be read as if they are on the main path of the diagram. required_item fragment-name fragment-name: required_item optional_item v In IMS, a b symbol indicates one blank position. v Keywords, and their minimum abbreviations if applicable, appear in uppercase. They must be spelled exactly as shown. Variables appear in all lowercase italic letters (for example, column-name). They represent user-supplied names or values. v Separate keywords and parameters by at least one space if no intervening punctuation is shown in the diagram. v Enter punctuation marks, parentheses, arithmetic operators, and other symbols, exactly as shown in the diagram. v Footnotes are shown by a number in parentheses, for example (1). Accessibility features for IMS Version 13 Accessibility features help a user who has a physical disability, such as restricted mobility or limited vision, to use information technology products successfully. About this information ix Accessibility features The following list includes the major accessibility features in z/OS products, including IMS Version 13. These features support: v Keyboard-only operation. v Interfaces that are commonly used by screen readers and screen magnifiers. v Customization of display attributes such as color, contrast, and font size. Keyboard navigation You can access IMS Version 13 ISPF panel functions by using a keyboard or keyboard shortcut keys. For information about navigating the IMS Version 13 ISPF panels using TSO/E or ISPF, refer to the z/OS TSO/E Primer, the z/OS TSO/E User's Guide, and the z/OS ISPF User's Guide Volume 1. These guides describe how to navigate each interface, including the use of keyboard shortcuts or function keys (PF keys). Each guide includes the default settings for the PF keys and explains how to modify their functions. Related accessibility information Online documentation for IMS Version 13 is available in IBM Knowledge Center. IBM and accessibility See the IBM Human Ability and Accessibility Center at www.ibm.com/able for more information about the commitment that IBM has to accessibility. How to send your comments Your feedback is important in helping us provide the most accurate and highest quality information. If you have any comments about this or any other IMS information, you can take one of the following actions: v Click the Feedback link at the bottom of any IBM Knowledge Center topic. v Send an email to [email protected]. Be sure to include the book title and the publication number. x Commands, Volume 1: IMS Commands A - M Chapter 1. IMS command language overview You can use the IMS master terminal, TSO SPOC, or the OM API to receive messages, issue commands, and receive command responses. IMS supports two types of command formats to manage IMS systems and resources: IMS type-1 commands and IMS type-2 commands. You can enter IMS type-1 commands through multiple terminal types and applications, and most can be entered through the OM API. IMS type-2 commands can be entered only from the OM API. z/OS commands can be entered only from a z/OS system console, not from an IMS master terminal. IMS type-1 commands IMS type-1 commands can be entered from IMS terminals, master terminals, system consoles, EMCS consoles, IMS application programs through CMD calls and ICMD calls, and LU 6.2 and OTMA applications. IMS type-1 commands are in the original or classic IMS command syntax, and are preceded by a command recognition character if the command is issued from one of these interfaces. Most IMS type-1 commands can also be entered from the OM API, but not all of them. If the command is issued from the OM API, the command recognition character is optional. Use RACF® or an equivalent security product for security checking. IMS type-1 command output from the OM API is in message format within an XML tag structure. IMS type-2 commands IMS type-2 commands can be entered only from the OM API, not from a master or remote terminal. Either RACF (or an equivalent security product) or command security can be used for security checking. IMS type-2 command output is in XML tag structure. Both IMS type-1 commands and type-2 commands can be entered from the OM API (for example, TSO SPOC, IMS Control Center, or user-written programs using OM API). Subsections: v “How to enter IMS commands” on page 2 v “Command responses” on page 12 v “Sending messages to the z/OS system console” on page 14 v v v v v v v “Sending messages to the IMS master terminal” on page 14 “IMS terminal command examples” on page 14 “TSO SPOC command examples” on page 15 “OM API command examples” on page 15 “IMS type-1 command format” on page 16 “Command processing in an IMSplex” on page 25 “IMS type-2 command format” on page 21 v “Command characteristics” on page 26 v “Terminal security defaults for IMS type-1 commands” on page 26 v “Commands recovered during emergency restart” on page 28 © Copyright IBM Corp. 1974, 2014 1 v v v v v “IMS type-1 commands logged to the secondary master terminal” on page 30 “Command security when using OM” on page 36 “IMS type-1 commands supported from an AO application” on page 31 “Commands mirrored on an XRF alternate” on page 36 “Commands supported on the XRF alternate” on page 38 v “Commands and keywords supported on an RSR tracking subsystem” on page 40 v “IMS-supported terminals in an RSR environment” on page 42 v “IMS type-1 commands supported from LU 6.2 devices and OTMA” on page 43 v “Terminal security defaults for LU 6.2 devices and OTMA” on page 44 v “Commands and keywords supported by the OM API” on page 44 v “Equivalent IMS type-1 and type-2 commands” on page 47 Related reference: “IMS type-1 command format” on page 16 “IMS type-2 command format” on page 21 “Commands and keywords supported by the OM API” on page 44 How to enter IMS commands These topics describe how to enter various types of IMS commands. Subsections: v “IMS MFS 3270 master terminal format” v “Using Multiple Console Support (MCS) consoles” on page 5 v “Outstanding reply numbers on z/OS consoles” on page 5 v “Maximum length of command input from z/OS consoles” on page 5 v “Multisegment command input” on page 6 v “Commands in a DBCTL environment” on page 7 v “Commands from an LU 6.2 device” on page 8 v “Qualifying network LU names and commands” on page 8 v “Issuing commands to the OM API” on page 9 v “Batch SPOC format” on page 10 Related concepts: REXX SPOC API (Operations and Automation) Controlling IMS with the TSO SPOC application (Operations and Automation) IMS MFS 3270 master terminal format You can use the IMS master terminal for messages, commands, and responses. The IMS master terminal consists of two components of the IBM 3270 Information Display System: v A 3270 display screen with 24 lines by 80 columns; a screen size of 1920 characters v A 3270 printer All IMS system messages for the master terminal are sent to the display screen. 2 Commands, Volume 1: IMS Commands A - M The format of the display screen is normally divided into five areas: v System status area (line 1) v Message area (lines 2-10) v Display area (lines 12-21) v Warning message area (line 22) v User input area (lines 23 and 24) The following figure shows the format of the master terminal display screen. yy/mm/dd hh:mm:ss IMS id Message Area (9 lines) -------------------------------------------------------------------------------- Display Area (10 lines) Warning Message Area (1 line) User Input Area (2 lines) PASSWORD: Figure 1. Master terminal format The following figure shows the format of the master terminal display screen in an extended recovery facility (XRF) environment. 85/05/15 14:24:40 RSENAME: DFSRSENM BACKUP TRACKING IN PROGRESS IMSA Message Area (9 lines) -------------------------------------------------------------------------------- Display Area (10 lines) Warning Message Area (1 line) User Input Area (2 lines) PASSWORD: Figure 2. Master terminal format in XRF environment System status area This area (line 1) displays the date, time, and IMS identifier: Date The current date Time The current time IMS Identifier IMS system ID If the system is XRF capable, the following information is also displayed on the status line: RSEname Recoverable service element name System ACTIVE or BACKUP (field is completed following the initialization phase) Phase Blank or one of the following: Initialization Active or alternate system is in initialization phase Synchronization Alternate system processing SNAPQ checkpoint Chapter 1. IMS command language overview 3 Tracking in progress Alternate system synchronized with active system and in the process of tracking active system Takeover in progress Alternate system in the process of taking over from active system Awaiting I/O prevention New active system is in I/O toleration mode and is awaiting completion of I/O prevention on the failing system prior to becoming a true active system Message area This area (lines 2 through 10) displays IMS system messages, messages from other terminals and programs, and responses to IMS commands, except responses to a /DISPLAY command. If the message area is full and more output needs to be displayed, a warning message is sent. Press the PA1 key to receive more output. New data is displayed on the top line followed by a blank line to separate new data from old messages. Display area This area (lines 12 through 21) displays the output from a /DISPLAY command. If the response to the command exceeds the size of the area, a warning message is sent. Warning message area This area (line 22) can contain one of the following warning messages: MASTER LINES WAITING A message being displayed in the message area has exceeded the available space and is only partially displayed. MASTER MESSAGE WAITING The message area is full, and a message from another terminal or program is waiting to be displayed. DISPLAY LINES WAITING The output of a /DISPLAY command exceeds the size of the display area. USER MESSAGE WAITING A message requiring the screen to be formatted differently is waiting to be displayed. In all cases, press the PA1 key to receive the waiting output. The literal PASSWORD is followed by an unprotected field with the nondisplay attribute at the end of line 22. User input area This area (lines 23 and 24) is used to enter IMS commands. It consists of two 79-character segments, so you can enter multisegment commands such as /BROADCAST, /CHANGE, /RMxxxxxx, and /SSR. For example, to send a message to all active terminals, enter /BROADCAST ACTIVE on line 23 and enter the message text on line 24. The cursor is initially positioned by IMS to line 23, your first input line. 4 Commands, Volume 1: IMS Commands A - M Using Multiple Console Support (MCS) consoles You can enter IMS commands from Multiple Console Support (MCS) or Extended Multiple Console Support (E-MCS) consoles. Use the CMDMCS keyword for the IMS, DBC, or DCC procedures during IMS system definition to enable commands to be entered from MCS or E-MCS consoles. In a DB/DC environment, if Multiple Console is enabled (CMDMCS other than 'n' specified), IMS commands can be entered from an MCS or E-MCS console by prefixing the command by either the CRC or IMSID. For example, if the CRC is '#', a valid command would be #DIS A. If the IMSID is 'IMSP', a valid command would be IMSPDIS A. Each segment of an IMS command must begin with one of the following: v The command-recognition character for the IMS subsystem v The IMS ID of the IMS subsystem For multisegment commands, each segment, except the last, must end with the command recognition character or IMS ID followed by the ENTER key. The last segment must end with only the EOM (end-of-message, or ENTER) character. You can send commands to all the IMS systems in an IMSplex by using an automated operations single-point-of-control (SPOC) application that sends commands and receives the responses to those commands through the Operations Manager (OM) application programming interface (API). When you are using a Resource Manager (RM) structure in an IMSplex, it is best to issue commands to the Operations Manager (OM) through the TSO SPOC. Outstanding reply numbers on z/OS consoles Outstanding reply numbers are used only on z/OS system consoles. They are used to pass input directly to IMS. Terminals defined to IMS do not use outstanding reply numbers. As an example, IMS might display the following on the z/OS console: *48 DFS996I *IMS READY* To communicate with IMS through the z/OS system console, you must reply with the outstanding reply number (in this example, the number is 48). A reply might look like this: R 48,/START DC After IMS responds to the command, the next outstanding reply number is displayed with the DFS996I message, as follows: DFS058I START COMMAND COMPLETED *49 DFS996I *IMS READY* Maximum length of command input from z/OS consoles For single-segment commands that are entered from the z/OS console, the maximum character length (including command recognition characters) is 118. This limit comes from the implementation of the WTOR macro. Chapter 1. IMS command language overview 5 Multisegment command input Multisegment commands require an EOS (end-of-segment) indicator for all segments preceding the last segment, and an EOM (end-of-message) indicator for the last segment. The EOS and EOM will vary, depending on the type of terminal entering the command. For example, on the system console, EOS is indicated by the ENTER key and EOM is indicated by entering a period followed by the ENTER key. The following are multisegment commands: v /ALLOCATE v /BROADCAST v /CHANGE v /ERESTART v /LOOPTEST v /OPNDST v /RMxxxxxx v /SSR The period is used both as a delimiter for comments on IMS commands and as an EOM indicator for some terminal types. The following four examples illustrate the use of the period in both contexts. Example 1 for multisegment commands System console entry: 24,/BRO MASTER. END OF DAY MESSAGE 25,I AM GOING HOME. PLEASE TAKE OVER. Response on master terminal: I AM GOING HOME. PLEASE TAKE OVER. Explanation: The first input segment (reply 24) contains only the command and consists of a comment (END OF DAY MESSAGE) separated from the command itself (BRO MASTER) by a period. The second input segment (reply 25) consists of the data to be broadcast. The first period in segment 2 is part of the data and the second period in segment 2 is the EOM indicator for the system console. Example 2 for multisegment commands System console entry: 26,/CHANGE DIRECT 27,ORY MFS. MODIFICATION. Explanation: MODIFICATION in segment 2 is a comment and is separated from the command by the first period. The second period in segment 2 is the EOM indicator for the system console. The above 2 segments are combined and the following is input to the command processor: /CHANGE DIRECTORY MFS. MODIFICATION Example 3 for multisegment commands System console entry: 6 Commands, Volume 1: IMS Commands A - M 28,/CHANGE LINK 1 29,2 3 FORCSESS. Explanation: Certain forms of reply to the system console “outstanding reply” can compress out leading blanks from input segments. In example three, the command processed by the /CHANGE command processor would be: /CHANGE LINK 12 3 FORCSESS. To obtain the desired command, /CHANGE LINK 1 2 3 FORCSESS, one of the following forms of reply could be used: R 29,’/CHANGE LINK 1’ R 30,’ 2 3 FORCSESS.’ or 29,/CHANGE LINK 1 30, 2 3 FORCSESS Example 4 for multisegment commands LU2 or 3270 Display Terminal entry: /FORMAT DFSM04 /BRO LTERM WTOR this is segment this is segment this is segment (eos) 1 (eos) 2 (eos) 3 (eom) Explanation: The remote terminal is first formatted by the/FORMAT command, where default format DFSMO4 supports the input of 4 segments. For LU2 and 3270 display terminals, enter a /FORMAT DFSM04 command before entering the multisegment command. Related reference: Chapter 10, “/BROADCAST command,” on page 121 Commands in a DBCTL environment In a DBCTL environment, there are no outstanding reply numbers for z/OS consoles, and therefore none should be entered. For a command, just enter the command recognition character (slash or other character preceding the verb) or IMS ID, followed by the command. DBCTL does not respond with the DFS996I outstanding reply number. Examples for DBCTL commands System console entry for single-segment command: ¢DIS DB PAYROLL Explanation: ¢ is the command-recognition character for the DBCTL subsystem. IMS1DIS DB PAYROLL Explanation: IMS1 is the IMS ID for the DBCTL subsystem. System console entry for multisegment command: /RMI DBRC=’IC DBD(DEDBDD01) AREA (DD01AR0) ICDSN(FVT31.DEDBDD01.DD01 AR0.IC.DUMMY1) ICDSN2/ /(FVT31.DEDBDD01.DD01AR0.IC2.DUMMY1) HSSP’ Explanation: The first segment of the /RMI command has the command recognition character at the beginning of the segment and at the end of the Chapter 1. IMS command language overview 7 segment, to indicate another segment follows. The last segment has the command recognition character at the beginning of the segment only. Commands from an LU 6.2 device To enter a command from an LU 6.2 device, allocate a conversation using an IMS command verb as the TPNAME. The “/” must be included in the command word. The password option is not valid. (The password must be supplied as a part of the LU 6.2 ALLOCATE from the partner.) The normal LU 6.2 security provisions apply for this transaction. Restriction: The APPC synchronization level of CONFIRM is ignored for commands from LU 6.2 devices. The following three examples show the sequence of steps used to issue commands by allocating a synchronous conversation on an LU 6.2 device: Example 1 for commands from an LU 6.2 device ALLOCATE -LUNAME=luname of IMS -TPNAME=/DISPLAY SEND -DATA=LTERM VA01 VA02.comments PREPARE_TO_RECEIVE RECEIVE RECEIVE RECEIVE RECEIVE RC=DEALLOCATE (Single segment command) (Data after period treated as comments) (Get (Get (Get (Get header) output for LTERM VA01) output for LTERM VA02) time stamp) Example 2 for commands from an LU 6.2 device ALLOCATE -LUNAME=luname of IMS -TPNAME=/CHANGE SEND -DATA=NODE SEND -DATA=VAT02 ASR OFF.comments PREPARE_TO_RECEIVE RECEIVE RC=DEALLOCATE (Multisegment command) (Can spread over several SENDs) (Data after period treated as comments) (Get DFS058 CHANGE COMMAND COMPLETED) Example 3 for commands from an LU 6.2 device ALLOCATE -LUNAME=luname of IMS -TPNAME=/BROADCAST SEND -DATA=NODE VAT0* SEND -DATA=HELLO, HOW ARE YOU ALL? PREPARE_TO_RECEIVE RECEIVE RC=DEALLOCATE (1st SEND: the destination) (Subsequent SENDs: message to broadcast) (Get DFS058 BROADCAST COMMAND COMPLETED) Qualifying network LU names and commands Qualifying LU names gives the system administrator the liberty of using the same name for LUs on different systems by adding the network identifier. This eliminates the necessity to have unique names for every LU on every system in your complex. 8 Commands, Volume 1: IMS Commands A - M A network-qualified LU name consists of a network identifier of the originating system that is 1 to 8 characters long, a period, and then the LU name, which is 1 to 8 characters long. IMS commands that include network-qualified LU names must be enclosed in single quotes. For example: ’NETID001.LUAPPC02’. No blanks are allowed in a network-qualified LU name. The parameter ALL for either the network identifier or the LU name cannot be substituted in a command for a network-qualified LU name. ALL cannot represent all of the LU names or all of the networks. The LU name in the LU 6.2 descriptors can be network-qualified. The network-qualified LU name is optional on commands that support the LUNAME keyword. Issuing commands to the OM API You can issue commands to the OM API and receive responses from the API by using a single point of control (SPOC) application (such as the TSO SPOC, which is shipped with IMS) or the Control Center. Related concepts: CSL OM automated operator program clients (System Programming APIs) TSO SPOC format The TSO SPOC is an IBM-supplied application that can issue operator commands in an IMSplex. The TSO SPOC application uses an ISPF panel interface and communicates with an Operations Manager (OM) address space. OM then communicates with all of the other address spaces in the IMSplex (for example, IMS) as required for operations. TSO SPOC can issue all type-2 commands and it has a set of panels dedicated to the task of managing resources (also known as issuing DRD-related commands). There can be more than one TSO SPOC in an IMSplex. However, the TSO SPOC is optional in an IMSplex. The TSO SPOC provides the following functions to an IMSplex: v Presents a single system image for an IMSplex by allowing the user to issue commands to all IMS systems in the IMSplex from a single console. v Displays consolidated command responses from multiple IMS address spaces. v Sends a message to an IMS terminal connected to any IMS control region in the IMSplex by using the IMS /BROADCAST command. There are several ways to issue commands in the IMS TSO SPOC application: v By command line v By retrieving a command – Using the ISPF RETRIEVE command – Using a command listed in the response area – Using the Command status panel v By defining and using command shortcuts You can use these methods in any combination at any time. Chapter 1. IMS command language overview 9 The following figure shows the format of the TSO SPOC screen. File Display View Options Help -----------------------------------------------------------PLEX1 IMS Single Point of Control Command ==> ________________________________________________ ____________________________________________________________ --------------------- Plex . _____ Route . _____ Wait . ____ Response for: CSLM000I (C) Copyright IBM Corp. 2000. All rights reserved. F1=Help f3=Exit F4=Showlog F6=Expand F9=Retrieve F12=Cancel Figure 3. TSO SPOC screen format You can issue both IMS type-1 commands and type-2 commands using the TSO SPOC interface. Enter the command next to the command prompt (Command ==> in the figure above). Enter the IMSplex name in the Plex field. Enter the list of IMS systems to which to route the command, if applicable, in the Route field. After you type the command, press Enter. The command issued is shown in the Response for: field and the actual command response is shown below the Response for: field. Entering comments from a TSO SPOC For type-1 IMS commands, a period ends a command and anything after it is a comment. The following example shows a type-1 IMS command with a comment. /DISPLAY ACT .a test comment For type-2 commands, the comment must be enclosed in a slash and asterisk. At the end of the last parameter of the command, type a forward slash followed by an asterisk, then the comment text, followed by an asterisk and slash. The comment text must not have an embedded asterisk slash in it. The following is an example of a command with a comment: QUERY TRAN NAME(PART) SHOW(QCNT) /*Show queue count for tran part*/ Control Center format The IMS Control Center, included in the IBM DB2 Universal Database™ Control Center, uses the IMS Single Point of Control (SPOC) functions to enable IMS systems management from a workstation. You can issue and view IMS type-1 and type-2 commands from the IMS Control Center. There are online wizards that help you build and issue commands. The Control Center command output is similar to the output displayed from the TSO SPOC. The same information is provided, but formatted in a graphical interface based on the Windows system. For information about installing and using the IMS Control Center, see the IBM Knowledge Center. Batch SPOC format The Batch SPOC is a utility program that uses OM services to submit IMS operator commands to an IMSplex. The utility program is not specific to DRD commands; it accepts any commands that are supported by the OM API. The Batch SPOC utility is invoked by use of standard JCL statements. The following example shows a simple invocation: 10 Commands, Volume 1: IMS Commands A - M //SPOCJOB JOB , // MSGCLASS=H,NOTIFY=&SYSUID,USER=&SYSUID//* //SPOC EXEC PGM=CSLUSPOC, // PARM=(’IMSPLEX=PLEX1,ROUTE=IMS3,WAIT=30’) //STEPLIB DD DISP=SHR,DSN=IMS.SDFSRESL //SYSPRINT DD SYSOUT=* //SYSIN DD * QRY IMSPLEX SHOW(MEMBER,TYPE, + STATUS) QRY TRAN NAME(INV1*) SHOW(ALL) /* inventory appl */ /*EOF The program parameters define the IMSplex environment. The parameter keywords are: IMSPLEX The 1-to-5 character suffix of the IMSplex name. This parameter is required. ROUTE The SYSIDs of IMSplex members that are to run the command. If ROUTE is not specified, all members of the IMSplex will run the command. If more than one member is specified, enclose the list in parenthesis and separate the names with commas. WAIT Specifies the wait time for individual commands. The wait value is in minutes and seconds (MMM:SS) or just seconds (SSSSS). OM will return a single response as soon as a response is received from all of the members of the IMSplex. If the interval expires, OM will return any responses from IMSplex members, plus an indication that some did not reply. The Batch SPOC will wait for each command to complete before issuing the next command. The default wait value is five minutes (5:00). The WAIT time applies to every command in the SYSIN file. The user can specify a wait time of zero seconds; in this case, the Batch SPOC issues a command but does not wait for the response. The SYSIN file is provided by the user and contains the commands that the user wants to run. The commands are run serially. When one command completes, the next command is run until all records from the SYSIN file are processed. Continuation of the SYSIN control statements is specified by a plus sign (+) or a minus sign (-) as the last non-blank character of the line. A plus sign removes the leading spaces from the next line; a minus sign keeps leading spaces. Comments can be included within the SYSIN file and are specified as: /* this is a comment */ The SYSPRINT file will have the formatted command response. If more than one command is issued, the responses will appear in the same order as the commands appear in the SYSIN file. The default record length is 133. The command response is formatted in a similar format as the TSO SPOC display. If the records are too long, they wrap to the next line. The user may specify DCB information in the JCL or in the data set allocation to allow longer records in the SYSPRINT file. System Display and Search Facility (SDSF) can be used to view batch job output. The following is an example of batch job output: ======================================================== Log for. . : QRY IMSPLEX SHOW(MEMBER,TYPE,STATUS) IMSplex . . . . . : PLEX1 Routing . . . . . : Start time. . . . : 2005.132 15:36:28.11 Stop time . . . . : 2005.132 15:36:29.17 Chapter 1. IMS command language overview 11 Return code . . . : 00000000 Reason code . . . : 00000000 Command master. . : SYS3 IMSplex MbrName CC Member Type Status CSLPLEX1 OM1 0 SYS3 DBDC ACTIVE CSLPLEX1 OM1 0 IMS2 DBDC ACTIVE ======================================================= If no wait time, WAIT=0, is specified, the command response is not available and therefore are not printed. The SYSPRINT file will only have short summary information for each command. The following is an example of bath job output with no response: ======================================================== Log for. . : QRY IMSPLEX SHOW(MEMBER,TYPE,STATUS) IMSplex . . . . . : PLEX1 Routing . . . . . : Start time. . . . : 2006.075 15:36:28.11 ======================================================== Command responses With the exception of the /DISPLAY command, /FORMAT command, and type-2 commands returned through the OM API, responses to IMS commands are prefixed by the letters DFSnnn; nnn identifies the message. A response to an IMS command is an acknowledgment from IMS to the originating terminal that the command has been received. Responses that go to the system console have an IMS ID that identifies the IMS system that issued the message. For example, the response to /DBDUMP DATABASE MSDB would be: DFS058I (time stamp) DBDUMP COMMAND IN PROGRESS (IMS id) At system definition, the TIMESTAMP/NOTIMESTP parameter of the COMM macro determines whether the time stamp is present or absent. If the time stamp feature is included, the date and time of the response appear between the response prefix and the text. The DFS058 COMMAND COMPLETED/IN PROGRESS response indicates whether IMS accepted the command. If some parameters of the command are not accepted, the response includes the EXCEPT phrase and indicates the parameters that were not accepted. If IMS does not have the space for all of the not-accepted parameters, it truncates the EXCEPT phrase and terminates it with ...etc.. Commands that specify the ALL parameter are most likely to be truncated. Truncated EXCEPT phrases on commands are normally caused by: v Misspelling a parameter v Specifying an invalid parameter for the command v Specifying the ALL parameter for resources when some of them are already in the requested state Related reference: XML tags returned as CSL OM responses (System Programming APIs) Command responses to OM When an IMS type-2 command or IMS type-1 command is issued from the Operations Manager (OM) API, OM routes it (through the Structured Call Interface (SCI)) to one or more IMS systems based on the command routing. Each IMS 12 Commands, Volume 1: IMS Commands A - M returns the command response to OM. The command responses from each IMS are grouped together by OM and returned to the caller. For each IMS command that is issued from OM API, the response is encapsulated in XML tags. The type-2 command responses to OM also include a return code, reason code, and a possible completion code. The return or reason code returned for the command might also indicate an error from a Common Service Layer (CSL) request. When the following type-1 commands are issued from OM API, the DFS058I COMMAND IN PROGRESS message is not returned. Instead, the messages that result as a part of command processing are returned to OM. Following is the list of commands that do not return the DFS058I COMMAND IN PROGRESS message: v /DBDUMP DB v /DBRECOVERY AREA v /DBRECOVERY DB v /DBRECOVERY DATAGRP v /LOCK DB v /START AREA v /START DB v /START DATAGRP v /STOP ADS v /STOP AREA v /STOP DB v /STOP DATAGRP v /UNLOCK DB v /VUNLOAD AREA Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Responses to LU 6.2 devices The response to a command from an LU 6.2 device is sent synchronously if the initiating conversation is not deallocated by the remote device. If the conversation is deallocated, the command response is sent asynchronously using the LUNAME of the device and a TPN of DFSCMD. The remote device must allocate separate DFSCMD conversations to receive each asynchronous message. When the following commands are entered from LU 6.2 devices: v v v v v /DBDUMP DATABASE /DBRECOVERY AREA /DBRECOVERY DATABASE /START AREA /START DATABASE v /START REGION v /STOP AREA v /STOP DATABASE v /STOP REGION Chapter 1. IMS command language overview 13 The DFS058 COMMAND COMPLETED message is generated instead of the DFS058 COMMAND IN PROGRESS message. If the LU 6.2 conversation is synchronous (the conversation still exists), the DFS058 COMMAND COMPLETED message is the last message the operator receives. If the LU 6.2 conversation is asynchronous (the conversation is deallocated), the order of delivery of the DFS058 message can vary. Sending messages to the z/OS system console Each z/OS system console in the sysplex has a unique LTERM name. In an XRF environment, the real z/OS system console name is the RSE name specified in the HSB member. For a non-XRF subsystem, the real system console name is the IMS ID. The generic z/OS system console name is always “WTOR”. The generic name is translated to the real LTERM name when a message is sent to the z/OS system console. Because each z/OS system console has a unique LTERM name, a message can be sent to any z/OS system console in the sysplex if the real LTERM name (not the generic name) is used. Sending messages to the IMS master terminal Each IMS master terminal (MTO) in the sysplex has a unique LTERM name, and if they are VTAM® terminals they also have unique node names. Each IMS assigns its primary MTO the default LTERM name “DFSPMTO” as a generic name. Each secondary MTO is assigned “DFSSMTO” as the default generic name. You can override either of these default generic names during IMS system definition by using the DFSDCxxx member of IMS.PROCLIB. The generic name is translated to the real LTERM name when a message is sent to the MTO. Restriction: If you use the DFSDCxxx member to override a default generic name, you must not specify a statically-defined node name. Also, the node name you specify must have the same physical characteristics as the default node you are overriding. If you change the DFSDCxxx member, you must perform a cold start of IMS. In a shared-queues environment, because each MTO has a unique LTERM name, a message can be sent to any MTO in the sysplex if you use the real LTERM name (not the generic name). Related reference: DFSDCxxx member of the IMS PROCLIB data set (System Definition) IMS terminal command examples Some command examples show the format of commands entered and received from an IMS terminal--entry terminal (ET), master terminal (MT), or response terminal (RT). One or more examples are given for each command. The examples show: Entry ET: How the command looks as entered from the entering terminal (ET). 14 Commands, Volume 1: IMS Commands A - M Response ET: The IMS response transmitted to the entering terminal (ET). Entry MT: How the command looks as entered from the master terminal (MT). Many IMS commands reference other terminals. Examples of these commands include: Response RT: The IMS response transmitted to the referenced terminal or terminals (RT). The ET and RT responses might or might not print or display, depending on what type of terminal is referenced and whether the MSGDEL (message delete) option was specified for the terminal at system definition time. TSO SPOC command examples Some command examples show the input and output of commands from a TSO SPOC. Both type-2 commands and type-1 commands can be entered from a TSO SPOC. One or more examples are given for each command. The examples show: TSO SPOC input: How the command looks as entered from the TSO SPOC. TSO SPOC output: The command response as displayed by the TSO SPOC. Explanation: An explanation of the command and response. Some type-2 commands include a section describing the environment of the IMSplex prior to entering the command. A response panel, log panel, or both displays when a command is entered from a TSO SPOC. Output data from the response panels are included in the examples, but output data from the log panels are not. The log panels display the OM return and reason codes for the command. OM API command examples Some command examples show the input and output of commands to and from the OM API. Both type-2 commands and type-1 commands can be entered from the OM API. One or more examples are given for each command. The examples show: OM API input: How the string looks as built by the AOP client. OM API output: The response with XML tags sent from OM. Explanation: An explanation of the command and response. Chapter 1. IMS command language overview 15 Some type-2 commands include a section describing the environment of the IMSplex prior to entering the command. IMS type-1 command format This section describes the general format for an IMS type-1 command. Subsections: v v v v v v v “Command recognition character” “Verb” “Keywords” “Parameters” “Null keywords” on page 20 “Comments” on page 20 “Passwords” on page 20 Command recognition character The slash (/) is the command recognition character for IMS commands. In a DBCTL environment, another character can be defined as the command recognition character and would replace the slash. Verb The /VERB (such as /STOP) is the first command element and identifies the action to be taken. To abbreviate a verb, use only the slash and the first three characters. Enter the characters using either uppercase or lowercase letters. Keywords IMS keywords are reserved words identifying IMS resources that relate to transaction management, databases, or the IMS system. Many commands require one or more keywords. Table 80 on page 63 is a list of available keywords and their synonyms. The alphabetic list of keywords after Table 80 on page 63 explains the use of the keyword for each IMS command it affects. Restriction: Keywords and their synonyms are reserved words. Do not use reserved words to name system resources such as transactions, programs, logical terminals, databases, and MFS block names. Keywords are shown in uppercase. The keyword or an allowable synonym can be entered in uppercase or lowercase. Parameters Parameters refer to installation defined or created resources, such as nodes, databases, or physical terminals, or IMS reserved parameters. Parameters in IMS commands must be replaced with parameter values. Reserved parameters have a unique meaning to IMS and refer to system resources or functions. 16 Commands, Volume 1: IMS Commands A - M The format of the parameters that can be entered is determined by the command and keyword with which they are associated. Use the syntax example provided at the beginning of each command description to determine the valid parameter formats for that command. When commands are entered, parameters are separated from a keyword by a space or an equal sign (=). Multiple parameters are separated by a comma, a blank, or a comma followed by a blank. The last parameter of one keyword is separated from the next keyword either by a space, a comma, or an equal sign. In the syntax examples, default parameters appear above the syntax line. Optional parameters appear below the syntax line. In the syntax examples, a repeat-line is shown as follows: parameter The repeat-line indicates that multiple parameters can be entered. To save time while entering multiple parameters for the LINE, PTERM, NODE, and LINK keywords, inclusive parameters can be specified in some commands. Restriction: Use of the ALL parameter, generic parameters, or excessive use of multiple or inclusive parameters in the large terminal network can cause some of the following problems: v “Lock out” of the operator for the duration of the command processing v Creation of large multisegment output messages v Command action for only part of the terminal resources intended v Temporary storage shortages v Artificially high storage pools within IMS, VTAM, or both Reserved words The resources you define, such as nodes, physical terminals, and databases, may be referenced as parameter values in IMS commands. Do not use reserved words to name these resources, or IMS might not interpret the command as expected. For example, if you define a node called TKOTRA and issue a /DISPLAY NODE TKOTRA command, IMS will list all the nodes that have an attribute of TKOTRA, instead of the specific node named TKOTRA. ALL parameter Entering the reserved parameter ALL specifies all defined resources related to that keyword. ALL cannot be used with every command. ALL=NO or ALL=DIS can be specified on the KEYWD macro to prevent use of the ALL parameter. ALL=NO and ALL=DIS can be specified for all keywords. ALL=NO indicates that the ALL parameter is invalid on all the commands for the keyword. ALL=DIS indicates that the ALL parameter is invalid on all the /DISPLAY commands for the keyword. Inclusive parameters Chapter 1. IMS command language overview 17 Inclusive parameters are used to specify a group of parameters by entering only the first and last parameters of the group. Inclusive parameters can be used for the following resources: v v v v Line Link Static node PTERM To use inclusive parameters, enter the first parameter, a hyphen, then the last parameter (parameter1-parameter2). For the LINE, PTERM, and LINK keywords, the group of parameters specified is assumed to be based on numeric sequence; that is, entering 3-6 specifies parameters 3, 4, 5, and 6. Inclusive parameters are limited to the PTERM keyword when it appears with the LINE keyword in a command. For the NODE keyword, the group of parameters must be static and based on the IMS definition sequence, not numeric or alphabetic sequence. Generic parameters You can use generic parameters to specify a group of resources whose names match a 1- to 8-character alphanumeric mask. Generic parameters apply to both type-1 and type-2 commands. A generic parameter can include one or more of the following wildcard characters: * Matches zero or more characters. When used alone, it matches all the names for the keyword or resource. % Matches exactly one character. The following examples illustrate some uses of wildcard characters: CO* Matches any string of any length that begins with CO. For instance: CO, COO, COOP %%S Matches any 3-character string that ends with S. For instance: IMS, XYS CO*%%1 Matches any string of 5 or more characters that starts with CO, ends with 1, and has at least 2 characters between CO and 1. For instance: CONV1, CONV21, CONV221, CONV23B1 Specifying an asterisk alone as the generic parameter (such as NAME(*)) is equivalent to specifying ALL (such as NAME(ALL)). However, depending on the installation, other generic parameters can mean ALL. For example, the generic parameter %%%% means ALL to an installation whose resource names are all 4 characters long. Some commands support NAME(*) and do not support NAME(ALL) for a wildcard name. When a generic parameter is used, IMS uses a serial search of all resources to match the generic name. Using a serial search of all resources can have performance implications in larger systems. Restriction: For type-1 commands, if you specify ALL=NO on the KEYWD macro, you cannot use an asterisk (*) or ALL for the keyword. However, if you specify ALL=NO on the KEYWD macro, you can use other generic parameters that are 18 Commands, Volume 1: IMS Commands A - M equivalent to ALL. If you are using BASIC EDIT, and you enter a command with a generic parameter containing two asterisks in a row at the end of the command, the command is discarded. The following table lists some of the type-1 commands and keywords that support generic parameters. Table 1. Type-1 commands and keywords that support generic parameters Command Keyword supported /BROADCAST LTERM, NODE, USER /CHANGE NODE /CLSDST NODE /DISPLAY LTERM, MSNAME, NODE, TRAN, USER /DISPLAY ASMT LTERM, MSNAME, NODE, USER /DISPLAY CONV NODE, USER /IDLE NODE /OPNDST NODE /PSTOP LTERM, TRAN /PURGE LTERM, MSNAME, TRAN /RSTART NODE, USER /START LTERM, MSNAME, NODE, TRAN, USER /STOP LTERM, MSNAME, NODE, TRAN, USER /TRACE NODE Restriction: Generic parameters are not supported in NODE, USER, or TRAN CLASS combinations. Group parameters A group parameter allows easy specification of a group of resources, where the resources in the group are defined and managed by the installation. Group parameters apply to both type-1 and type-2 command. Group parameters are supported with the DATAGRP keyword for the /DBRECOVERY, /START, /STOP, and UPDATE (type-2) commands. A group name is one to eight characters long. It is associated with a list of databases, DEDB areas, or database data sets. A database group name and its associated databases or DEDB areas is defined in the DBRC RECON data set using the DBRC INIT.DBDSGRP command with parameters GRPNAME and DBGRP. A database data set (DBDS) group name and its associated DBDSs is defined in the DBRC RECON data set using the DBRC INIT.DBDSGRP command with parameters GRPNAME and MEMBERS. v Adding resources to a group Use the CHANGE.DBDSGRP command with the GRPNAME and ADDDB parameters to add databases or areas to a database group. Use the CHANGE.DBDSGRP command with the GRPNAME and ADDMEM parameters to add DBDSs to a DBDS group. Chapter 1. IMS command language overview 19 v Deleting resources from a group Use the CHANGE.DBDSGRP command with the GRPNAME and DELDB parameters to delete databases or areas from a database group. Use the CHANGE.DBDSGRP command with the GRPNAME and DELMEM parameters to delete DBDSs from a DBDS group. v Displaying resources in a group Use the LIST.DBDSGRP command or the online /RMLIST command to display the databases or areas in a database group, or the DBDSs in a DBDS group. Groups defined for commands should contain only databases and areas for use with the DATAGROUP keyword. Null keywords Null keywords are used to help clarify the syntax of the command being entered but have no effect on the command. Null keywords can be used within IMS commands at any time. However, they cannot be used with type-2 commands. Null keywords are reserved words. Do not use them to name system resources. The following are IMS null keywords: v AFTER v FOR v ON v SECURITY v TO Comments You can add comments or notes to the end of a command. When you add comments, identify the end of the command by entering a period after the last parameter. If you do not enter a period, residual data from a 3270 affects command processing. Passwords Depending on the password security arrangement of the defined IMS system and the terminal where the command is entered, a password can be required after the command verb, or after a parameter or a keyword of certain commands. If a command password is required, it must be entered immediately after /VERB and is normally enclosed in parentheses. No spaces or intervening characters are allowed between the /VERB and the left parenthesis. When using MFS, if a command password is required, the installation-defined MFS format must contain a defined password field. The password must be entered into the password field defined by the format displayed. If command entry field of the format is defined to accept the command verb only, message DFS1051 is issued when an attempt is made to enter /VERB(password). None of the IMS-supplied default formats (exception for the master terminal format) have a password field defined. You must use RACF or an equivalent security product to require a command verb password associated with the user ID signed on to the dynamic terminal. 20 Commands, Volume 1: IMS Commands A - M The /IAM, /LOCK, and /UNLOCK command keywords and parameters support passwords. The /IAM, /LOCK, and /UNLOCK command parameters also support passwords when defined for users using RACF for static and dynamic resources. The password associated with a signed on user and specified after a command resource parameter will be used to perform a reverification check, if the resource is defined to RACF with 'REVERIFY' specified in the APPLDATA field. If the resource passes the RACF authorization check, and RVFY=Y is specified as an IMS startup parameter, IMS will verify that the password following the parameter is the same as the password entered during signon for the user that entered the command. If 'REVERIFY' is specified for a resource, but a password is not provided, or the wrong password is provided, the command processing for that resource will be rejected. This is also true for the /SET TRANSACTION and /SET CONVERSATION commands. The use of passwords is not shown in the examples. Related reference: Chapter 5, “List of reserved words,” on page 91 IMS Command Language Modification facility (DFSCKWD0) (Exit Routines) IMS type-2 command format IMS type-2 commands use a different format from the format used by IMS type-1 commands. Type-2 commands can be issued only through the Operations Manager (OM) APIs by an automated operator program (AOP). An example of an AOP is the IBM-supplied TSO single point of control (SPOC) application. These commands cannot be entered from the system console, the MTO, an end-user terminal, or an IMS AOI application program. Type-2 commands are not passed to the IMS AOI user exits and are also not logged to the IMS secondary master. Almost all commands issued through the OM API (including the IMS type-1 commands) do not require a command recognition character (for example, a slash). If one is supplied, the OM API will ignore it. The only exception to this rule is the type-1 /EXIT command, which requires a slash when entered from a TSO SPOC application. The command format with common keywords is as follows: , VERB RESOURCETYPE , (1) KEYWORD ( parameter parameter* ) Notes: 1 For some commands, KEYWORD is required, not optional. The following is a list of the parameters with a short description of each. VERB Identifies the action to be taken. The command verb can be abbreviated. Chapter 1. IMS command language overview 21 RESOURCETYPE Identifies the type of resource the command acts upon. The following is a list of the resource types: AREA An area resource in an IMS. DATAGRP The members of a data group in an IMS. DB The database in an IMSplex. DBDESC The databases descriptor in an IMSplex. IMSCON IMS Connect resources. IMS Status and attributes of an IMS. IMSPLEX A group of IMS systems, CSL (SCI, OM, RM) members and CQSs. LE Language Environment® runtime parameter definitions. MEMBER An IMSplex component (For example, an IMS, OM, RM, or SCI). MSLINK Logical links. MSPLINK Physical links. MSNAME Logical link paths. ODBM Open Database Manager (ODBM), a component of the Common Service Layer (CSL). OLC An online change process. OLREORG An online reorganization of a HALDB partition. OTMADESC IMS Open Transaction Manager Access (OTMA) destination descriptor. PGM A program in an IMS. PGMDESC A program descriptor in an IMS. RM Resource Manager (RM) address space. RTC A Fast Path routing code. RTCDESC A Fast Path routing code descriptor. STRUCTURE A resource structure managed by RM. TRAN An IMS resource that is a message destination. TRANDESC An IMS descriptor that is a message destination. 22 Commands, Volume 1: IMS Commands A - M KEYWORD() Optional command elements, depending upon the specific command. parameter Identifies an IMS-defined value or an installation-defined or created resource. Most parameters can end with a wildcard (an asterisk - *). Parameters are listed in parentheses and must be replaced with parameter values. Multiple parameters are separated by a comma. If an optional keyword is specified without any parameters listed within the parentheses, the keyword is assigned a null value and is treated as if the keyword was not specified at all. Generic parameters You can use generic parameters to specify a group of resources whose names match a 1- to 8-character alphanumeric mask. Generic parameters apply to both type-1 and type-2 commands. A generic parameter can include one or more of the following wildcard characters: * Matches zero or more characters. When used alone, it matches all the names for the keyword or resource. % Matches exactly one character. The following examples illustrate some uses of wildcard characters: CO* Matches any string of any length that begins with CO. For instance: CO, COO, COOP %%S Matches any 3-character string that ends with S. For instance: IMS, XYS CO*%%1 Matches any string of 5 or more characters that starts with CO, ends with 1, and has at least 2 characters between CO and 1. For instance: CONV1, CONV21, CONV221, CONV23B1 Specifying an asterisk alone as the generic parameter (such as NAME(*)) is equivalent to specifying ALL (such as NAME(ALL)). However, depending on the installation, other generic parameters can mean ALL. For example, the generic parameter %%%% means ALL to an installation whose resource names are all 4 characters long. Some commands support NAME(*) and do not support NAME(ALL) for a wildcard name. When a generic parameter is used, IMS uses a serial search of all resources to match the generic name. Using a serial search of all resources can have performance implications in larger systems. The following table lists some of the type-2 commands and keywords that support generic parameters. Table 2. Type-2 commands and keywords that support generic parameters Command Keyword supported DELETE NAME with DB, DBDESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, or TRANDESC EXPORT NAME with DB, DBDESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, or TRANDESC Chapter 1. IMS command language overview 23 Table 2. Type-2 commands and keywords that support generic parameters (continued) Command Keyword supported IMPORT NAME with DB, DBDESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, or TRANDESC QUERY NAME with AREA, DB, DBDESC, MSLINK, MSNAME, MSPLINK, PGM, PGMDESC, RTC, RTCDESC, TRAN, or TRANDESC QUERY LE LTERM, TRAN, USERID, PROGRAM UPDATE NAME with AREA, DB, DBDESC, MSLINK, MSNAME, MSPLINK, PGM, PGMDESC, RTC, RTCDESC, TRAN, or TRANDESC Restriction: Generic parameters are not supported in a TRAN CLASS combination. Related concepts: Issuing type-2 IMS commands (System Programming APIs) Type-2 command environment (System Administration) Sending commands to the IMSplex After setting up an IMSplex, you can issue commands using the TSO single point of control (SPOC) interface. You can also write an automated operator program that can issue the same commands. The TSO SPOC provides integrated online help. The IMS Application Menu provides a common interface to enable you to start applications such as TSO SPOC, Syntax Checker, IVP, and more. Important: SPOC applications (including the TSO SPOC and the Batch SPOC utility) issue the CSLOMCMD request. You therefore need to be aware of the parameters and return and reason codes of the CSLOMCMD request. If you write automated programs, those programs must include logic to handle the responses from the commands; the automated programs have to parse the XML statements. Most commands that are issued to an IMSplex are issued to OM. The exceptions are: v BPE commands, which can be issued directly to CSL members and to CQS. v The SHUTDOWN command, which can be issued directly to SCI to shut down one or more CSL members. v Query requests issued by a z/OS master console to the CSL. In an IMSplex, the format, behavior, and responses to certain IMS commands have changed. Some IMS commands are no longer recoverable; others are not supported in an IMSplex. Some commands are supported only in an IMSplex. Related concepts: Other sample applications verified by the IVP (Installation) Controlling IMS with the TSO SPOC application (Operations and Automation) 24 Commands, Volume 1: IMS Commands A - M IMS Application Menu (System Administration) Related reference: CSLOMCMD: command request (System Programming APIs) Command processing in an IMSplex In an IMSplex environment, IMS commands issued through OM can behave differently than when those same commands are issued to an individual IMS subsystem. Type-2 commands can be issued only through the OM API. Type-1 IMS commands can be issued through the OM API or to individual IMS systems through end-user terminals, master terminals, system consoles, or AOI applications. The following sections describe some of the behavioral differences. Command routing Commands that are issued to OM are, by default, routed to all the IMSplex components that are active and have registered interest in processing those commands. If you want to route a command to one or more specific IMS systems in the IMSplex, use the ROUTE() parameter on the command request. OM selects one IMSplex member (that is, IMS or RM) that is registered for the command to be the command master for each command from the OM API. The command master performs global command actions where applicable. An XRF alternate system is not a command master candidate until it takes over. Type-2 command responses may differ depending on which IMSplex member was the command master. For example, for a QUERY TRAN NAME(tranname) QCNT (GT 1) SHOW(ALL) command, only the command master returns the global queue counts, unless it does not have access to the shared queues (for example, the command master is local queues enabled). If a command is routed to multiple IMS systems and the command fails on some of those systems as a result of environmental reasons (such as /DBR to an XRF alternate system), the overall OM return code will not reflect the environmental error. If a command fails on all systems to which it is routed because of environmental reasons, IRC_LIST and IRSN_LISTNONE are produced. For type-1 commands, any error messages that are associated with the invalid environment errors will also be sent back for display. For type-2 commands, the return and reason code returned by the IMS system are from OM. Command behavior and the Resource Manager Depending on whether an IMSplex is defined with a Resource Manager (and there is a resource structure available to RM), command behavior can be affected. When a resource structure is not defined, resource status must be maintained on local IMS systems in the IMSplex. In this case, commands have only a local effect. If RM is defined with a resource structure and STM is enabled in the IMSplex, RM maintains global resource information, including resource status, for nodes, LTERMS, and users. In this scenario, resource status is maintained both globally and locally. Usually, if a user signs off or a client shuts down, resources status is Chapter 1. IMS command language overview 25 maintained globally but deleted locally. If you do not want TM resources to be updated in RM, you can specify STM=NO in the PROCLIB member, DFSDCxxx. As an alternative to STM=NO, users can choose to disable resource sharing for static ISC resources only. If this option is set, the command status for static ISC resources is always considered local as if there were no resource structure. Commands processed for a static ISC node or subpool only modify local status. Status is not updated in the resource structure. The purpose of the option is to remove the unique name restriction for static ISC-related resources so that static ISC LTERM and subpool names can be active multiple times concurrently in an IMSplex. Another behavior that is worth noting is how command processing clients process type-1 commands (related to nodes, LTERMS, and users) that are routed to the entire IMSplex. In general, OM chooses one of the command processing clients in the IMSplex to be the “master” to coordinate the processing of the type-1 commands. Whether the master (or a non-master) IMS will process a type-1 command depends on where the command resource status is kept. If the command resource status is kept in a resource structure, the type-1 command will usually be processed by a non-master client where the command resource is active. If the command resource is not active on any of the command processing clients in the IMSplex, OM will still route the type-1 command to all clients in the IMSplex, but only the master client will process the command. If the type-1 command is being routed to all the clients in the IMSplex, command processing clients where the command resource is not active will reject the type-1 command. Related reference: DFSDCxxx member of the IMS PROCLIB data set (System Definition) Initialization exit routine (DFSINTX0) (Exit Routines) Command characteristics Command characteristics and operations (the way commands actually work) are affected by terminal security defaults, command recoverability, and whether commands are logged to the secondary master terminal, supported from an AOI application, mirrored on the XRF alternate, supported from the XRF alternate, and supported from LU 6.2 devices. Terminal security defaults for IMS type-1 commands When neither RACF (RACF=NONE) nor the command security exit (DFSCCMD0) is used, all type-1 commands are allowed from the master terminal, except those that apply to the terminals from which the commands are issued. Only some commands are allowed from a remote terminal in this case. The following table shows the terminal security defaults for IMS commands from the master terminal and remote terminals when neither RACF (RACF=NONE) nor the command security exit (DFSCCMD0) is used. Only the commands shown in the table are allowed in these environments. Table 3. Terminal security defaults for IMS type-1 commands Master terminal /ACTIVATE /ALLOCATE 26 Commands, Volume 1: IMS Commands A - M Remote terminal Table 3. Terminal security defaults for IMS type-1 commands (continued) Master terminal Remote terminal /ASSIGN /BROADCAST /BROADCAST /CANCEL /CANCEL /CHANGE /CHECKPOINT /CLSDST /COMPT /CQCHKPT /CQQUERY /CQSET /DBDUMP /DBRECOVERY /DELETE /DEQUEUE /DIAGNOSE /DIAGNOSE /DISPLAY /END /END /ERESTART /EXCLUSIVE /EXCLUSIVE /EXIT /EXIT /FORMAT /FORMAT /HOLD /HOLD /IAM /IDLE /INITIATE /LOCK /LOCK /LOG /LOG /LOOPTEST /LOOPTEST /MODIFY /MONITOR /MSASSIGN /MSVERIFY /NRESTART /OPNDST /PSTOP /PURGE /QUIESCE /RCLSDST /RCLSDST /RCOMPT /RDISPLAY /RDISPLAY Chapter 1. IMS command language overview 27 Table 3. Terminal security defaults for IMS type-1 commands (continued) Master terminal Remote terminal /RECOVER /RELEASE /RELEASE /RESET /RESET /RMxxxxxx /RMLIST /RSTART /RTAKEOVER /SECURE /SET /SET /SIGN /SIGN /SMCOPY /SSR /START /STOP /SWITCH /TERMINATE /TEST /TEST /TRACE /UNLOCK /UNLOCK /UPDATE /VUNLOAD Commands recovered during emergency restart Certain commands that successfully alter IMS resources are written to the system log as X'02' or X'22' log records and are reprocessed during emergency restart. IMS type-1 commands that are recovered during emergency restart write an X'02' log record. Type-2 commands that are recovered during emergency restart write an X'22' log record. The following table lists the commands, along with the exceptions, that are recovered during emergency restart. Table 4. Commands recovered during emergency restart Command Exceptions /ASSIGN /CHANGE CREATE /DELETE DELETE /END /EXCLUSIVE /EXIT /HOLD 28 Commands, Volume 1: IMS Commands A - M /CHANGE DESCRIPTOR Table 4. Commands recovered during emergency restart (continued) Command Exceptions /LOCK /LOCK LTERM, /LOCK NODE, /LOCK PTERM /LOG /MONITOR /MSASSIGN /PSTOP /PSTOP LTERM /PURGE /PURGE APPC, /PURGE LTERM /RELEASE /RSTART /SET /SET LTERM, /SET TRAN /SMCOPY /START /START APPC, /START ISOLOG, /START TRKARCH, /START PROG /STOP /STOP APPC /TEST MFS /TEST LINE, /TEST NODE, /TEST USER /UNLOCK /UNLOCK LTERM, /UNLOCK NODE, /UNLOCK PTERM, /UNLOCK SYSTEM UPDATE DB UPDATE MSLINK UPDATE MSNAME UPDATE MSPLINK UPDATE PGM UPDATE RTC UPDATE TRAN UPDATE TRAN START(TRACE), UPDATE TRAN STOP(TRACE) Restriction: If an IMS outage (abend, modify, or cancel of IMS) occurs immediately after a command is entered, the command status might not be carried across an emergency restart or XRF takeover. The command log records are logged asynchronously (no check write or wait write). If there is no other IMS activity that forces the log buffer to be written to the OLDS or WADS data set, the status set by the command, for restart purposes, did not occur. There are many events in IMS where log records are check-written to the log. Any one of these events subsequent to the command causes the command log record to be written to the OLDS or WADS data set. Command processing in a dynamic resource definition environment IMS processes commands differently in a dynamic resource definition (DRD) environment than in a non-DRD environment. If you are running without DRD enabled, the control blocks that manage the resources (DDIRs, PDIRs, SMBs, and RCTEs) are loaded from the MODBLKS data set at cold start. If a type-1 command is issued to change the attribute of a resource Chapter 1. IMS command language overview 29 (such as the database access type or the transaction class), the internal control blocks are updated and the changes are recovered across a warm or emergency restart. If you perform a cold start, however, the control blocks are reloaded from the MODBLKS data set, so the updated attributes revert to the original values unless you have updated your MODBLKS data set. If you are running with DRD enabled, any changes that you make to resource definitions by using type-1 or type-2 commands persist across a warm or emergency restart. These changes also persist across a cold start if the updated resource definitions are exported to either a resource definition data set (RDDS) or the IMSRSC repository, and then imported from the RDDS or the repository during cold start. When you export the resource definitions to an RDDS or the repository, all the current attribute values are exported. If you change the value of one of the attributes by using a type-1 or type-2 command (such as the database access type or the transaction class), the updated attribute is exported. The updated attribute values are then imported during cold start if automatic import is enabled. Related concepts: Considerations for using dynamic resource definition (System Definition) IMS type-1 commands logged to the secondary master terminal The secondary master terminal provides a hardcopy log of system activity, including checkpoint information and error messages. If the hardcopy logging facility has been selected and not disabled (using the /SMCOPY command), certain IMS commands and responses are logged on the secondary master terminal. You can select whether only commands issued from the master terminal are logged, only commands entered from other terminals are logged, or both are logged. Only the commands listed in the following table are logged to the secondary master terminal. Table 5. IMS type-1 commands logged to the secondary master terminal 30 Commands Commands (continued) /ACTIVATE /ALLOCATE /ASSIGN /CHECKPOINT /CLSDST /COMPT /CQCHKPT /CQQUERY /CQSET /DBDUMP /DBRECOVERY /DELETE /DEQUEUE /DIAGNOSE /DISPLAY /IDLE /INITIATE OLREORG /MODIFY /MONITOR /QUIESCE /RCLSDST /RCOMPT /RECOVER /RMCHANGE /RMDELETE /RMGENJCL /RMINIT /RMLIST /RMNOTIFY /RSTART /RTAKEOVER /SECURE /START /STOP /SWITCH /TERMINATE OLREORG /TRACE /UPDATE MSLINK Commands, Volume 1: IMS Commands A - M Table 5. IMS type-1 commands logged to the secondary master terminal (continued) Commands Commands (continued) /MSASSIGN /OPNDST /PSTOP /PURGE /UPDATE OLREORG /UNLOCK SYSTEM /VUNLOAD IMS type-1 commands supported from an AO application Automated operator (AO) applications are application programs that issue IMS operator commands using DL/I calls. AO applications can use two different DL/I calls to issue commands: CMD and ICMD. This section lists which IMS commands can be issued using each of these calls and describes command security for AO applications. AO applications using the CMD and ICMD call can use RACF, DFSCCMD0, or both for security. The IMS Control Center, TSO SPOC, and REXX SPOC API are IMS applications that use OM API and cannot issue commands through DL/I calls. Issuing IMS type-1 commands by using the CMD call If you are using the CMD call to issue IMS commands, transactions can be defined as AO applications with AOI= on the TRANSACT system definition macro. AO transactions are invoked in the same way any IMS transaction is invoked. AO transactions run as IMS applications with the authority to issue a planned series of IMS commands. For example, an AO application can be called in by an AO transaction after a normal restart of IMS to start IMS resources. The AO application would consist of those commands regularly used by the master terminal operator (MTO) after IMS is active. Fast Path exclusive transactions cannot be defined as AO transactions. When RACF (or an equivalent product) is used for type-1 AOI security, the AOI= parameter on the TRANSACT macro defines which transactions can issue commands. RACF (or an equivalent product) defines which commands are allowed for each authorized transaction. These definitions in RACF give control to the authorized user who entered the transaction or to the transaction name or the command name itself. The AOI= parameter on the TRANSACT macro contains the controlling specification. The following table shows the IMS commands that can be issued in an AO application using the CMD call. Each row includes an IMS command, restrictions, and the application environment (MPP or BMP running under DB/DC, or MPP or BMP running under DCCTL). Table 6. IMS type-1 commands supported from an AO application using CMD Application environment IMS command /ACTIVATE Restrictions MPP or BMP running under DB/DC MPP or BMP running under DCCTL Yes Yes Chapter 1. IMS command language overview 31 Table 6. IMS type-1 commands supported from an AO application using CMD (continued) Application environment MPP or BMP running under DB/DC MPP or BMP running under DCCTL /ALLOCATE Yes Yes /ASSIGN Yes Yes /BROADCAST Yes Yes /CHANGE Yes Yes Yes Yes /CLSDST Yes Yes /COMPT Yes Yes /CQCHKPT Yes Yes /CQQUERY Yes Yes /CQSET Yes Yes /DBDUMP Yes Yes /DBRECOVERY Yes Yes /DELETE Yes Yes /DEQUEUE Yes Yes /DIAGNOSE Yes Yes /DISPLAY Yes Yes IMS command /CHECKPOINT Restrictions simple form (no keywords), SNAPQ, or STATISTICS /END with keywords Yes Yes /EXCLUSIVE with keywords Yes Yes /EXIT with LINE and NODE keywords Yes Yes /FORMAT with LTERM keyword Yes Yes Yes Yes /IDLE 32 /INITIATE OLREORG Yes No /LOCK without LTERM, NODE, or PTERM keywords Yes Yes /LOG Yes Yes /LOOPTEST Yes Yes /MONITOR Yes Yes /MSASSIGN Yes Yes /OPNDST Yes Yes /PSTOP Yes Yes /PURGE Yes Yes /QUIESCE Yes Yes /RDISPLAY Yes Yes /RECOVER Yes No Commands, Volume 1: IMS Commands A - M Table 6. IMS type-1 commands supported from an AO application using CMD (continued) Application environment MPP or BMP running under DB/DC MPP or BMP running under DCCTL /RMCHANGE Yes Yes /RMDELETE Yes Yes /RMGENJCL Yes Yes /RMINIT Yes Yes /RMLIST Yes Yes /RMNOTIFY Yes Yes /RSTART Yes Yes /SECURE Yes Yes /SMCOPY Yes Yes /SSR Yes Yes /START Yes Yes /STOP Yes Yes /SWITCH Yes Yes IMS command Restrictions /TERMINATE OLREORG Yes No /TEST MFS with LINE/NODE keywords Yes Yes Yes Yes Yes Yes Yes No /TRACE /UNLOCK /VUNLOAD without LTERM, NODE, PTERM, or SYSTEM keywords If the 3270 message facility service (MFS) bypass option is selected, the output message specified is MODNAME=DFSEDTN, and the terminal is in preset mode, then the only command recognized by IMS is the /RESET command issued from an unformatted screen.All other commands are passed to the application program. Issuing IMS type-1 commands by using the ICMD call The following table shows by application program type the commands that can be issued in an AO application using the ICMD call. This includes DRA thread running under DBCTL or DB/DC; BMP running under DBCTL; MPP, BMP, IFP running under DB/DC; and MPP, BMP, or IFP running under DCCTL. Commands that cause the IMS control region to terminate, such as /CHE FREEZE, cannot be issued. You can secure the commands issued by an ICMD call using RACF (or the equivalent) or the Command Authorization user exit, DFSCCMD0. RACF lets you specify which commands the applications can issue. DFSCCMD0 and RACF let you do authorization checking during ICMD processing.The authorization checking can be controlled either through the transaction name, the command name, or the user ID of the signed on user. The AOI= parameter on the TRANSACT macro allows you to specify which authorization checking is to be used. Chapter 1. IMS command language overview 33 Table 7. IMS type-1 commands supported from an AO application using ICMD Application environment DBRA thread running under DBCTL or DB/DC BMP running under DBCTL MPP, BMP, or IFP running under DB/DC MPP, BMP, or IFP running under DCCTL /ACTIVATE N/A N/A Yes Yes /ALLOCATE N/A N/A Yes Yes /ASSIGN N/A N/A Yes Yes /BROADCAST N/A N/A Yes Yes /CANCEL N/A N/A No No /CHANGE Yes Yes Yes Yes /CHECKPOINT (simple form) Yes Yes Yes Yes /CHECKPOINT SNAPQ N/A N/A Yes Yes /CHECKPOINT STATISTICS Yes Yes Yes Yes /CLSDST N/A N/A Yes Yes /COMPT N/A N/A Yes Yes /CQCHKPT N/A N/A Yes Yes /CQQUERY N/A N/A Yes Yes /CQSET N/A N/A Yes Yes /DBDUMP Yes Yes Yes N/A /DBRECOVERY Yes Yes Yes N/A /DELETE Yes Yes Yes Yes /DEQUEUE Yes Yes Yes Yes /DIAGNOSE Yes Yes Yes Yes /DISPLAY Yes Yes Yes Yes N/A N/A Yes Yes /ERESTART No No No No /EXCLUSIVE N/A N/A Yes Yes /EXIT N/A N/A Yes Yes /FORMAT N/A N/A Yes Yes /HOLD N/A N/A No No /IAM N/A N/A No No /IDLE N/A N/A Yes Yes /INITIATE OLREORG Yes Yes Yes No /LOCK DB Yes Yes Yes N/A /LOCK PGM Yes Yes Yes Yes /LOCK TRAN N/A N/A Yes Yes Yes Yes Yes Yes N/A N/A Yes Yes IMS Command /END /LOG /LOOPTEST 34 Commands, Volume 1: IMS Commands A - M Table 7. IMS type-1 commands supported from an AO application using ICMD (continued) Application environment DBRA thread running under DBCTL or DB/DC BMP running under DBCTL MPP, BMP, or IFP running under DB/DC MPP, BMP, or IFP running under DCCTL No No No No /MONITOR N/A N/A Yes Yes /MSASSIGN N/A N/A Yes Yes /MSVERIFY N/A N/A No No /NRESTART No No No No N/A N/A Yes Yes /PSTOP Yes Yes Yes Yes /PURGE N/A N/A Yes Yes /QUIESCE N/A N/A Yes Yes /RCLSDST N/A N/A No No /RCOMPT N/A N/A No No /RDISPLAY N/A N/A Yes Yes /RECOVER Yes Yes Yes No /RELEASE N/A N/A No No /RESET N/A N/A No No /RMCHANGE Yes Yes Yes Yes /RMDELETE Yes Yes Yes Yes /RMGENJCL Yes Yes Yes Yes /RMINIT Yes Yes Yes Yes /RMLIST Yes Yes Yes Yes /RMNOTIFY Yes Yes Yes Yes N/A N/A Yes Yes No No No No /SECURE N/A N/A Yes Yes /SET N/A N/A No No /SIGN N/A N/A No No /SMCOPY N/A N/A Yes Yes /SSR No Yes Yes Yes /START Yes Yes Yes Yes /STOP Yes Yes Yes Yes /SWITCH Yes Yes Yes Yes /TERMINATE OLREORG Yes Yes Yes No N/A N/A Yes Yes /TRACE Yes Yes Yes Yes /UNLOCK DB Yes Yes Yes N/A IMS Command /MODIFY /OPNDST /RSTART /RTAKEOVER /TEST MFS LINE or NODE or USER Chapter 1. IMS command language overview 35 Table 7. IMS type-1 commands supported from an AO application using ICMD (continued) Application environment IMS Command DBRA thread running under DBCTL or DB/DC BMP running under DBCTL MPP, BMP, or IFP running under DB/DC MPP, BMP, or IFP running under DCCTL /UNLOCK PGM Yes Yes Yes Yes /UNLOCK TRAN N/A N/A Yes Yes Yes Yes Yes N/A /VUNLOAD The following commands and keywords are not permitted: v /CHECKPOINT keywords ABDUMP, DUMPQ, FREEZE, PURGE, and QUIESCE v The commands /END, /EXIT, and /EXCLUSIVE if they have no keywords v /LOCK keywords LTERM, NODE, and PTERM v /UNLOCK keywords LTERM, NODE, PTERM, and SYSTEM Related concepts: Tools for automated operations (Operations and Automation) Security for AO application programs (System Administration) Command security when using OM For IMS command security, you have your choice of OM command security using RACF or equivalent, or IMS command security. Recommendation: Use OM command security instead of IMS security. By allowing OM to perform the security checks, commands which fail security authorization are not routed to IMS, reducing processing overhead and network traffic. When IMS command security is used, it is up to the user to ensure that all IMS systems use the same security profiles or user exits. If IMS systems in the same IMSplex use different security rules, the results of command security checking may be unpredictable. Related reference: IMS commands, RACF access authorities and resource names table (System Administration) Commands mirrored on an XRF alternate Certain commands that successfully alter IMS resources are written to the system log as X'02' or X'22' log records. IMS type-1 commands that alter resources write an X'02' log record. Type-2 commands that alter resources write an X'22' log record. In an XRF environment, the X'02' or X'22' log records are read and processed by the alternate system as it tracks the active system. The effect of these commands is mirrored on the alternate system when it takes over and becomes the active system. These commands, along with exceptions, are listed in the following table. 36 Commands, Volume 1: IMS Commands A - M Table 8. List of IMS commands mirrored on an XRF alternate Command Exceptions /ASSIGN /ASSIGN is mirrored only if the assignment does not involve the master terminal. /CHANGE CREATE /DELETE DELETE /END /EXCLUSIVE /EXIT /HOLD /LOCK /LOG /MONITOR /MSASSIGN /PSTOP /PSTOP REGION /PURGE /PURGE APPC /RELEASE /RESET /RSTART /SECURE /SECURE APPC /SET /SMCOPY /START /START APPC, /START REGION /STOP /STOP APPC, /STOP REGION /TEST /TEST is usually not mirrored on an XRF alternate system. However, /TEST MFS is mirrored if the alternate system is tracking the state of the terminal that entered the /TEST MFS command. /TRACE /TRACE is usually not mirrored on an XRF alternate system. However, /TRACE SET LINE and /TRACE SET LINK are mirrored for lines and links that can be restarted. /TRACE SET NODE is mirrored for all node types. /UNLOCK /UNLOCK SYSTEM UPDATE DB UPDATE DBDESC UPDATE MSLINK UPDATE MSNAME UPDATE MSPLINK UPDATE PGM UPDATE PGMDESC UPDATE RTC UPDATE RTCDESC Chapter 1. IMS command language overview 37 Table 8. List of IMS commands mirrored on an XRF alternate (continued) Command Exceptions UPDATE TRAN UPDATE TRAN START(TRACE), UPDATE TRAN STOP(TRACE) UPDATE TRANDESC Commands supported on the XRF alternate The commands that are valid on the XRF alternate, along with the exceptions, are shown in the following table. Table 9. List of commands supported on the XRF alternate Command Exceptions /ACTIVATE /CANCEL /CHANGE /CLSDST /COMPT /DISPLAY /DISPLAY QCNT /END /ERESTART /FORMAT /IDLE /NRESTART /OPNDST /PSTOP REGION QUERY AREA QUERY DB QUERY QUERY QUERY QUERY QUERY DB DB DB DB DB SHOW(WORK) SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) QUERY DBDESC QUERY QUERY QUERY QUERY DBDESC DBDESC DBDESC DBDESC SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) QUERY IMS QUERY IMSPLEX QUERY LTERM QUERY LTERM SHOW(GLOBAL) QUERY MEMBER QUERY NODE QUERY OTMADESC QUERY OTMATI 38 Commands, Volume 1: IMS Commands A - M QUERY NODE SHOW(GLOBAL) Table 9. List of commands supported on the XRF alternate (continued) Command Exceptions QUERY PGM QUERY QUERY QUERY QUERY QUERY PGM PGM PGM PGM PGM QUERY PGMDESC QUERY QUERY QUERY QUERY PGMDESC PGMDESC PGMDESC PGMDESC QUERY RTC QUERY QUERY QUERY QUERY QUERY RTC RTC RTC RTC RTC QUERY RTCDESC QUERY QUERY QUERY QUERY RTCDESC RTCDESC RTCDESC RTCDESC QUERY TRAN QUERY QUERY QUERY QUERY QUERY TRAN TRAN TRAN TRAN TRAN QUERY TRANDESC QUERY QUERY QUERY QUERY TRANDESC TRANDESC TRANDESC TRANDESC QUERY USER QUERY USER SHOW(GLOBAL) SHOW(WORK) SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) SHOW(WORK) SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) SHOW(WORK) SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) SHOW(DEFN) SHOW(DEFN,IMSID) SHOW(DEFN,GLOBAL) SHOW(IMSID) /RCLSDST /RCOMPT /RDISPLAY REFRESH USEREXIT /RMLIST /SECURE /SMCOPY /START DC /START LUNAME /START REGION /START RTCODE /START SURVEILLANCE /STOP /STOP BACKUP /STOP DC /STOP LUNAME /STOP REGION /STOP RTCODE Chapter 1. IMS command language overview 39 Table 9. List of commands supported on the XRF alternate (continued) Command Exceptions /STOP SURVEILLANCE /SWITCH /TEST /TRACE UPDATE MSLINK TKOTRC( ) UPDATE TRAN SET(MAXRGN) UPDATE TRAN START|STOP(TRACE) Commands and keywords supported on an RSR tracking subsystem Only commands and keywords required to manage RSR tracking are supported on an RSR tracking subsystem. For example, commands and keywords relating to transactions are not supported, because transactions are not allowed on a tracking subsystem. See Table 10 for the commands and keywords supported on an IMS DB/DC tracking subsystem. The subset of commands and keywords relating to databases are the only ones allowable on a DBCTL tracking subsystem. Commands entered on an IMS tracking subsystem that are not supported on a tracking subsystem result in message DFS136I COMMAND xxxxxxxxxx INVALID FOR TRACKER Commands entered on a DCCTL tracking subsystem that are not supported on the tracking subsystem or on DCCTL result in message DFS136I COMMAND xxxxxxxxxx INVALID FOR DCCTL Keywords entered on an IMS tracking subsystem that are not supported on a tracking subsystem result in message DFS110 COMMAND KEYWORD yyyyyyyyyyyy INVALID FOR TRACKER Keywords entered on a DBCTL or DCCTL tracking subsystem that are not supported on a tracking subsystem or with DBCTL or DCCTL result in message DFS110 KEYWORD yyyyyyyyyyyy INVALID FOR DBCTL|DCCTL The following table lists the commands and keywords that are allowed on an IMS DB/DC RSR tracking. The table also includes comments. Table 10. Commands and keywords allowable on an IMS DB/DC RSR tracking subsystem Commands Keywords /ACTIVATE NODE /ASSIGN COMPONENT, ICOMPONENT, LINE, LTERM, NODE, PTERM, USER /BROADCAST ACTIVE, LINE, LTERM, NODE, Non-VTAM lines are not supported. PTERM, USER /CANCEL 40 Commands, Volume 1: IMS Commands A - M Comments Table 10. Commands and keywords allowable on an IMS DB/DC RSR tracking subsystem (continued) Commands Keywords Comments /CHANGE CPLOG Specifies the number of system log records between system-generated checkpoints. /CHECKPOINT ABDUMP, DUMPQ, FREEZE, SNAPQ, STATISTICS Simple checkpoint (that is, with no keywords) is also supported. /CLSDST NODE, USER /COMPT CNS, CRD, NODE, NOTRDY, PCH, PDS, PRT, RDR, READY, TDS, UDS, USER, VID, WPM1, WPM2, WPM3 /DBRECOVERY AREA, DATABASE, DATAGROUP, LOCAL, NOFEOV /DEQUEUE LINE, LTERM, NODE, PTERM, PURGE, PURGE1, USER /DIAGNOSE ADDRESS, AREA, BLOCK, DB, JOBNAME, LINE, LINK, LTERM, MODULE, NODE, OPTION, PGM, REGION, SET, SHOW, SNAP, TRAN, USER /DISPLAY ACTIVE, AREA, v For /DISPLAY POOL ALL, only pools needed on ASSIGNMENT, DATABASE, the tracking subsystem are displayed. DBD, DC, LINE, LTERM, v For /DISPLAY POOL pool, some parameters are MODE, MODIFY, MONITOR, not supported. NODE, OLDS, POOL, PTERM, v For /DISPLAY STATUS with no keywords, only SHUTDOWN STATUS, TRACE, resources needed on a tracking subsystem are TRACKING STATUS, USER, displayed. XTRC v For /DISPLAY TRACE ALL, only resources needed on a tracking subsystem are displayed. /END LINE, NODE, PTERM, USER /ERESTART BUILDQ, CHECKPOINT, COLDBASE, COLDCOMM, COLDSYS, FORMAT, NOPASSWORD, NOTERMINAL, NOUSER, OVERRIDE, PASSWORD, TERMINAL, USER /FORMAT LTERM /IDLE LINE, NODE, NOSHUT Command only valid for a DATABASE level tracking system. Keywords only valid for areas and databases tracked at the DATABASE level. /LOG /MODIFY ABORT, COMMIT, LTERM, PASSWORD, PREPARE, TERMINAL /NRESTART BUILDQ, CHECKPOINT, FORMAT, NOBUILDQ, NOPASSWORD, NOTERMINAL, NOUSER, PASSWORD, TERMINAL, USER /OPNDST ID, LOGOND, MODE, NODE, Q, UDATA, USER, USERD The following parameters are supported: ACBLIB, BLDL, FMTLIB, MODBLKS, and RACF. Chapter 1. IMS command language overview 41 Table 10. Commands and keywords allowable on an IMS DB/DC RSR tracking subsystem (continued) Commands Keywords Comments /PSTOP LINE, LTERM, PTERM Non-VTAM lines are not supported. /PURGE LINE, LTERM, PTERM Non-VTAM lines are not supported. QUERY AREA, DB, IMS, MEMBER /RCLSDST /RCOMPT CNS, CRD, NODE, NOTRDY, PCH, PDS, PRT, RDR, READY, TDS, UDS, USER, VID, WPM1, WPM2, WPM3 /RDISPLAY REFRESH USEREXIT TYPE, MEMBER /RMxxxxxx LTERM /RSTART LINE, LOPEN, NODE, PTERM, Non-VTAM lines are not supported. USER /RTAKEOVER UNPLAN, NOREVERSE /SIGN ON, USERD /SMCOPY ON, TERMINAL /START AREA, AUTOARCH, DATABASE, DATAGROUP, DC, ISOLOG, LINE, LOCAL, LTERM, NODE, OLDS, PTERM, SERVGRP, USER, WADS /STOP ADS, AUTOARCH, DC, LINE, Non-VTAM lines are not supported. LTERM, NODE, OLDS, PTERM, SERVGRP, TRKAUTOARCH, USER, WADS /SWITCH CHECKPOINT, OLDS /TEST MFS LINE, NODE, PTERM, USER /TRACE LEVEL, LINE, MODULE,NODE, ON, OPTION, SET, TABLE, UNITYPE, USER, VOLUME UPDATE AREA START(ACCESS), STOP(ACCESS) UPDATE DATAGRP START(ACCESS), STOP(ACCESS) UPDATE DB START(ACCESS), STOP(ACCESS) Only applies to tracking subsystem RECON data set. /START AREA, /START DATABASE, and /START DATAGROUP are only valid on a DATABASE level tracking subsystem. Non-VTAM lines are not supported. No LUMI, RETR, SCHD, or SUBS TABLE tracing is allowed on a tracking subsystem. IMS-supported terminals in an RSR environment Since IMS-supported terminals are not supported for an RSR tracking subsystem, some type-1 commands are not supported on an RSR tracking subsystem (that is, they will cause a DFS058 COMMAND COMPLETED EXCEPT ... message to be issued). These type-1 commands are: v /BROADCAST LINE 42 Commands, Volume 1: IMS Commands A - M v v v v v /BROADCAST PTERM /PSTOP LINE [PTERM] /PURGE LINE [PTERM] /RSTART LINE [PTERM] /START LINE [PTERM] v /STOP LINE [PTERM] If the parameter ALL is used with one of these commands, the IMS-supported terminals affected are simply skipped. IMS type-1 commands supported from LU 6.2 devices and OTMA Only certain IMS type-1 commands are valid from LU 6.2 devices and OTMA. The IMS type-1 commands that are supported from LU 6.2 devices and OTMA are listed in the following table: Table 11. IMS type-1 commands supported from LU 6.2 devices and OTMA Commands Commands (continued) /ALLOCATE* /PURGE /ASSIGN /QUIESCE /BROADCAST* /RDISPLAY /CHANGE* /RMCHANGE* /CHECKPOINT /RMDELETE* /CLSDST /RMGENJCL* /COMPT /RMINIT* /DBDUMP /RMLIST* /DBRECOVERY /RMNOTIFY* /DELETE /RSTART /DEQUEUE /SECURE /DIAGNOSE /SMCOPY /DISPLAY /SSR /IDLE /START /LOG /STOP /LOCK /SWITCH /MODIFY /TRACE /MONITOR /UNLOCK /MSASSIGN /MSVERIFY /OPNDST* /PSTOP Note: * Multisegment commands are not supported by OTMA. Chapter 1. IMS command language overview 43 Terminal security defaults for LU 6.2 devices and OTMA Only some IMS type-1 commands from LU 6.2 devices and OTMA are authorized in an environment in which RACF is not used (RACF=NONE) and the command security exit (DFSCCMD0) is also not used. The following table shows the terminal security defaults for IMS type-1 commands from LU 6.2 devices and OTMA when RACF is not used (RACF=NONE) and the command security exit (DFSCCMD0) is also not used. Only the commands shown in the table will be authorized in these environments. Table 12. Terminal security defaults for IMS type-1 commands from LU 6.2 devices and OTMA LU 6.2 Devices OTMA /BROADCAST /LOC /LOC /LOG /LOG /RDISPLAY /RDISPLAY /RMLIST Commands and keywords supported by the OM API Some IMS commands are supported by the OM API. The following table is a list of IMS command verbs and primary keywords that can be issued through the Operations Manager (OM) API. The command verb can be specified in the long form or short form, as specified in column one and two respectively. The primary keyword is the first keyword following the command verb, as specified in column three. Restriction: The OM API supports only the short form of the keywords that are described in the following table. For example, the keyword ACTIVE (used on the /BROADCAST command) has a short form of ACT. The OM API supports only the ACT keyword, not ACTIVE. Table 13. Commands supported by the OM API 44 Command (long form) Command (short form) Primary keywords (short form) /ACTIVATE /ACT LINK, NODE /ALLOCATE /ALL LU /ASSIGN /ASS CLASS, CPRI, INPUT, LCT, LPRI, LTERM, NPRI, OUTPUT, PARLIM, PLCT, SEGNO, SEGSZ, TRAN, USER /BROADCAST /BRO ACT, LINE, LTERM, MASTER, NODE, PTERM, USER /CHANGE /CHA APPC, CCTL, CPLOG, DESC, DIR, FDR, LINK, NODE, PSWD, SUBSYS, SURV, TRAN, UOR, USER Commands, Volume 1: IMS Commands A - M Table 13. Commands supported by the OM API (continued) | Primary keywords (short form) Command (long form) Command (short form) /CHECKPOINT /CHE DUMPQ, FREEZE, PURGE, STATISTICS /CLSDST /CLS NODE /CQCHKPT /CQC SHAREDQ, SYSTEM /CQQUERY /CQQ STATISTICS /CQSET /CQS SHUTDOWN CREATE CRE DB, DBDESC, IMSCON, OTMADESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, TRANDESC /DBDUMP /DBD DB /DBRECOVERY /DBR AREA, DB, DATAGRP /DELETE /DEL DESC, PSWD, TERMINAL DELETE DEL DB, DBDESC, DEFN, LE, OTMADESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, TRANDESC /DEQUEUE /DEQ AOITKN, LINE, LTERM, LU, MSNAME, NODE, SUSPEND, TMEM, TRAN, USER /DISPLAY /DIS ACT, AFFIN, AOITKN, APPC, AREA, ASMT, CCTL, CONV, CPLOG, CQS, DB, DBD, DESC, FDR, FPV, HSB, HSSP, LINE, LINK, LTERM, LU, MASTER, MODIFY, MSNAME, NODE, OASN, OLDS, OTMA, OVERFLOWQ, PGM, POOL, PSB, PTERM, Q, QCNT, RECOVERY, RTC, SHUTDOWN, STATUS, STRUC, SUBSYS, SYSID, TIMEOVER, TMEM, TRACE, TRACKING, TRAN, UOR, USER /END /END LINE, NODE, USER /ERESTART /ERE BACKUP, COLDBASE, COLDCOMM, COLDSYS, NULL /EXCLUSIVE /EXC LINE, NODE, USER /EXIT /EXI CONV EXPORT EXP DEFN /IDLE /IDL LINE, LINK, NODE IMPORT IMP DEFN INITIATE INIT OLC, OLREORG Chapter 1. IMS command language overview 45 Table 13. Commands supported by the OM API (continued) 46 Command (long form) Command (short form) Primary keywords (short form) /LOCK /LOC DB, PGM, TRAN /LOG /LOG /MODIFY /MOD ABORT, COMMIT, PREPARE /MONITOR /MON LINE /MSASSIGN /MSA LINK, MSNAME, SYSID, TRAN /NRESTART /NRE CHKPT, NULL /OPNDST /OPN NODE /PSTOP /PST LINE, LINK, LTERM, MSPLINK, REGION, TRAN /PURGE /PUR APPC, FPPROG, FPRGN, LINE, LTERM, MSNAME, TRAN QUERY QRY AREA, DB, DBDESC, IMS, IMSCON, IMSPLEX, LE, LTERM, MEMBER, MSLINK, MSNAME, MSPLINK, NODE, ODBM, OLC, OLREORG, OTMADESC, OTMATI, PGM, PGMDESC, POOL, RTC, RTCDESC, STRUCTURE, TRAN, TRANDESC, USER, USEREXIT, USERID QUEUE QUE LTERM, TRAN /QUIESCE /QUI NODE /RDISPLAY /RDI MASTER /RECOVER /REC ADD, REMOVE, START, STOP, TERMINATE /RMCHANGE /RMC /RMDELETE /RMD /RMGENJCL /RMG /RMINIT /RMI /RMLIST /RML /RMNOTIFY /RMN /RSTART /RST LINE, LINK, MSPLINK, NODE, USER /RTAKEOVER /RTA DUMPQ, FREEZE, UNPLAN /SECURE /SEC APPC, OTMA /SMCOPY /SMC MASTER, MSG, TERMINAL Commands, Volume 1: IMS Commands A - M Table 13. Commands supported by the OM API (continued) Primary keywords (short form) Command (long form) Command (short form) /START /STA APPC, AREA, AUTOARCH, CLASS, DATAGRP, DB, DC, DESC, ISOLOG, LINE, LTERM, LU, MADSIOT, MSNAME, NODE, OLDS, OTMA, PGM, REGION, RTC, SB, SERVGRP, SLDSREAD, SUBSYS, SURV, THREAD, TMEM, TRAN, TRKARCH, USER, VGR, WADS, XRCTRACK /STOP /STO ADS, APPC, AREA, AUTOARCH, BACKUP, CLASS, DATAGRP, DB, DC, LINE, LTERM, LU, MADSIOT, MSNAME, NODE, OLDS, OTMA, PGM, REGION, RTC, SB, SERVGRP, SLDSREAD, SUBSYS, SURV, THREAD, TMEM, TRAN, USER, VGR, WADS, XRCTRACK /SWITCH /SWI OLDS, SYSTEM, WADS TERMINATE TERM OLC, OLREORG /TEST /TES MFS /TRACE /TRA SET /UNLOCK /UNL DB, PGM, SYSTEM, TRAN UPDATE UPD AREA, DATAGRP, DB, DBDESC, IMS, IMSCON, LE, MSLINK, MSNAME, MSPLINK, ODBM, OLREORG, OTMADESC, PGM, PGMDESC, POOL, RTC, RTCDESC, TRAN, TRANDESC /VUNLOAD /VUN AREA Equivalent IMS type-1 and type-2 commands Certain IMS type-1 commands and type-2 commands perform similar tasks. The following table shows the different instances of the IMS type-1 commands and type-2 commands that perform similar tasks. Table 14. Type-2 equivalents for the /ASSIGN command Task /ASSIGN command Similar IMS type-2 command Changes the value for the limit count of a transaction. /ASSIGN LCT new_lmct_number TO TRAN tranname UPDATE TRAN NAME (tranname) SET(LCT(new_limit_count)) Changes the value for the limit priority of a transaction. /ASSIGN LPRI new_lpri_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(LPRI(new_limit_priority)) Chapter 1. IMS command language overview 47 Table 14. Type-2 equivalents for the /ASSIGN command (continued) Task /ASSIGN command Similar IMS type-2 command Changes the value for the normal priority of a transaction. /ASSIGN NPRI new_npri_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(NPRI(new_normal_priority)) Changes the value for the parallel processing limit count of a transaction. /ASSIGN PARLIM new_parlim_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(PARLIM(new_parallel_limit)) Changes the value for the processing limit count of a transaction. /ASSIGN PLCT new_plmct_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(PLCT(new_processing_limit)) Changes the limit on the number of application program output segments allowed in message queues for each GU call. /ASSIGN SEGNO new_segno_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(SEGNO(new_segment_number)) Creates or changes the limit on the size of application program output segments allowed in message queues for each GU call. /ASSIGN SEGSZ new_segsize_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(SEGSZ(new_segment_size)) Changes the class number of a transaction. /ASSIGN TRAN tranname TO CLS new_class_number UPDATE TRAN NAME(tranname) SET(CLASS(new_class_number)) Table 15. Type-2 equivalents for the /DBDUMP command. Task /DBDUMP command Similar IMS type-2 command Stops updates to a database. /DBDUMP DB dbname UPDATE DB NAME(dbname) STOP(UPDATES) OPTION(FEOV)1 1 This command does not automatically issue checkpoints unless OPTION(FEOV) is specified. Table 16. Type-2 equivalents for the /DBRECOVERY command. Task /DBRECOVERY command Similar IMS type-2 command Stops the accessing and updating of an area. /DBRECOVERY AREA areaname UPDATE AREA NAME(areaname) STOP(ACCESS) Stops the accessing and updating of all areas and databases of the data group. /DBRECOVERY DATAGRP datagrpname UPDATE DATAGRP NAME(datagrpname) STOP(ACCESS) Stops access to the database and take it offline. /DBRECOVERY DB dbname UPDATE DB NAME(dbname) STOP(ACCESS) OPTION(FEOV)1 1 This command does not automatically issue checkpoints unless OPTION(FEOV) is specified. Table 17. Type-2 equivalents for the /DISPLAY AFFIN command Task /DISPLAY AFFIN command Similar IMS type-2 command Displays TCP/IP generic resource affinities. /DISPLAY AFFIN LINK links QUERY MSLINK NAME(linkname | *) SHOW(AFFIN) Displays VTAM generic resource affinities. /DISPLAY AFFIN NODE node QUERY NODE SHOW(AFFIN) Table 18. Type-2 equivalents for the /DISPLAY AREA command Task /DISPLAY AREA command Similar IMS type-2 command Displays information about an area. /DISPLAY AREA QUERY AREA 48 Commands, Volume 1: IMS Commands A - M Table 19. Type-2 equivalents for the /DISPLAY ASMT command. Task /DISPLAY ASMT command Similar IMS type-2 command Displays input and output components. /DISPLAY ASMT LTERM ltermname QUERY LTERM SHOW(COMPONENT) Displays the node associated with the /DISPLAY ASMT LTERM ltermname lterm. QUERY LTERM SHOW(NODE) Displays the user associated with the lterm. /DISPLAY ASMT LTERM ltermname QUERY LTERM SHOW(USER) Displays the attributes of an MSC logical link /DISPLAY ASMT MSPLINK msplinkname QUERY MSLINK SHOW(ALL) Displays the attributes of an MSC physical link /DISPLAY ASMT MSPLINK msplinkname QUERY MSPLINK SHOW(ALL) Displays assigned lterms. /DISPLAY ASMT NODE node QUERY NODE SHOW(LTERM) Displays the user associated with the node. /DISPLAY ASMT NODE node QUERY NODE SHOW(USER) Displays the other half-session qualifier ID of the ISC node. /DISPLAY ASMT USER user QUERY USER SHOW(ID) Displays assigned lterms. /DISPLAY ASMT USER user QUERY USER SHOW(LTERM) Displays the node. /DISPLAY ASMT USER user QUERY USER SHOW(NODE) QUERY USERID SHOW(NODE) Displays the user ID. /DISPLAY ASMT USER user QUERY USER SHOW(USERID) Displays the user. /DISPLAY ASMT USER user QUERY USERID SHOW(USER) Table 20. Type-2 equivalents for the /DISPLAY CONV command Task /DISPLAY CONV command Similar IMS type-2 command Displays nodes with active or held conversations. /DISPLAY CONV QUERY NODE STATUS(CONV) Displays users with active or held conversations. /DISPLAY CONV QUERY USER STATUS(CONV) Displays IMS conversation information for a particular node. /DISPLAY CONV NODE node QUERY NODE SHOW(CONV) Displays IMS conversation information for a particular user. /DISPLAY CONV USER user QUERY USER SHOW(CONV) Table 21. Type-2 equivalents for the /DISPLAY DB command Task /DISPLAY DB command Similar IMS type-2 command Displays the status of a database. /DISPLAY DB dbname1 ...dbnamen | ALL QUERY DB Table 22. Type-2 equivalents for the /DISPLAY DBD command Task /DISPLAY DBD command Displays the programs being accessed /DISPLAY DBD dbdname by databases. Similar IMS type-2 command QUERY DB NAME(dbname) SHOW(PGM) Chapter 1. IMS command language overview 49 Table 23. Type-2 equivalents for the /DISPLAY LTERM command. Task /DISPLAY LTERM command Similar IMS type-2 command Displays logical link path for remote lterms. /DISPLAY LTERM ltermname QUERY LTERM SHOW(MSNAME) Displays the lterm message queue count. /DISPLAY LTERM ltermname QUERY LTERM SHOW(QCNT) Displays status of the lterm. /DISPLAY LTERM ltermname QUERY LTERM SHOW(STATUS) Displays queue count in the EMH queues. /DISPLAY LTERM ltermname QCNT EMHQ QUERY LTERM SHOW(EMHQ) /DISPLAY LTERM ltermname QCNT Table 24. Type-2 equivalents for the /DISPLAY MASTER command Task /DISPLAY MASTER command Similar IMS type-2 command Displays the primary and secondary master terminal. /DISPLAY MASTER QUERY LTERM STATUS(MTO,SMTO) Table 25. Type-2 equivalents for the /DISPLAY MODIFY command. Task /DISPLAY MODIFY command Displays work in progress for runtime /DISPLAY MODIFY ALL resource definitions that would cause a DELETE, /MODIFY COMMIT, INITIATE OLC PHASE(COMMIT), or UPDATE command to change resource definitions to fail. Similar IMS type-2 command QUERY DB NAME(dbname) SHOW(WORK) QUERY PGM NAME(pgmname) SHOW(WORK) QUERY RTC NAME(rtcode) SHOW(WORK) QUERY TRAN NAME(tranname) SHOW(WORK) Table 26. Type-2 equivalents for the /DISPLAY NODE command. Task /DISPLAY NODE command Similar IMS type-2 command Displays VTAM connection identifier (CID). /DISPLAY NODE node QUERY NODE SHOW(CID) Displays send/receive message counts. /DISPLAY NODE node QUERY NODE SHOW(COUNT) Displays preset destination. /DISPLAY NODE node QUERY NODE SHOW(PRESET) Displays queue count. /DISPLAY NODE node QUERY NODE SHOW(QCNT) /DISPLAY NODE node QCNT Displays status for a particular node. /DISPLAY NODE node QUERY NODE SHOW(STATUS) Displays terminal type. /DISPLAY NODE node QUERY NODE SHOW(TYPE) Displays user ID. /DISPLAY NODE node QUERY NODE SHOW(USERID) Displays user. /DISPLAY NODE node QUERY NODE SHOW(USER) Displays VTAM mode table names. /DISPLAY NODE node MODE QUERY NODE SHOW(MODETBL) Displays message queue count in the Expedited Message Handler (EMH) queues. /DISPLAY NODE node QCNT EMHQ QUERY NODE SHOW(EMHQ) Displays owner IMSID in RM resource structure. /DISPLAY NODE node RECOVERY QUERY NODE SHOW(OWNER) Displays status recovery information. /DISPLAY NODE node RECOVERY QUERY NODE SHOW(RECOVERY) 50 Commands, Volume 1: IMS Commands A - M Table 27. Type-2 equivalents for the /DISPLAY PGM command. Task /DISPLAY PGM command Similar IMS type-2 command Displays information about a program. /DISPLAY PGM pgmname QRY PGM NAME(pgmname) SHOW(ALL) QUERY PGM NAME(pgmname) SHOW(TRAN) Table 28. Type-2 equivalents for the /DISPLAY POOL command Task /DISPLAY POOL command Similar IMS type-2 command Displays processor storage utilization statistics for OSAM and VSAM database buffer pools. /DISPLAY POOL DBAS QUERY POOL TYPE(DBAS) SHOW(STATISTICS) Table 29. Type-2 equivalents for the /DISPLAY PSB command. Task /DISPLAY PSB command Similar IMS type-2 command Displays transactions, routing codes, and databases associated with a PSB. /DISPLAY PSB psbname QUERY PGM NAME(pgmname) SHOW(DB) QUERY PGM NAME(pgmname) SHOW(RTC) QUERY PGM NAME(pgmname) SHOW(TRAN) Table 30. Type-2 equivalents for the /DISPLAY QCNT command Task /DISPLAY QCNT command Similar IMS type-2 command Displays lterms with messages that are older than the specified age (shared queues). /DISPLAY QCNT LTERM MSGAGE x QUERY LTERM MSGAGE(x) Table 31. Type-2 equivalents for the /DISPLAY RTC command Task /DISPLAY RTC command Similar IMS type-2 command Displays information about one or more Fast Path routing codes. /DISPLAY RTC rtcname1...rtcnamen | ALL QUERY RTC NAME(rtcname1,...rtcnamen | *) SHOW(ALL) Table 32. Type-2 equivalents for the /DISPLAY STATUS command Task /DISPLAY STATUS command Similar IMS type-2 command Displays information about databases with the specified status. /DISPLAY STATUS DB QUERY DB STATUS(ALLOCF, ALLOCS,BACKOUT,EEQE, LOCK,NOTINIT,NOTOPEN, OFR,OLR,OPEN,RECALL,RECOV, RNL,STOSCHD,STOUPDS) Displays status. /DISPLAY STATUS LTERM QUERY LTERM SHOW(STATUS) Displays logical terminals with specified status. /DISPLAY STATUS LTERM QUERY LTERM STATUS(status) SHOW(STATUS) Displays nodes with specified status. /DISPLAY STATUS NODE QUERY NODE STATUS(status) Displays all programs that have status and what that status is. /DISPLAY STATUS PGM QUERY PGM STATUS(DB-NOTAVL, IOPREV,LOCK,NOTINIT, STOSCHD,TRACE) Chapter 1. IMS command language overview 51 Table 32. Type-2 equivalents for the /DISPLAY STATUS command (continued) Task /DISPLAY STATUS command Similar IMS type-2 command Displays all Fast Path routing codes that have status and what that status is. /DISPLAY STATUS RTC QUERY RTC STATUS(ACTIVE,NOTINIT, NOTSCHD,STOQ) Displays information about transactions with the specified status. /DISPLAY STATUS TRANSACTION QUERY TRAN NAME(tranname) STATUS (IOPREV,LCK,QERR,SUSPEND, STOQ,STOSCHD,USTO) Displays users with specified status. /DISPLAY STATUS USER QUERY USER STATUS(status) Table 33. Type-2 equivalents for the /DISPLAY TRACE command Task /DISPLAY TRACE command Similar IMS type-2 command Displays nodes with trace status. /DISPLAY TRACE NODE QUERY NODE STATUS(TRACE) Table 34. Type-2 equivalents for the /DISPLAY TRAN command Task /DISPLAY TRAN command Similar IMS type-2 command Displays information about a transaction. /DISPLAY TRAN tranname QUERY TRAN NAME(tranname) SHOW(ALL) Displays all of the transactions. /DISPLAY TRAN ALL QUERY TRAN SHOW(ALL) Displays all of the transactions on the /DISPLAY TRAN tranname QCNT shared queues with a global queue count. QUERY TRAN NAME(tranname) SHOW(QCNT) Table 35. Type-2 equivalents for the /DISPLAY USER command. Task /DISPLAY USER command Similar IMS type-2 command Displays preset destination. /DISPLAY USER user QUERY USER SHOW(PRESET) Displays node. /DISPLAY USER user QUERY USER SHOW(NODE) QUERY USERID SHOW(NODE) Displays status for a particular user. /DISPLAY USER user QUERY USER SHOW(STATUS) Displays user ID. /DISPLAY USER user QUERY USER SHOW(USERID) Displays status of a particular user ID. /DISPLAY USER user QUERY USERID SHOW(STATUS) Displays user. /DISPLAY USER user QUERY USERID SHOW(USER) Displays autologon parameters. /DISPLAY USER user AUTOLOGON QUERY USER SHOW(AUTOLOGON) Displays queue count. /DISPLAY USER user QUERY USER SHOW(QCNT) /DISPLAY USER user QCNT Displays message queue count in the Expedited Message Handler (EMH) queues. /DISPLAY USER user QCNT EMHQ QUERY USER SHOW(EMHQ) Displays status recovery information. /DISPLAY USER user RECOVERY QUERY USER SHOW(RECOVERY) Displays owner IMSID in RM resource structure. /DISPLAY USER user RECOVERY QUERY USER SHOW(OWNER) 52 Commands, Volume 1: IMS Commands A - M Table 36. Type-2 equivalents for the /LOCK command Task /LOCK command Similar IMS type-2 command Stops the use of a database. /LOCK DB dbname UPDATE DB NAME(dbname) SET(LOCK(ON)) Locks a program. /LOCK PGM pgmname UPDATE PGM NAME(pgmname) SET(LOCK(ON)) Locks a transaction. /LOCK TRAN tranname UPDATE TRAN NAME(tranname) SET(LOCK(ON)) Table 37. Type-2 equivalents for the /MSASSIGN command Task /MSASSIGN command Similar IMS type-2 command Changes the transaction so that it is local and runs on the local system. /MSASSIGN TRAN tranname TO LOCAL UPDATE TRAN NAME(tranname) SET(REMOTE(N)) Changes the transaction so that it is remote, and assign it to a specific logical link path. /MSASSIGN TRAN tranname TO MSNAME msname UPDATE TRAN NAME(tranname) SET(MSNAME(name)) Table 38. Type-2 equivalents for the /PSTOP command Task /PSTOP command Similar IMS type-2 command Stops the scheduling of transactions. /PSTOP TRAN tranname UPDATE TRAN(tranname) START(Q) STOP(SCHD) Stops logons to the physical link (only /PSTOP MSPLINK mplinkname | ALL UPDATE MSPLINK for MSC VTAM links). NAME(msplinkname | *) STOP(LOGON) Table 39. Type-2 equivalents for the /PURGE command Task /PURGE command Similar IMS type-2 command Stops input messages for a particular transaction code. /PURGE TRAN tranname UPDATE TRAN NAME(tranname) START(SCHD) STOP(Q) Table 40. Type-2 equivalents for the /RDISPLAY command Task /RDISPLAY command Similar IMS type-2 command Displays the primary and secondary master terminal. /RDISPLAY MASTER QUERY LTERM STATUS(MTO,SMTO) Table 41. Type-2 equivalents for the /RSTART command Task /RSTART command Similar IMS type-2 command Resets MSC TCP/IP or VTAM links to enable logons. /RSTART MSPLINK msplinkname | ALL UPDATE MSPLINK NAME(msplinkname | *) START(LOGON) Table 42. Type-2 equivalents for the /START AREA command Task /START AREA command Similar IMS type-2 command Starts the area. /START AREA areaname UPDATE AREA NAME(areaname) START(ACCESS) Chapter 1. IMS command language overview 53 Table 43. Type-2 equivalents for the /START DATAGRP command Task /START DATAGRP command Similar IMS type-2 command Starts the data group. /START DATAGRP datagrpname UPDATE DATAGRP NAME(datagrpname) START(ACCESS) Table 44. Type-2 equivalents for the /START DB command Task /START DB command Similar IMS type-2 command Starts a database and change access intent of the database. /START DB ACCESS UPDATE DB START(ACCESS) SET(ACCTYPE()) Starts a database. /START DB dbname UPDATE DB NAME(dbname) START(ACCESS) Table 45. Type-2 equivalents for the /START PGM command Task /START PGM command Similar IMS type-2 command Starts program scheduling. /START PGM pgmname UPDATE PGM NAME(pgmname) START(SCHD) Table 46. Type-2 equivalents for the /START RTC command Task /START RTC command Similar IMS type-2 command Starts queuing to a Fast Path routing code. /START RTC rtcname UPDATE RTC NAME(rtcname) START(Q) Table 47. Type-2 equivalents for the /START TRAN command Task /START TRAN command Similar IMS type-2 command Starts a transaction. /START TRAN UPDATE TRAN NAME(tranname) START(Q,SCHD,SUSPEND) Table 48. Type-2 equivalents for the /STOP AREA command Task /STOP AREA command Similar IMS type-2 command Stops an area. /STOP AREA areaname UPDATE AREA NAME(areaname) STOP(SCHD) Table 49. Type-2 equivalents for the /STOP DATAGRP command Task /STOP DATAGRP command Similar IMS type-2 command Stops a data group. /STOP DATAGRP datagrpname UPDATE DATAGRP NAME(datagrpname) STOP(SCHD) Table 50. Type-2 equivalents for the /STOP DB command Task /STOP DB command Similar IMS type-2 command Stops a database. /STOP DB dbname UPDATE DB NAME(dbname) STOP(SCHD) Table 51. Type-2 equivalents for the /STOP PGM command Task /STOP PGM command Similar IMS type-2 command Stops program scheduling. /STOP PGM pgmname UPDATE PGM NAME(pgmname) STOP(SCHD) 54 Commands, Volume 1: IMS Commands A - M Table 52. Type-2 equivalents for the /STOP RTC command Task /STOP RTC command Similar IMS type-2 command Stops queuing to a Fast Path routing code. /STOP RTC rtcname UPDATE RTC NAME(rtcname) STOP(Q) Table 53. Type-2 equivalents for the /STOP TRAN command Task /STOP TRAN command Similar IMS type-2 command Stops the queuing and scheduling of messages destined for a transaction. /STOP TRAN tranname UPDATE TRAN NAME(tranname) STOP(Q,SCHD) Table 54. Type-2 equivalents for the /TRACE PGM command Task /TRACE PGM command Similar IMS type-2 command Starts the tracing of a program. /TRACE SET ON PGM pgmname UPDATE PGM NAME(pgmname) START(TRACE) Stops the tracing of a program. /TRACE SET OFF PGM pgmname UPDATE PGM NAME(pgmname) STOP(TRACE) Table 55. Type-2 equivalents for the /TRACE TRAN command Task /TRACE TRAN command Similar IMS type-2 command Starts the tracing of a transaction. /TRACE SET ON TRAN tranname UPDATE TRAN NAME(tranname) START(TRA) Stops the tracing of a transaction. /TRACE SET OFF TRAN tranname UPDATE TRAN NAME(tranname) STOP(TRA) Table 56. Type-2 equivalents for the /UNLOCK DB command Task /UNLOCK DB command Similar IMS type-2 command Unlocks a database. /UNLOCK DB dbname UPDATE DB NAME(dbname) SET(LOCK(OFF)) Table 57. Type-2 equivalents for the /UNLOCK PGM command Task /UNLOCK PGM command Similar IMS type-2 command Unlocks a program. /UNLOCK PGM pgmname UPDATE PGM NAME(pgmname) SET(LOCK(OFF)) Table 58. Type-2 equivalents for the /UNLOCK TRAN command Task /UNLOCK TRAN command Similar IMS type-2 command Unlocks a transaction. /UNLOCK TRAN tranname UPDATE TRAN NAME(tranname) SET(LOCK(OFF)) Related concepts: Commands for IMS operations tasks (Operations and Automation) Equivalent IMS Connect WTOR, z/OS, and type-2 commands Certain IMS Connect WTOR commands, IMS Connect z/OS commands, and IMS Connect type-2 commands perform similar tasks. Chapter 1. IMS command language overview 55 The following table shows the different instances of the IMS Connect WTOR, z/OS, and type-2 commands that perform similar tasks. Table 59. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(ALIAS) command QUERY IMSCON TYPE(ALIAS) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(ALIAS) NAME(*) SHOW(ALL |show_parm) VIEWIA ALL QUERY ALIAS NAME(*) QUERY IMSCON TYPE(ALIAS) NAME(alias_name) SHOW(ALL |show_parm) VIEWIA alias_name QUERY ALIAS NAME(aliasName) QUERY IMSCON TYPE(ALIAS) VIEWIA alias_name NAME(alias_name) ODBM(odbm_name) odbm_name QUERY ALIAS NAME(aliasName) ODBM(odbmName) Table 60. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(CONFIG) command QUERY IMSCON TYPE(CONFIG) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(CONFIG) SHOW(ALL | show_parm) VIEWHWS QUERY MEMBER TYPE(IMSCON) SHOW(ALL) Table 61. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(DATASTORE) command QUERY IMSCON TYPE(DATASTORE) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(DATASTORE) VIEWDS ALL NAME(*) SHOW(ALL | show_parm) QUERY DATASTORE NAME(*) SHOW(ALL) QUERY IMSCON TYPE(DATASTORE) VIEWDS datastore_name NAME(datastore_name) SHOW(ALL | show_parm) QUERY DATASTORE NAME(datastore_name) Table 62. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(IMSPLEX) command QUERY IMSCON TYPE(IMSPLEX) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(IMSPLEX) NAME(*) SHOW(ALL |show_parm) VIEWIP ALL QUERY IMSPLEX NAME(*) SHOW(ALL) QUERY IMSCON TYPE(IMSPLEX) NAME(IMSplex_name) SHOW(ALL | show_parm) VIEWIP IMSplex_name QUERY IMSPLEX NAME(imsplexName) SHOW(ALL) Table 63. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(MSC) command 56 QUERY IMSCON TYPE(MSC) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(MSC) NAME(*) SHOW(ALL | show_parm) VIEWMSC ALL Commands, Volume 1: IMS Commands A - M QUERY MSC NAME(*) Table 63. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(MSC) command (continued) QUERY IMSCON TYPE(MSC) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(MSC) NAME(msc_id) SHOW(ALL | show_parm) VIEWMSC msc_id QUERY MSC NAME(msc_id) Table 64. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(PORT) command QUERY IMSCON TYPE(PORT) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(PORT) NAME(*) SHOW(ALL | show_parm) VIEWPORT ALL QUERY PORT NAME(*) SHOW(ALL) QUERY IMSCON TYPE(PORT) NAME(portid) SHOW(ALL | show_parm) VIEWPORT port_id QUERY PORT NAME(port_id) SHOW(ALL) QUERY IMSCON TYPE(PORT) NAME(LOCAL) SHOW(ALL | show_parm) VIEWPORT LOCAL QUERY PORT NAME(LOCAL) SHOW(ALL) Table 65. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(RMTIMSCON) command QUERY IMSCON TYPE(RMTIMSCON) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(RMTIMSCON) NAME(*) SHOW(ALL | show_parm) VIEWRMT ALL QUERY RMTIMSCON NAME(*) QUERY IMSCON TYPE(RMTIMSCON) NAME(rmtimscon_name) SHOW(ALL | show_parm) VIEWRMT rmtimscon_name QUERY RMTIMSCON NAME(rmtimscon_name) Table 66. WTOR and IMS Connect z/OS equivalents for the QUERY IMSCON TYPE(UOR) command QUERY IMSCON TYPE(UOR) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command QUERY IMSCON TYPE(UOR) NAME(*) SHOW(ALL | show_parm) VIEWUOR ALL QUERY UOR NAME(*) SHOW(ALL) QUERY IMSCON TYPE(UOR) NAME(uor_id) SHOW(ALL | show_parm) VIEWUOR uor_id QUERY UOR NAME(uor_id) SHOW(ALL) QUERY IMSCON TYPE(UOR) STATE(state) None None Chapter 1. IMS command language overview 57 Table 67. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(ALIAS) command UPDATE IMSCON TYPE(ALIAS) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UDPATE IMSCON TYPE(ALIAS) STARTIA alias_name NAME(alias_name) ODBM(odbm_name) odbm_name START(COMM) UPDATE ALIAS NAME(aliasName) ODBM(odbmName) START(ROUTE) UDPATE IMSCON TYPE(ALIAS) STOPIA alias_name NAME(alias_name) ODBM(odbm_name) odbm_name STOP(COMM) UPDATE ALIAS NAME(aliasName) ODBM(odbmName) STOP(ROUTE) Table 68. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(CLIENT) command UPDATE IMSCON TYPE(CLIENT) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(CLIENT) NAME(client_name) PORT(portid) STOP(COMM) STOPCLNT portid clientid DELETE PORT NAME(portName) CLIENT(clientName) Table 69. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(CONFIG) command 58 UPDATE IMSCON TYPE(CONFIG) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(CONFIG) SHUTDOWN(COMM) CLOSEHWS SHUTDOWN MEMBER UPDATE IMSCON TYPE(CONFIG) SHUTDOWN(COMM) OPTION(FORCE) CLOSEHWS FORCE SHUTDOWN MEMBER OPTION(FORCE) UPDATE IMSCON TYPE(CONFIG) SHUTDOWN(COMM) OPTION(QUIESCE) CLOSEHWS QUIESCE SHUTDOWN MEMBER OPTION(QUIESCE) UPDATE IMSCON TYPE(CONFIG) SET(OAUTO(ON)) SETOAUTO YES UPDATE MEMBER TYPE(IMSCON) SET(OAUTO(ON)) UPDATE IMSCON TYPE(CONFIG) SET(OAUTO(OFF) SETOAUTO NO UPDATE MEMBER TYPE(IMSCON) SET(OAUTO(OFF)) UPDATE IMSCON TYPE(CONFIG) SET(PSWDMC(ON)) SETPWMC ON UPDATE MEMBER TYPE(IMSCON) SET(PSWDMC(ON)) UPDATE IMSCON TYPE(CONFIG) SET(PSWDMC(OFF)) SETPWMC OFF UPDATE MEMBER TYPE(IMSCON) SET(PSWDMC(OFF)) UPDATE IMSCON TYPE(CONFIG) SET(PSWDMC(RCF)) SETPWMC RCF UPDATE MEMBER TYPE(IMSCON) SET(PSWDMC(RCF)) UPDATE IMSCON TYPE(CONFIG) SET(RACF(ON)) SETRACF ON UPDATE MEMBER TYPE(IMSCON) SET(RACF(ON)) Commands, Volume 1: IMS Commands A - M Table 69. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(CONFIG) command (continued) UPDATE IMSCON TYPE(CONFIG) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(CONFIG) SET(RACF(OFF)) SETRACF OFF UPDATE MEMBER TYPE(IMSCON) SET(RACF(OFF)) UPDATE IMSCON TYPE(CONFIG) SET(RRS(ON)) SETRRS ON UPDATE MEMBER TYPE(IMSCON) SET(RRS(ON)) UPDATE IMSCON TYPE(CONFIG) SET(RRS(OFF)) SETRRS OFF UPDATE MEMBER TYPE(IMSCON) SET(RRS(OFF)) UPDATE IMSCON TYPE(CONFIG) SET(UIDCACHE(ON)) SETUIDC ON UPDATE MEMBER TYPE(IMSCON) SET(UIDCACHE(ON)) UPDATE IMSCON TYPE(CONFIG) SET(UIDCACHE(OFF)) SETUIDC OFF UPDATE MEMBER TYPE(IMSCON) SET(UIDCACHE(OFF)) UPDATE IMSCON TYPE(CONFIG) START(RECORDER) RECORDER OPEN UPDATE MEMBER TYPE(IMSCON) START(TRACE) UPDATE IMSCON TYPE(CONFIG) STOP(RECORDER) RECORDER CLOSE UPDATE MEMBER TYPE(IMSCON) STOP(TRACE) Table 70. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(CONVERTER) command UPDATE IMSCON TYPE(CONVERTER) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(CONVERTER) NAME(converter_name) OPTION(REFRESH) REFRESH CONVERTER NAME(converter_name) UPDATE CONVERTER NAME(converter_name) OPTION(REFRESH) Table 71. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(DATASTORE) command. UPDATE IMSCON TYPE(DATASTORE) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(DATASTORE) NAME(datastore_name) START(COMM) OPENDS datastore_id UPDATE IMSCON TYPE(DATASTORE) NAME(datastore_name) STOP(COMM) STOPDS datastore_id STARTDS datastore_id UPDATE DATASTORE NAME(datastoreName) START(COMM) UPDATE DATASTORE NAME(datastoreName) STOP(COMM) Chapter 1. IMS command language overview 59 Table 72. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(IMSPLEX) command. UPDATE IMSCON TYPE(IMSPLEX) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(IMSPLEX) NAME(imsplex_name) START(COMM) OPENIP imsplex_id UPDATE IMSCON TYPE(IMSPLEX) NAME(imsplex_name) STOP(COMM) STARTIP imsplex_id STOPIP imsplex_id UPDATE IMSPLEX NAME(imsplex_name) START(COMM) UPDATE IMSPLEX NAME(imsplex_name) STOP(COMM) Table 73. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(LINK) command UPDATE IMSCON TYPE(LINK) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(LINK) NAME(logical_link_name) STOP(COMM) STOPLINK logical_link_name DELETE LINK NAME(linkName) UPDATE IMSCON TYPE(LINK) NAME(logical_link_name) MSC(lclplk_id) STOP(COMM) STOPLINK logical_link_name lclplk_id DELETE LINK NAME(linkname) LCLPLKID(lclPlkid) Table 74. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(MSC) command UPDATE IMSCON TYPE(MSC) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(MSC) NAME(lclPlkid) START(COMM) STARTMSC lclPlkid UPDATE MSC NAME(lclPlkid) START(COMM) UPDATE IMSCON TYPE(MSC) NAME(lclPlkid) STOP(COMM) STOPMSC lclPlkid UPDATE MSC NAME(lclPlkid) STOP(COMM) Table 75. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(ODBM) command UPDATE IMSCON TYPE(ODBM) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UDPATE IMSCON TYPE(ODBM) NAME(odbm_name) START(COMM) STARTOD odbm_name UPDATE ODBM NAME(odbmName) START(COMM) UDPATE IMSCON TYPE(ODBM) NAME(odbm_name) STOP(COMM) STOPOD odbm_name UPDATE ODBM NAME(odbmName) STOP(COMM) Table 76. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(PORT) command. 60 UPDATE IMSCON TYPE(PORT) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UDPATE IMSCON TYPE(PORT) NAME(port_name) START(COMM) OPENPORT port_id Commands, Volume 1: IMS Commands A - M STARTPT port_id UPDATE PORT NAME(port_name) START(COMM) Table 76. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(PORT) command (continued). UPDATE IMSCON TYPE(PORT) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UDPATE IMSCON TYPE(PORT) NAME(port_name) STOP(COMM) STOPPORT port_id UPDATE PORT NAME(port_name) STOP(COMM) Table 77. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(RACFUID) command UPDATE IMSCON TYPE(RACFUID) Equivalent IMS Connect Equivalent IMS Connect command WTOR command z/OS command UPDATE IMSCON TYPE(RACFUID) NAME(userid) OPTION(REFRESH) REFRESH RACFUID NAME(userid) UPDATE RACFUID NAME(userid) OPTION(REFRESH) Table 78. WTOR and IMS Connect z/OS equivalents for the UPDATE IMSCON TYPE(RMTIMSCON) command UPDATE IMSCON TYPE(RMTIMSCON) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(RMTIMSCON) NAME(rmtimscon_name) START(COMM) STARTRMT rmtimsconName UPDATE RMTIMSCON NAME(rmtimsconName) START(COMM) UPDATE IMSCON TYPE(RMTIMSCON) NAME(rmtimscon_name) STOP(COMM) STOPRMT rmtimsconName UPDATE RMTIMSCON NAME(rmtimsconName) STOP(COMM) Table 79. WTOR and MS Connect z/OS equivalents for the UPDATE IMSCON TYPE(SENDCLNT) command | | | | | UPDATE IMSCON TYPE(SENDCLNT) command Equivalent IMS Connect Equivalent IMS Connect WTOR command z/OS command UPDATE IMSCON TYPE(SENDCLNT) NAME(sendclient_name) RMTIMSCON(rmtimscon_name) STOP(COMM) STOPSCLN rmtimscon sendclient DELETE RMTIMSCON NAME(rmtimsconname) SENDCLNT(clientid) UPDATE IMSCON TYPE(SENDCLNT) NAME(sendclient_name) RMTCICS(rmtcics_name) STOP(COMM) STOPSCLN rmtcics sendclient No equivalent z/OS command Chapter 1. IMS command language overview 61 62 Commands, Volume 1: IMS Commands A - M Chapter 2. Command keywords and their synonyms All IMS command keywords and their synonyms, as well as keywords supported by the OM API, are listed. The list covers command keywords for the OM command processing clients such as IMS, ODBM, IMSCON, and RM. IMS ignores misspelled keywords, and issues an error message when it encounters an invalid keyword. In an IMSplex, invalid or misspelled keywords will result in an UNKNOWN POSITIONAL PARAMETER message. You can modify type-1 command keywords by using the IMS Command Language Modification Facility (DFSCKWD0) with the KEYWD macro. You can specify ALL=NO or ALL=DIS on the KEYWD macro to prevent the use of the ALL parameter. v You can specify ALL=NO for all the type-1 command keywords that support the ALL parameter. ALL=NO indicates that the ALL parameter is invalid on all the IMS commands that apply to the keyword being changed. v You can specify ALL=DIS for all the type-1 /DISPLAY command keywords that support the ALL parameter. ALL=DIS indicates that the ALL parameter is invalid on all the /DISPLAY commands that apply to the keyword being changed. You can prevent the use of the NAME(*) parameter on type-2 commands by using the CSL OM input user exit routine. In the following table, the IMS keyword column is for the OM command processing clients such as IMS, ODBM, IMSCON, and RM. A keyword listed in the OM keyword column indicates that it is the only accepted form supported by the OM API. If no keyword is listed in the OM keyword column, then the IMS keyword or its synonym is acceptable. If no synonyms are listed, none are permitted. Table 80. Command keywords and their synonyms IMS keyword Synonym OM keyword Commands that support this keyword ABDUMP /CHECKPOINT /STOP /SWITCH ABORT /MODIFY ACBLIB INITIATE OLC ACCESS /START ACTIVE A, ACT ACT /BROADCAST /DISPLAY /SWITCH ADAPTER QUERY OTMADESC ADD /RECOVER ADDRESS /DIAGNOSE ADS /STOP © Copyright IBM Corp. 1974, 2014 63 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword AFFINITY AFFIN, AFF AFFIN /DISPLAY /START ALIAS QUERY ODBM UPDATE ODBM ALLENTRIES ALLENT AOITOKEN AOITKN /RECOVER AOITKN /DEQUEUE /DISPLAY /PSTOP APDB /TRACE MONITOR APMQ /TRACE MONITOR APPC /DISPLAY /PURGE /SECURE /START /STOP AREA /DBRECOVERY /DIAGNOSE /DISPLAY /RECOVER /START /STOP /VUNLOAD ASR QUERY MSLINK ASSIGNMENT ASMT ASMT ATTRIB /DISPLAY QUERY MEMBER AUTO /TRACE AUTOARCH ARCHIVE, AUTOARC AUTOLOGON AUTLGN BACKUP BU BALGRP BALG AUTOARCH /START /STOP /DISPLAY BACKUP /ERESTART /STOP /SWITCH /DISPLAY BANDWIDTH QUERY MSLINK BKERR /DISPLAY BLDL INITIATE OLC BLOCK /DIAGNOSE BUILDQ BLDQ, BLDQS, BUILDQS /ERESTART /NRESTART CAGROUP CAGRP /RECOVER CANCEL /STOP CCTL CC CHECKPOINT CHECKPT, CHKPT CHKPOINT, CHKPT 64 Commands, Volume 1: IMS Commands A - M CCTL /DISPLAY /ERESTART /NRESTART /SWITCH Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword CLASS CLS CLASS /ASSIGN CREATE TRAN CREATE TRANDESC /DISPLAY /PSTOP /PURGE QUERY TRAN /START /STOP UPDATE TRAN CMDAUTH /ERESTART /NRESTART CMDAUTHE /ERESTART /NRESTART CMTMODE CREATE TRAN CREATE TRANDESC QUERY OTMATI CNS /COMPT /RCOMPT COLDBASE COLDB COLDBASE /ERESTART COLDCOMM COLDC COLDCOMM /ERESTART COLDSESS COLDSYS /CHANGE NODE UPDATE MSLINK COLDS COLDSYS /ERESTART COMMIT /MODIFY COMP /TRACE COMPONENT COMPT /ASSIGN CONTINUOUS CONT /RSTART CONVERSATION CONV CONV CREATE TRAN CREATE TRANDESC /DISPLAY /EXIT /RELEASE /SET CONVRTR QUERY OTMADESC CPLOG /CHANGE /DISPLAY CPRI /ASSIGN CQS /DISPLAY CRD /COMPT DATA QUEUE LTERM QUEUE TRAN Chapter 2. Command keywords and their synonyms 65 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword DATABASE DATABASES, DB, DBS DB /DBDUMP /DBRECOVERY /DIAGNOSE /DISPLAY /LOCK /RECOVER /START /STOP /UNLOCK DATAGROUP DATAGRP DATAGRP /DBRECOVERY /START /STOP UPDATE DATASTORE QUERY ODBM UPDATE ODBM DBALLOC /START DBD /DISPLAY DBDS /RECOVER DBDSGRP /RECOVER DBS /DISPLAY MODIFY DC /DISPLAY /START /STOP DCLWA CREATE TRAN CREATE TRANDESC DEFAULT CREATE DBDESC CREATE PGMDESC CREATE TRANDESC QUERY DBDESC QUERY PGMDESC QUERY RTCDESC QUERY TRANDESC UPDATE DBDESC DEFN DELETE EXPORT IMPORT DESCRIPTOR DESC, L62DESC DESC /CHANGE /DELETE /DISPLAY /START /STOP DIRECTORY DIR DIR /CHANGE DIRROUTE CREATE TRAN CREATE TRANDESC DONE /IAM DOPT CREATE PGM CREATE PGMDESC DUMPQ 66 DUMPQS Commands, Volume 1: IMS Commands A - M DUMPQ /CHECKPOINT /RTAKEOVER Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword EDITRTN CREATE TRAN CREATE TRANDESC EDITUC CREATE TRAN CREATE TRANDESC EMHBSZ CREATE TRAN CREATE TRANDESC EMHQ /DISPLAY ENDTIME EXPORT ERRORABORT /RECOVER ERRORCONT /RECOVER EXIT /DISPLAY /TRACE FDR /CHANGE /DISPLAY FMTLIB INITIATE OLC FORCE /CLSDST /PSTOP /SWITCH FORCSESS FORC /CHANGE FORMAT FMT /ERESTART /NRESTART FP CREATE CREATE CREATE CREATE FPPROG /PURGE PGM PGMDESC TRAN TRANDESC FPREGION FPRGN FPRGN /PURGE FPVIRTUAL FPV FPV /DISPLAY FRCABND INITIATE OLC FRCNRML INITIATE OLC FREEZE /CHECKPOINT /RTAKEOVER GLOBAL /DBDUMP /DBRECOVERY QUERY TRAN /START /STOP GPSB CREATE PGM CREATE PGMDESC GRPNAME QUERY OTMATI GRSNAME GRSN, GRS HSB HOTSTANDBY HSSP ICOMPONENT /START HSB /DISPLAY /DISPLAY ICOMPT /ASSIGN Chapter 2. Command keywords and their synonyms 67 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword ID Commands that support this keyword /CHANGE /OPNDST | IMSCON INDOUBT IMSCON IND CREATE QUERY UPDATE /DISPLAY INPUT /ASSIGN /DISPLAY /START /STOP /TRACE INQ CREATE CREATE CREATE CREATE INTERVAL INT, INTV ISOLOG JOBNAME RTC RTCDESC TRAN TRANDESC /CHANGE /TRACE MONITOR /START JBN, JOBN /PSTOP /START /STOP LA /TRACE MONITOR LANG CREATE PGM CREATE PGMDESC LCT CREATE TRAN CREATE TRANDESC LE DELETE UPDATE QUERY LEAVEGR /CHECKPOINT LEAVEPLEX /CHECKPOINT LEVEL /TRACE LIBRARY QUERY OLC LIKE CREATE CREATE CREATE CREATE CREATE CREATE CREATE | 68 Commands, Volume 1: IMS Commands A - M DB DBDESC IMSCON PGM PGMDESC TRAN TRANDESC Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword LINE LINES LINE /ASSIGN /BROADCAST /DEQUEUE /DIAGNOSE /DISPLAY /END /EXCLUSIVE /EXIT /IDLE /LOOPTEST /MONITOR /PSTOP /PURGE /RSTART /START /STOP /TEST /TRACE LINK LMCT /ACTIVATE /CHANGE /DIAGNOSE /DISPLAY /IDLE /MSASSIGN /PSTOP /RSTART /TRACE LCT LOCAL LOGOND LCT /ASSIGN /DBDUMP /DBRECOVERY /MSASSIGN /START /STOP LGND /CHANGE /OPNDST LOPEN /RSTART LPRI /ASSIGN CREATE TRAN CREATE TRANDESC Chapter 2. Command keywords and their synonyms 69 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword LTERM LTERMS LTERM /ASSIGN /BROADCAST DELETE LE /DEQUEUE /DIAGNOSE /DISPLAY /FORMAT /IAM /LOCK /MODIFY /PSTOP /PURGE QUERY LE QUERY OTMATI /RMxxxxxx /SET /START /STOP /UNLOCK UPDATE LE LUNAME LU, LUN LU /ALLOCATE /CHANGE /DEQUEUE /DISPLAY /EXIT /START /STOP /TRACE MADSIOT /START /STOP MASTER /BROADCAST /DISPLAY /RDISPLAY /SMCOPY MAXRGN /CHANGE CREATE TRAN CREATE TRANDESC MEMBER UPDATE ODBM MODBLKS INITIATE OLC MODE MODETABLE, MODETBL /ALLOCATE /CHANGE /DISPLAY /OPNDST MODIFY /DISPLAY MODNAME QUERY OTMATI MODULE /DIAGNOSE /TRACE MONITOR MON MSDBLOAD MSG 70 /DISPLAY /TRACE /NRESTART MESSAGE Commands, Volume 1: IMS Commands A - M /SMCOPY /TRACE Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword MSGAGE /DISPLAY QUERY LTERM QUERY OTMATI MSGTYPE CREATE MSLINK QUERY UPDATE MSNAME /BROADCAST CREATE TRAN CREATE TRANDESC /DEQUEUE /DIAGNOSE /DISPLAY /MSASSIGN /MSVERIFY /PURGE /START /STOP MSPLINK /DISPLAY /MSASSIGN /PSTOP MULTSIGN /ERESTART /NRESTART | Chapter 2. Command keywords and their synonyms 71 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym NAME NOBKO NOBMP NOBUILDQ Commands that support this keyword CREATE DB, CREATE DBDESC, CREATE IMSCON CREATE OTMADESC, CREATE PGM, CREATE PGMDESC, CREATE RTC, CREATE RTCDESC, DELETE DB, DELETE DBDESC, DELETE OTMADESC, DELETE PGM, DELETE PGMDESC, DELETE RTC, DELETE RTCDESC, DELETE TRAN, DELETE TRANDESC, EXPORT, IMPORT INITIATE OLREORG, QUERY AREA, QUERY DB, QUERY DBDESC, QUERY IMSCON, QUERY IMSPLEX, QUERY LTERM, QUERY MSLINK, QUERY MSNAME, QUERY MSPLINK, QUERY NODE, QUERY ODBM, QUERY OTMADESC, QUERY PGM, QUERY PGMDESC, QUERY OLREORG, QUERY RTC, QUERY RTCDESC, QUERY STRUCTURE, QUERY TRAN, QUERY TRANDESC, QUERY USER, QUERY USERID, QUEUE LTERM, QUEUE TRAN, TERMINATE OLREORG, UPDATE AREA, UPDATE DATAGRP, UPDATE DB, UPDATE DBDESC, UPDATE IMSCON, UPDATE MSLINK, UPDATE MSNAME, UPDATE MSPLINK, UPDATE OLREORG, UPDATE OTMADESC, UPDATE PGM, UPDATE PGMDESC, UPDATE RTC, UPDATE RTCDESC, UPDATE TRAN, UPDATE TRANDESC | NOBACKOUT OM keyword /START /ERESTART NBLDQ, NOBLDQ /NRESTART NOCHECK /RECOVER NOCMDAUTH /ERESTART /NRESTART NOCMDAUTHE /ERESTART /NRESTART NOCOMP /TRACE NOCQSSHUT /CHECKPOINT NODBALLOC /START 72 Commands, Volume 1: IMS Commands A - M Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword NODE /ACTIVATE /ASSIGN /BROADCAST /CHANGE /CLSDST /COMPT /DEQUEUE /DIAGNOSE /DISPLAY /END /EXCLUSIVE /EXIT /IDLE /LOCK /OPNDST /QUIESCE /START /STOP /TEST /TRACE /UNLOCK NOFEOV /DBDUMP /DBRECOVERY NOOPEN /START NOPFA /DBDUMP /DBRECOVERY /STOP NOREVERSE /RTAKEOVER NOSAVE /ASSIGN /CHANGE NOSHUT NOS /IDLE NOTRANAUTH /ERESTART /NRESTART NOTRDY /COMPT /RCOMPT NOUSER /ERESTART /NRESTART NPRI /ASSIGN CREATE TRAN CREATE TRANDESC OASN /CHANGE /DISPLAY ODBM QUERY UPDATE OFFLINE /RECOVER OLC INITIATE QUERY TERMINATE Chapter 2. Command keywords and their synonyms 73 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword OLDS OLREORG /DISPLAY /START /STOP /SWITCH OLREORG OPEN OPTION Commands that support this keyword INITIATE /INITIATE QUERY /QUERY TERMINATE /TERMINATE UPDATE /UPDATE /START OPTION DELETE DB DELETE DBDESC DELETE OTMADESC DELETE PGM DELETE PGMDESC DELETE RTC DELETE RTCDESC DELETE TRAN DELETE TRANDESC /DIAGNOSE EXPORT IMPORT INITIATE OLC INITIATE OLREORG QUERY AREA QUERY LTERM QUERY OTMADESC QUEUE LTERM QUEUE TRAN TERMINATE OLREORG /TRACE UPDATE AREA UPDATE DATAGRP UPDATE DB UPDATE DBDESC UPDATE IMS UPDATE MSLINK UPDATE ODBM UPDATE OLREORG UPDATE PGM UPDATE PGMDESC UPDATE RTC UPDATE RTCDESC UPDATE TRAN UPDATE TRANDESC OSAMGTF /DISPLAY /TRACE OTMA /DISPLAY /SECURE /START /STOP 74 Commands, Volume 1: IMS Commands A - M Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword OTMADESC OUTBND CREATE DELETE QUERY UPDATE OUTBOUND /CHANGE OUTPUT /ASSIGN /DISPLAY /START /STOP /TRACE OVERFLOWQ OFLWQ OVERRIDE OVER OVERFLOWQ /DISPLAY /ERESTART PARLIM PASSWORD Commands that support this keyword /ASSIGN CREATE TRAN CREATE TRANDESC PASSWORDS, PSWD, PSWDS PSWD /CHANGE /DELETE /MODIFY PREPARE /NRESTART PCH /COMPT /RCOMPT PDS /COMPT /RCOMPT PGMTYPE CREATE PGM CREATE PGMDESC PHASE INITIATE OLC PI /DISPLAY /TRACE PITR /RECOVER PLCT CREATE TRAN CREATE TRANDESC PLCTTIME CREATE TRAN CREATE TRANDESC PLEXPARM UPDATE IMS PLMCT PLCT PLCT /ASSIGN POOL /DISPLAY PREPARE /MODIFY PRIORITY PRTY /DISPLAY Chapter 2. Command keywords and their synonyms 75 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword PROGRAM PGM, PGMS, PROG, PGM PROGRAMS, PROGS PRT CREATE PGM CREATE PGMDESC CREATE TRAN CREATE TRANDESC DELETE LE DELETE PGM DELETE PGMDESC /DIAGNOSE DISPLAY /LOCK QUERY LE QUERY PGM QUERY PGMDESC /START /STOP /TRACE /UNLOCK UPDATE LE UPDATE PGM UPDATE PGMDESC /COMPT /RCOMPT PRTKN PRK /CHANGE CCTL PSB /DISPLAY QUERY ODBM /TRACE PSWD PTERM INITIATE OLC PTERMS PTERM PURGE /ASSIGN /BROADCAST /DEQUEUE /DISPLAY /END /EXCLUSIVE /EXIT /IAM /LOCK /LOOPTEST /MONITOR /PSTOP /PURGE /START /STOP /TEST /UNLOCK /CHECKPOINT /DEQUEUE /PSTOP PURGE1 FIRST, SINGLE, SNGL Q QS, QUEUE, QUEUES 76 Commands that support this keyword Commands, Volume 1: IMS Commands A - M /DEQUEUE Q /DISPLAY /OPNDST Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword QCNT /DISPLAY QUERY LTERM QUERY MSNAME QUERY TRAN QMGR /TRACE TABLE QUIESCE /CHECKPOINT RCVTIME /RECOVER RCVTOKEN /RECOVER RDDSDSN EXPORT RDR /COMPT /RCOMPT READNUM /RECOVER READY /COMPT /RCOMPT RECOVER CREATE TRAN CREATE TRANDESC RECOVERY REC RECOVGRP RCVGRP REGION REGIONS, REG, REGS, MSGREG, MSGREGS, MSGREGION, MSREGIONS, THREAD RECOVERY /RECOVER REGION REMOTE REMOVE /DISPLAY /ASSIGN /DIAGNOSE /DISPLAY /PSTOP /START /STOP /TRACE MONITOR CREATE TRAN CREATE TRANDESC /DISPLAY UPDATE DBDESC REM REMOVE /RECOVER RESET /CHANGE RESIDENT CREATE CREATE CREATE CREATE RESP CREATE TRAN CREATE TRANDESC RTCODE RTC RTC DB DBDESC PGM PGMDESC /DISPLAY /START /STOP SAVE /ASSIGN SB /START /STOP SCOPE IMPORT UPDATE UPDATE UPDATE UPDATE AREA DATAGRP DB TRAN Chapter 2. Command keywords and their synonyms 77 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword SCHD /TRACE MONITOR SCHDTYPE CREATE PGM CREATE PGMDESC SCIMEMBER QUERY ODBM SEGNO /ASSIGN CREATE TRAN CREATE TRANDESC SEGSIZE SEGSZ SEGSZ SERIAL SERVGRP CREATE TRAN CREATE TRANDESC SG SERVGRP SET /START /STOP CREATE DB CREATE DBDESC CREATE IMSCON CREATE OTMADESC CREATE PGM CREATE PGMDESC CREATE RTC CREATE RTCDESC CREATE TRAN CREATE TRANDESC /DIAGNOSE EXPORT INITIATE OLREORG /TRACE UPDATE DB UPDATE DBDESC UPDATE IMSCON, UPDATE LE UPDATE MSLINK UPDATE MSNAME UPDATE MSPLINK UPDATE OLREORG UPDATE OTMADESC UPDATE PGM UPDATE PGMDESC UPDATE RTC UPDATE RTCDSC UPDATE TRAN UPDATE TRANDESC | SHAREDQ 78 /ASSIGN CREATE TRAN CREATE TRANDESC SHRQ Commands, Volume 1: IMS Commands A - M SHAREDQ /CQCHKPT /CQSET Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword SHOW /DIAGNOSE QUERY AREA QUERY DB QUERY DBDESC QUERY IMS QUERY IMSPLEX QUERY LE QUERY LTERM QUERY MEMBER QUERY MSLINK QUERY MSNAME QUERY MSPLINK QUERY NODE QUERY ODBM QUERY OTMADESC QUERY OTMATI QUERY PGM QUERY PGMDESC QUERY POOL QUERY OLC QUERY OLREORG QUERY RTC QUERY RTCDESC QUERY STRUCTURE QUERY TRAN QUERY TRANDESC QUERY USER QUERY USERID SHUTDOWN /CQSET /DISPLAY SIDE /CHANGE SIDL CREATE TRAN CREATE TRANDESC SIDR CREATE TRAN CREATE TRANDESC SLDSREAD /START /STOP SMEM QUERY OTMADESC SMSOPTS /RECOVER SNAP /DIAGNOSE SNAPQ /CHECKPOINT SNGLSIGN /ERESTART /NRESTART SOURCE IMPORT SPASZ CREATE TRAN CREATE TRANDESC SPATRUNC CREATE TRAN CREATE TRANDESC SQTT /TRACE TABLE SSM /START Chapter 2. Command keywords and their synonyms 79 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword STAGLOBAL /RECOVER STALOCAL /RECOVER START STA START /RECOVER UPDATE AREA UPDATE DATAGRP UPDATE DB UPDATE MSLINK UPDATE MSNAME UPDATE MSPLINK UPDATE ODBM UPDATE PGM UPDATE RTC UPDATE TRAN STARTTIME EXPORT STATISTICS /CHECKPOINT /CQQUERY QUERY STRUCTURE STATUS /DISPLAY QUERY AREA QUERY DB QUERY IMSPLEX QUERY LTERM QUERY MEMBER QUERY MSLINK QUERY MSNAME QUERY MSPLINK QUERY NODE QUERY ODBM QUERY PGM QUERY OLREORG QUERY RTC QUERY TRAN QUERY USER STOP STO STOP /RECOVER UPDATE AREA UPDATE DATAGRP UPDATE DB UPDATE MSLINK UPDATE MSNAME UPDATE MSPLINK UPDATE ODBM UPDATE PGM UPDATE RTC UPDATE TRAN STRUCTURE STRUC STRUCTURE /CQCHKPT /CQQUERY /CQSET /DIAGNOSE /DISPLAY SUBSYS SUBSYSTEM, SUBSYSTEMS SUBSYS /CHANGE /DISPLAY /START /STOP 80 Commands, Volume 1: IMS Commands A - M Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword SURVEILLANCE SUR, SURV, SURVEIL SURV /CHANGE /START /STOP SUSPEND /DEQUEUE SYNCLEVEL SYNCLV /CHANGE QUERY OTMATI SYNCSESS SYNC /CHANGE SYSID /BROADCAST /DISPLAY /MSASSIGN /MSVERIFY SYSTEM /CQCHKPT /SWITCH /UNLOCK TABLE /DISPLAY /TRACE TAKEOVER TKO, TKOVR /TRACE TARGET EXPORT TCO /DISPLAY /TRACE TDS /COMPT /RCOMPT TERMINAL TER, TERM, TERMINALS, TERMS, TERS TERMINAL THREAD TIMEOUT INITIATE OLC /SMCOPY /START /STOP TIMO /CHANGE /DISPLAY /TRACE TIMEOVER /DISPLAY TMEMBER TMEM TPIPE TPI TMEM /DEQUEUE /DISPLAY /EXIT QUERY OTMADESC QUERY OTMATI /START /STOP /TRACE /DEQUEUE /DISPLAY QUERY OTMADESC QUERY OTMATI /START /STOP /TRACE Chapter 2. Command keywords and their synonyms 81 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym TPNAME TP, TPN OM keyword Commands that support this keyword /ALLOCATE /CHANGE /DEQUEUE /DISPLAY /START /STOP /TRACE TRACE /DISPLAY TRACKING /DISPLAY TRACKING STATUS /DISPLAY TRANAUTH /ERESTART /NRESTART TRANCMDS INITIATE OLC TRANSACTION TRANS, TRAN, TRANSACTIONS, TRANCODE, TRANCODES, TRS TRAN /ASSIGN /CHANGE CREATE TRAN CREATE TRANDESC DELETE LE DELETE TRAN DELETE TRANDESC /DEQUEUE /DIAGNOSE /DISPLAY /LOCK /MSASSIGN /PSTOP /PURGE QUERY LE QUERY OTMATI QUERY TRAN QUERY TRANDESC /SET /START /STOP /TRACE /UNLOCK UPDATE LE UPDATE TRAN UPDATE TRANDESC TRANSTAT CREATE CREATE CREATE CREATE TRAP /DISPLAY /TRACE TRKAUTOARCH TRKARCH TRS 82 TRKARCH PGM PGMDESC TRAN TRANDESC /START /DISPLAY MODIFY Commands, Volume 1: IMS Commands A - M Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword TYPE /CHANGE CREATE IMSCON EXPORT IMPORT INITIATE OLC QUERY DB QUERY IMS QUERY IMSCON QUERY IMSPLEX QUERY MEMBER QUERY MSPLINK QUERY ODBM QUERY OTMADESC QUERY POOL QUERY STRUCTURE UPDATE IMSCON UPDATE ODBM UDATA /OPNDST UDS /COMPT /RCOMPT UNITYPE /TRACE UNPLAN /RTAKEOVER UOR /CHANGE /DISPLAY | USEDBDS USEAREA USER SUBPOOL USERD USRD /RECOVER USER /ASSIGN /BROADCAST /CHANGE /CLSDST /COMPT /DEQUEUE /DIAGNOSE /DISPLAY /END /ERESTART /EXCLUSIVE /EXIT /NRESTART /OPNDST /QUIESCE /START /STOP /TEST /TRACE /OPNDST USERID DELETE LE QUERY LE QUERY OTMATI UPDATE LE VERIFY /RECOVER VGRS VGR VGR /STOP Chapter 2. Command keywords and their synonyms 83 Table 80. Command keywords and their synonyms (continued) IMS keyword Synonym OM keyword Commands that support this keyword VID /COMPT /RCOMPT VOLUME /TRACE VTAMPOOL VPL /ASSIGN WADS /STOP /SWITCH WFI CREATE TRAN CREATE TRANDESC WPM1 /COMPT WPM2 /COMPT WPM3 /COMPT XRCTRACK /START /STOP XTRC XTRACE, EXTRACE /DISPLAY TRACE Notes: 1 ISOLOG and TRKAUTOARCH are valid only for an RSR tracking subsystem. Related reference: IMS Command Language Modification facility (DFSCKWD0) (Exit Routines) 84 Commands, Volume 1: IMS Commands A - M Chapter 3. Commands and keywords valid in DBCTL Commands and keywords that are valid in the Database Control (DBCTL) environment are listed. The following table lists commands and keywords valid in the Database Control (DBCTL) environment. All commands and keywords are valid in a DB/DC environment. Table 81. Commands and keywords valid in DBCTL Commands Keywords Topic /CHANGE ABORT, AUTOLOGON, CCTL, COMMIT, FDR, OASN, PASSWORD, PRTKN, RESET, SUBSYS, TIMEOUT Chapter 12, “/CHANGE commands,” on page 129 /CHECKPOINT ABDUMP, FREEZE, PURGE, STATISTICS Chapter 13, “/CHECKPOINT command,” on page 153 CREATE PGMDESC, PGM Chapter 19, “CREATE commands,” on page 175 /DBDUMP DB, GLOBAL, LOCAL, NOFEOV, NOPFA Chapter 20, “/DBDUMP command,” on page 293 /DBRECOVERY AREA, DB, DATAGRP, GLOBAL, LOCAL, NOFEOV, NOPFA Chapter 21, “/DBRECOVERY command,” on page 299 /DELETE DB, PASSWORD, PGM Chapter 22, “/DELETE command,” on page 309 DELETE DB, DBDESC, DEFN, LE, PGM, PGMDESC Chapter 23, “DELETE commands,” on page 311 /DEQUEUE AOITOKEN Chapter 24, “/DEQUEUE command,” on page 383 /DIAGNOSE AREA, ADDRESS, BLOCK, DB, JOBNAME, MODULE, OPTION, PGM, REGION, SET, SHOW, SNAP Chapter 25, “/DIAGNOSE commands,” on page 391 /DISPLAY Chapter 26, “/DISPLAY commands,” ACTIVE, AOITOKEN, AREA, BKERR, CCTL, CPLOG. on page 433 DB, DBD, FDR, FPVIRTUAL, HSSP, INDOUBT, MADSIOT, MODIFY, MONITOR, OASN, OLDS, OSAMGTF, PI, POOL, PGM, PSB, RECOVERY, REGION, SHUTDOWN, STATUS, SUBSYS, TABLE, TCO, TRACE, TRACKING STATUS, XTRC /ERESTART CHECKPOINT, COLDBASE, COLDSYS, FORMAT, NOBMP, OVERRIDE Chapter 28, “/ERESTART command,” on page 677 EXPORT DEFN, ENDTIME, NAME, OPTION, RDDSDSN, SET, STARTTIME, TARGET, TYPE Chapter 31, “EXPORT command,” on page 695 IMPORT DEFN, NAME, OPTION, RDDSDSN, SCOPE, SOURCE, TYPE Chapter 36, “IMPORT command,” on page 737 INITIATE OLC, OLREORG Chapter 37, “INITIATE commands,” on page 775 /LOCK DB, PGM Chapter 38, “/LOCK command,” on page 831 /LOG /MODIFY Chapter 39, “/LOG command,” on page 837 ABORT, COMMIT, PASSWORD, PREPARE © Copyright IBM Corp. 1974, 2014 Chapter 41, “/MODIFY command,” on page 841 85 Table 81. Commands and keywords valid in DBCTL (continued) Commands Keywords Topic /NRESTART CHECKPOINT, FORMAT /NRESTART command (Commands) /PSTOP AOITOKEN, JOBNAME, REGION /PSTOP command (Commands) QUERY AREA, DB, DBDESC, IMS, LE, MEMBER, ODBM, OLC, OLREORG, PGM, PGMDESC, POOL, USEREXIT QUERY commands (Commands) /RECOVER ALLENTRIES, AREA, CAGROUP, DB, DBDS, DBDSGRP, ERRORABORT, ERRORCONT, NOCHECK, OFFLINE, PITR, RCVTIME, RCVTOKEN, READNUM, RECOVGRP, REMOVE, SMSOPTS, STAGLOBAL, STALOCAL, START, STOP, USEAREA, USEDBDS, VERIFY /RECOVER commands (Commands) REFRESH USEREXIT REFRESH USEREXIT command (Commands) /RMxxxxxx /RTAKEOVER /RMxxxxxx commands (Commands) DUMPQ, FREEZE, NOREVERSE, UNPLAN /SSR /RTAKEOVER command (Commands) /SSR command (Commands) /START /START commands (Commands) ACCESS, AREA, AUTOARCH, DB, DATAGRP, DBALLOC, GLOBAL, ISOLOG, JOBNAME, LOCAL, MADSIOT, NOBACKOUT, NODBALLOC, NOOPEN, OLDS, OPEN, PGM, REGION, SB, SERVGRP, SLDSREAD, SSM, SUBSYS, THREAD, TRKAUTOARCH, WADS, XRCTRACK /STOP ABDUMP, ADS, AREA, AUTOARCH, CANCEL, DB, DATAGRP, GLOBAL, JOBNAME, LOCAL, MADSIOT, NOPFA, OLDS, PGM, REGION, SB, SERVGRP, SLDSREAD, SUBSYS, WADS, XRCTRACK /STOP commands (Commands) /SWITCH CHECKPOINT, OLDS, WADS /SWITCH command (Commands) TERMINATE OLC, OLREORG TERMINATE OLC command (Commands) /TRACE COMP, MONITOR, NOCOMP, OPTION, OSAMGTF, PI, PGM, PSB, SET, TABLE, TCO, VOLUME /TRACE commands (Commands) /UNLOCK DB, PGM /UNLOCK commands (Commands) UPDATE AREA, DB, DBDESC, DATAGRP, IMS, LE, ODBM, OLREORG, PGM, PGMDESC, POOL UPDATE commands (Commands) /VUNLOAD AREA /VUNLOAD command (Commands) 86 Commands, Volume 1: IMS Commands A - M Chapter 4. Commands and keywords valid in DCCTL Commands and keywords that are valid in a Data Communications Control (DCCTL) environment are listed. The following table lists commands and keywords valid in a Data Communications Control (DCCTL) environment. All commands and keywords are valid in a DB/DC environment. Table 82. Commands and keywords valid in DCCTL Commands Keywords Topic /ACTIVATE LINK, NODE Chapter 7, “/ACTIVATE command,” on page 97 /ALLOCATE LUNAME, MODE, TPNAME Chapter 8, “/ALLOCATE command,” on page 99 /ASSIGN CLASS, COMPONENT, CPRI, COMPONENT, INPUT, LINE, LCT, LPRI, LTERM, NODE, NOSAVE, NPRI, OUTPUT, PARLIM, PLCT, PTERM, REGION, SAVE, SEGNO, SEGSIZE, TRANSACTION, USER, VTAMPOOL Chapter 9, “/ASSIGN command,” on page 101 /BROADCAST ACTIVE, LINE, LTERM, MASTER, MSNAME, NODE, PTERM, SYSID, USER Chapter 10, “/BROADCAST command,” on page 121 /CANCEL Chapter 11, “/CANCEL command,” on page 127 /CHANGE Chapter 12, “/CHANGE commands,” APPC, ASR, AUTOLOGON, COLDSESS, CPLOG, DESCRIPTOR, DIRECTORY, FORCSESS, ID, INTERVAL, on page 129 LINK, LOGOND, LUNAME, MAXRGN, MODE, NODE, NOSAVE, OASN, OUTBND, PASSWORD, RESET, SAVE, SIDE, SUBSYS, SURVEILLANCE, SYNCLEVEL, SYNCSESS, TIMEOUT, TPNAME, TRANSACTION, TYPE, UOR, USER /CHECKPOINT ABDUMP, DUMPQ, FREEZE, LEAVEPLEX, Chapter 13, “/CHECKPOINT NOCQSSHUT, PURGE, QUIESCE, SNAPQ, STATISTICS command,” on page 153 /CLSDST FORCE, NODE, USER Chapter 14, “/CLSDST command,” on page 159 /COMPT CNS, CRD, NODE, NOTRDY, PCH, PDS, PRT, RDR, READY, TDS, UDS, USER, VID, WPM1, WPM2, WPM3 Chapter 15, “/COMPT command,” on page 163 /CQCHKPT SHAREDQ, STRUCTURE, SYSTEM Chapter 16, “/CQCHKPT command,” on page 167 /CQQUERY STATISTICS, STRUCTURE Chapter 17, “/CQQUERY command,” on page 169 /CQSET SHAREDQ, SHUTDOWN, STRUCTURE Chapter 18, “/CQSET command,” on page 173 CREATE OTMADESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, Chapter 19, “CREATE commands,” on TRANDESC page 175 /DELETE LINE, LTERM, NODE, PASSWORD, PGM, PTERM, TERMINAL, TRANSACTION Chapter 22, “/DELETE command,” on page 309 DELETE LE, OTMADESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, TRANDESC Chapter 23, “DELETE commands,” on page 311 © Copyright IBM Corp. 1974, 2014 87 Table 82. Commands and keywords valid in DCCTL (continued) Commands Keywords Topic /DEQUEUE AOITOKEN, LINE, LTERM, LUNAME, MSNAME, NODE, PTERM, PURGE, PURGE1, SUSPEND, TMEMBER, TPIPE, TPNAME, TRANSACTION, USER Chapter 24, “/DEQUEUE command,” on page 383 /DIAGNOSE ADDRESS, AOSLOG, BLOCK, JOBNAME, LINE, LINK, Chapter 25, “/DIAGNOSE LTERM, MODULE, MSNAME, NODE, OPTION, PGM, commands,” on page 391 REGION, RM, SET, SHOW, SNAP, STRUCTURE, TRAN, USER /DISPLAY Chapter 26, “/DISPLAY commands,” ACT, AFFIN, AOITKN, APPC, ASMT, AUTOLOGON, BALGRP, CLASS, CONVERSATION, CPLOG, CQS, DC, on page 433 DESCRIPTOR, EMHQ, EXIT, HSB, INPUT, LINE, LINK, LTERM, LUNAME, MASTER, MODE, MODIFY, MONITOR, MSGAGE, MSNAME, MSPLINK, NODE, OASN, OLDS, OTMA, OUTPUT, OVERFLOWQ, PGM, POOL, PRIORITY, PGM, PSB, PTERM, Q, QCNT, REGION, REMOTE, RTCODE, SHUTDOWN, STATUS, STRUCTURE, SUBSYS, SYSID, TABLE, TCO, TIMEOUT, TIMEOVER, TMEMBER, TPIPE, TPNAME, TRACE, TRACKING STATUS, TRANSACTION, TRAP, UOR, USER, XTRC /END LINE, NODE, PTERM, USER /ERESTART Chapter 28, “/ERESTART command,” BACKUP, BUILDQ, CHECKPOINT, CMDAUTH, on page 677 CMDAUTHE, COLDCOMM, COLDSYS, FORMAT, MULTSIGN, NOBMP, NOCMDAUTH, NOCMDAUTHE, NOPASSWORD, NOTERMINAL, NOTRANAUTH, NOTRANCMDS, NOUSER, OVERRIDE, PASSWORD, SNGLSIGN, TERMINAL, TRANAUTH, TRANCMDS, USER /EXCLUSIVE LINE, NODE, PTERM, USER Chapter 29, “/EXCLUSIVE command,” on page 689 /EXIT CONVERSATION, LINE, NODE, PTERM, USER Chapter 30, “/EXIT command,” on page 691 /FORMAT LTERM Chapter 32, “/FORMAT command,” on page 727 | | /HOLD Chapter 27, “/END command,” on page 675 Chapter 33, “/HOLD command,” on page 729 /IAM DONE, LTERM, PTERM Chapter 34, “/IAM command,” on page 731 /IDLE LINE, LINK, NODE, NOSHUT Chapter 35, “/IDLE command,” on page 733 IMPORT DEFN, NAME, OPTION, RDDSDSN, SOURCE, TYPE Chapter 36, “IMPORT command,” on page 737 INITIATE OLC, OLREORG Chapter 37, “INITIATE commands,” on page 775 /LOCK LTERM, NODE, PGM, PTERM, TRANSACTION Chapter 38, “/LOCK command,” on page 831 /LOG /LOOPTEST 88 Chapter 39, “/LOG command,” on page 837 LINE, PTERM Commands, Volume 1: IMS Commands A - M Chapter 40, “/LOOPTEST command,” on page 839 Table 82. Commands and keywords valid in DCCTL (continued) Commands Keywords Topic /MODIFY ABORT, COMMIT, LTERM, PASSWORD, PREPARE, TERMINAL, TRANCMDS Chapter 41, “/MODIFY command,” on page 841 /MONITOR LINE, PTERM Chapter 42, “/MONITOR command,” on page 847 /MSASSIGN LINK, LOCAL, MSNAME, MSPLINK, SYSID, TRANSACTION Chapter 43, “/MSASSIGN command,” on page 849 /MSVERIFY MSNAME, SYSID Chapter 44, “/MSVERIFY command,” on page 853 /NRESTART BUILDQ, CHECKPOINT, CMDAUTH, CMDAUTHE, FORMAT, MULTSIGN, NOBUILDQ, NOCMDAUTH, NOCMDAUTHE, NOPASSWORD, NOTERMINAL, NOTRANAUTH, NOTRANCMDS, NOUSER, PASSWORD, SNGLSIGN, TERMINAL, TRANAUTH, TRANCMDS, USER /NRESTART command (Commands) /OPNDST ID, LOGOND, MODE, NODE, Q, UDATA, USER, USERD /OPNDST command (Commands) /PSTOP AOITOKEN, CLASS, FORCE, JOBNAME, LINE, LINK, LTERM, MSPLINK, PTERM, PURGE, REGION, TRANSACTION /PSTOP command (Commands) /PURGE APPC, CLASS, FPPROG, FPREGION, LINE, LTERM, MSNAME, PTERM, TRANSACTION /PURGE command (Commands) QUERY QUERY commands (Commands) IMS, LE, LTERM, MEMBER, MSLINK, MSNAME, MSPLINK, NODE, OLC, OTMADESC, OTMATI, PGM, PGMDESC, RTC, RTCDESC, TRAN, TRANDESC, USER, USEREXIT, USERID QUEUE LTERM, TRAN QUEUE commands (Commands) /QUIESCE NODE, USER /QUIESCE command (Commands) /RCLSDST /RCLSDST command (Commands) /RCOMPT CNS, NOTRDY, PCH, PDS, PRT, RDR, READY, TDS, UDS, VID /RCOMPT command (Commands) /RDISPLAY MASTER /RDISPLAY command (Commands) REFRESH USEREXIT REFRESH USEREXIT command (Commands) /RELEASE CONVERSATION /RELEASE command (Commands) /RESET /RESET command (Commands) /RMxxxxxx LTERM /RMxxxxxx commands (Commands) /RSTART CONTINUOUS, LINE, LINK, LOPEN, MODE, MSPLINK, NODE, PTERM, USER /RSTART command (Commands) /RTAKEOVER DUMPQ, FREEZE, NOREVERSE, UNPLAN /RTAKEOVER command (Commands) /SECURE APPC, OTMA /SECURE command (Commands) /SET CONVERSATION, LTERM, TRANSACTION /SET command (Commands) /SIGN /SMCOPY /SSR /SIGN command (Commands) MASTER, TERMINAL /SMCOPY command (Commands) /SSR command (Commands) Chapter 4. Commands and keywords valid in DCCTL 89 Table 82. Commands and keywords valid in DCCTL (continued) Commands Keywords /START /START commands (Commands) AFFINITY, APPC, AUTOARCH, CLASS, DC, DESC, GRSNAME, INPUT, ISOLOG, JOBNAME, LINE, LTERM, LUNAME, MSNAME, NODE, OLDS, OTMA, OUTPUT, PGM, PTERM, REGION, RTCODE, SERVGRP, SLDSREAD, SSM, SUBSYS, SURVEILLANCE, TMEMBER, TPIPE, TPNAME, TRANSACTION, TRKAUTOARCH, USER, VGR, WADS, XRCTRACK /STOP ABDUMP, APPC, AUTOARCH, BACKUP, CANCEL, CLASS, DESC, DC, INPUT, JOBNAME, LINE, LTERM, LUNAME, MSNAME, NODE, OLDS, OTMA, OUTPUT, PGM, PTERM, REGION, RTCODE, SERVGRP, SLDSREAD, SUBSYS, SURVEILLANCE, THREAD, TMEMBER, TPIPE, TPNAME, TRANSACTION, USER, VGR, WADS, XRCTRACK /STOP commands (Commands) /SWITCH ABDUMP, ACTIVE, BACKUP, CHECKPOINT, FORCE, OLDS, SYSTEM, WADS /SWITCH command (Commands) TERMINATE OLC TERMINATE OLC command (Commands) /TEST LINE, NODE, PTERM, USER /TEST command (Commands) /TRACE AUTO, EXIT, INPUT, LEVEL, LINE, LINK, LUNAME, MODULE, MONITOR, MSG, NODE, OPTION, OUTPUT, PGM, SET, TABLE, TAKEOVER, TCO, TIMEOUT, TMEMBER, TPIPE, TPNAME, TRANSACTION, TRAP, UNITYPE, USER, VOLUME /TRACE commands (Commands) /UNLOCK LTERM, NODE, PGM, PTERM, SYSTEM, TRANSACTION /UNLOCK commands (Commands) UPDATE IMS, LE, MSLINK, MSNAME, MSPLINK, OTMADESC, PGM, PGMDESC, POOL, RTC, RTCDESC, TRAN, TRANDESC UPDATE commands (Commands) 90 Commands, Volume 1: IMS Commands A - M Topic Chapter 5. List of reserved words Some words are used and reserved only for IMS commands. The following table is a list of words that cannot be used to name resources such as transactions or databases. The words listed in this table are used and reserved only for IMS commands. Table 83. Words used and reserved only for IMS commands A ABDUMP ABORT ACT ACTIV ACTIVATE ADDS ADS AFF AFFINITY AFTER AOITKN APMQ AOITOKEN ALL ALLENT ALLOC ALLOCATE ALLOCS APPC ARCHIVE ASMT ASR ASSIGN AUTO AUTOARC AUTOARCH AUTOLGN AUTOSR BACKOUT BALG BALGRP BKERR BLDQS BROADCAST BU BUILDQS C1INOP C2INOP C4INOP CAGROUP CAGRP CC CCTL CHANGE CHECKPT CHKPOINT CHKPT CLASS CLS CLSDST CMDAUTHE CNS COLDB COLDC COLDCOMM COLDS COLDSYS COMMIT COMP COMPONENT COMPT CON CONTINUOUS CONV CONVACT CONVHLD CPRI CQCHKPT CPLOG CQC CQQ CQSET CRD DATABASE DATAGROUP DATAGRP DB DBD DBDS DBDSGRP DBR DBRECOVERY DBS DEACT DEADQ DELETE DEQUEUE DESC DESCRIPTOR DLOG DIS DISP DIR DIRECTORY DMS DUMPQ DUMPQS EEQE END ERESTART ERRORCONT EXCLUSIVE EXIT EXTRACE FDR FIRST FMS FOR FORC FORCE FORCSESS FORMAT FPPROG FPRGN FPV FPVIRTUAL GLOBAL GRS GRSN HOLD HOTSTANDBY HSB IAM IC ICOMPONENT ID IDCO IDLE INDOUBT INOP INPUT © Copyright IBM Corp. 1974, 2014 ACCESS ACTIVE AFFIN APDB ALLENTRIES ALLOCF AREA ASSIGNMENT AUTOLOGON BACKUP BLDQ BUILDQ C3INOP CANCEL CHECKPOINT CHNGS CMDAUTH COLDBASE COLDSESS COMPINOP CONT CONVERSATION CQQUERY CQS DATABASES DBALLOC DBDUMP DC DELS DL/I DISPLAY DONE EMHQ EXCL FAST FMT FORCES FPREGION FREEZE GRSNAME HSSP ICOMPT IND INQONLY 91 Table 83. Words used and reserved only for IMS commands (continued) INT INTERVAL INTV ISOLOG JBN JOB KEY LA LATC LEAVEGR LEVEL LGND LINES LINK LMCT LOCAL LOCK LOG LOOPTEST LOPEN LOST LRTT LTERM LTERMS LUMI LUN LUNAME MASTER MAXRGN MESSAGE MFSTEST MODE MODETABLE MODIFY MODS MODULE MONITOR MSASSIGN MSDB MSG MSGAGE MSGREG MSGREGIONS MSGREGS MSNAME MSVERIFY MULTSIGN NBLDQ NOBKO NOBLDQ NOBMP NOCHECK NOCMDAUTH NOCMDAUTHE NODBALLOC NODE NOFEOV NONE NOOUT NOPASSWORD NOPSWD NOQUEUE NOREVERSE NOSAVE NOSHUT NOTER NOTERMINAL NOTINIT NOTOPEN NOTRANCMDS NOTRDY NOUSER NRESTART OASN OFF OFR OLDS OLREORG OPNDST OPTION OSAMGTF OTMT OUTPUT OVER OVERRIDE OVFLWQ PAGE PASSWORD PASSWORDS PCH PGM PGMS PI PLCT PLMCT POOL PREO PREPARE PRI PRIORITY PRK PROG PROGRAMS PROGS PRST PRTKN PRTY PSB PSTOP PSTOPPED PSWD PTERM PTERMS PUR PURGE1 Q QCNT QRTT QS QUEUE QUI QUIESCE RCLSDST RCS RCVTIME RCVTOKEN RDR READNUM READY RECOVGRP REG REGION REGS RELEASE RELREQ REMOVE RESET RESP RESYNC RETR RMCHANGE RMGENJCL RMINIT RMLIST RSTART RTAKEOVER RTC SAVE SB SCHD SECURE SECURITY SEGNO SEGSZ SERVGRP SET SHAREDQ SHRQ SHUT SIDE SIGN SIMLOGON SMCOPY SNAPQ SNGL 92 Commands, Volume 1: IMS Commands A - M IOVF JOBNAME LCT LINE LOC LOGOND LPRI LU MADSIOT MFST MODETBL MON MSDBLOAD MSGREGION MSPLINK NOBACKOUT NOBUILDQ NOCOMP NOIN NOPFA NOS NOTERM NOTRANAUTH NPRI OFFLINE ON OTMA OVERFLOWQ PARLIM PDS PITR PREL PRIMARY PROGRAM PRT PSS PSWDS PURGE QMGR QUEUES RCOMPT RDISPLAY RECOVERY REGIONS REMOTE RESPINP RMDELETE RMNOTIFY RTCODE SEC SEGSIZE SG SHUTDOWN SINGLE SNGLSIGN Table 83. Words used and reserved only for IMS commands (continued) SQTT SSM SSR STALOCAL STA START STATISTICS STATUS STO STOPPED STRG STRUC SUB SUBS SUBPOOL SUBSYSMEMBER SUBSYSTEM SUBSYSTEMS SURV SURVEIL SURVEILLANCE SWITCH SYNC SYNCLEVEL SYNCSESS SYSID SYSTEM TAKEOVER TCO TDS TERM TERMINAL TERMINALS TERMS TERS TEST TIMEOUT TIMEOVER TIMO TKOTRA TKOVR TMEM TO TP TPI TPN TPNAME TRA TRACKING TRACKING STATUS TRAN TRANCMDS TRANCODE TRANCODES TRANSACTION TRANSACTIONS TRAP TRKAUTOARCH TRS TYPE UDS UNITYPE UNL UNPLAN UOR USEDBDS USERD USRD VERIFY VGRS VID VIR VPL VTAMPOOL VUNLOAD WPM1 WPM2 WPM3 XTRC XTRACE STAGLOBAL STATIC STOP STRUCTURE SUBSYS SUR SUSPEND SYNCLV TABLE TER TERMINATE THREAD TKO TMEMBER TPIPE TRACE TRANAUTH TRANS TRKARCH UDATA UNLOCK USER VGR VOLUME WADS XKEY Chapter 5. List of reserved words 93 94 Commands, Volume 1: IMS Commands A - M Chapter 6. IMS type-1 commands that are valid in ETO The commands that are valid for lterms, nodes, and users in ETO are listed. The following table lists the type-1 commands that are valid for lterms, nodes, and users in ETO. Table 84. IMS type-1 commands valid in ETO Commands Dynamic lterms that are valid /ACTIVATE Dynamic nodes that are valid Dynamic users that are valid X 1 /ASSIGN X /BROADCAST X X2 X X /CHANGE X X /CLSDST X X /COMPT X X /DEQUEUE X X X /DISPLAY X X X /END X /EXCLUSIVE X /EXIT /FORMAT X X /IDLE X /LOCK X /MODIFY X /OPNDST X /PURGE X /QUIESCE X X X X X /RSTART /SET X X /PSTOP /RMxxxxxx X X /SIGN X /START X X X /STOP X X X /TEST X /TRACE /UNLOCK X X X Notes: 1. Only valid for /ASSIGN LTERM USER. 2. Only valid for /ASSIGN USER. © Copyright IBM Corp. 1974, 2014 95 96 Commands, Volume 1: IMS Commands A - M Chapter 7. /ACTIVATE command The /ACTIVATE command is used to activate VTAM nodes or MSC links with a VTAM "VARY NET, ACTIVE" command. The /ACTIVATE command can also be used to undo the conditions set by the /IDLE command. Subsections: v “Environment” v v v v “Syntax” “Keywords” “Usage notes” “Examples” on page 98 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 85. Valid environments for the /ACTIVATE command and keywords Command / Keywords DB/DC DBCTL DCCTL /ACTIVATE X X LINK X X NODE X X Syntax /ACTIVATE /ACT NODE nodename LINK link# ALL Keywords The following keywords apply to the /ACTIVATE command: LINK Specifies the MSC links to be activated. NODE Specifies the VTAM nodes to be activated. Usage notes The /ACTIVATE command is used with the IMS VTAM I/O Timeout Detection Facility. © Copyright IBM Corp. 1974, 2014 97 This command can be issued to an IMSplex using the Batch SPOC utility. Examples The following are examples of the /ACTIVATE command: Example 1 for /ACTIVATE command Entry ET: /ACTIVATE LINK 1 Response ET: DFS058I ACTIVATE COMMAND COMPLETED Explanation: Link 1 has been activated. Example 2 for /ACTIVATE command Entry ET: /ACTIVATE NODE ABC Response ET: DFS058I ACTIVATE COMMAND COMPLETED Explanation: Node ABC has been activated. 98 Commands, Volume 1: IMS Commands A - M Chapter 8. /ALLOCATE command Use the /ALLOCATE command for delivering asynchronous output when the LU 6.2 device is available. The command can be originated by the remote LU 6.2 device for this purpose. /ALLOCATE is a multisegment command similar to the /OPNDST command for VTAM terminals. It causes IMS to allocate a conversation to the specified LUNAME and TPNAME if any output is queued in IMS for that destination. If no such output exists, the command has no effect and (in a non-shared-queues environment) an error message is issued. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 100 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 86. Valid environments for the /ALLOCATE command and keywords Command / Keywords DB/DC DBCTL DCCTL /ALLOCATE X X LUNAME X X MODE X X TPNAME X X Syntax /ALLOCATE /ALL LUNAME luname TPNAME tpname MODE modename NONE Keywords The following keywords apply to the ALLOCATE command: LUNAME Specifies the LU name of the LU 6.2 application program that is to be allocated. A network-qualified LU name is optional for the LUNAME keyword MODE Identifies the LOGON MODE table entry that VTAM uses to determine the session operating characteristics. NONE, which can be used as a MODE keyword parameter, resets the MODE field to its null state. © Copyright IBM Corp. 1974, 2014 99 TPNAME Specifies the TP name of the LU 6.2 application program that is to be allocated. Usage notes /ALLOCATE requires an end-of-message (EOM) indicator. An end-of-segment (EOS) indicator must be included for all segments preceding the last segment. After the syntax checking of the /ALLOCATE command is successfully completed, the DFS058 ALLOCATE COMMAND COMPLETED message is issued and processing of the command continues asynchronously. This command can be issued to an IMSplex using the Batch SPOC utility. Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 100 Commands, Volume 1: IMS Commands A - M Chapter 9. /ASSIGN command The /ASSIGN command alters the relationships between various IMS resources and resets certain values specified during IMS system definition. Subsections: v “Environment” v “Syntax” on page 102 v v v v v “Keywords” on page 103 “Usage notes” on page 111 “/ASSIGN in an IMSplex” on page 112 “Equivalent IMS type-2 commands” on page 114 “Examples” on page 114 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 87. Valid environments for the /ASSIGN command and keywords Command / Keywords DB/DC DBCTL DCCTL /ASSIGN X X CLASS X X COMPONENT X X CPRI X X ICOMPONENT X X INPUT X X LINE X X LCT X X LPRI X X LTERM X X NODE X X NOSAVE X X NPRI X X OUTPUT X X PARLIM X X PLCT X X PTERM X X REGION X X SAVE X X SEGNO X X SEGSZ X X TRAN X X © Copyright IBM Corp. 1974, 2014 101 Table 87. Valid environments for the /ASSIGN command and keywords (continued) Command / Keywords DB/DC DBCTL DCCTL USER X X VTAMPOOL X X Syntax CLASS cls# /ASSIGN /ASS REGION reg# TO CPRI TRAN tranname cpri# INPUT LTERM TO ltermname A TO TRAN tranname LCT lct# LPRI lpri# TO LTERM ltermname B TO PRIMARY NPRI C TRAN tranname npri# OUTPUT LTERM TO ltermname D TO TRAN tranname PARLIM parlim# PLCT plct# SEGNO seg# SEGSZ segsz# TO TRAN tranname CLASS cls# TO USER username USER username TO SAVE NOSAVE VTAMPOOL A: LINE line# PTERM pterm# ICOMPONENT B: 102 Commands, Volume 1: IMS Commands A - M icompt# LINE LTERM NODE USER line# PTERM pterm# E ltermname nodename F username F SAVE NOSAVE F C: LINE line# PTERM NODE nodename pterm# D: LINE line# PTERM pterm# COMPONENT compt# E: LINE line# PTERM PTERM pterm# pterm# F: ICOMPONENT icompt# COMPONENT compt# Keywords The following keywords can be specified for the /ASSIGN command: CLASS Specifies either the classes of transactions that a message processing region can schedule or the message processing class of a transaction. The /ASSIGN CLASS cls# (TO) REGION reg# command can include up to four class parameters and replaces the class values that existed previously. Valid class parameters are numeric values from 1 to 999. For static transactions, the CLASS parameter (cls#) is initially set by system definition using the TRANSACT macro statement. For CPI communications driven transactions, the initial value is obtained from the TP profile. COMPONENT Allows output for a logical terminal to be directed to a specific component of a physical terminal. The COMPONENT parameter, which can have values 1, 2, 3 or 4, indicates the terminal component that should receive the output. Parameter values other than 1 are valid for the 3275 and SLU 1 terminals, as well as type 1 and type P secondary logical units. When assigning a COMPONENT value from a terminal with components to a terminal without components, give the compt# a value of 1. Chapter 9. /ASSIGN command 103 The following table shows the relationships between COMPONENT values and terminals. The first column lists the terminal, the second and third columns list the COMPONENT parameters that can have values of 1, 2, 3, or 4. Table 88. Relationships between COMPONENT/ICOMPONENT values and terminals Terminal 1 2/3/4 3275 Video Printer 3770 Console/Printer Defined in TERMINAL macro on logon descriptor during system definition. SLU 1 Defined in TERMINAL macro on logon descriptor during system definition. SLU P terminal Defined in TERMINAL macro on logon descriptor during system definition. SLU 4 Defined in TERMINAL macro during system definition. CPRI Specifies a new value for the current priority of a transaction. The CPRI keyword is not allowed for BMP transactions, since BMP transactions should always have a priority of 0. The new CPRI value takes effect the next time the transaction is scheduled. Valid CPRI parameters are numeric values from 0 to 14. ICOMPONENT Specifies the input component of a logical terminal to be directed to a specific component of a physical terminal. The ICOMPONENT parameter, which can have values 1, 2, 3, or 4, indicates the terminal component that should receive the input. Parameter values other than 1 are valid for the 3275 and SLU 1 terminals, as well as type 1 and type P secondary logical units. When assigning from a terminal with components to a terminal without components, give icompt# a value of 1. See Table 88 for relationships between ICOMPONENT values and terminal components. INPUT Specifies that the input capability of a logical terminal is to be assigned to a given nonswitched physical terminal without affecting the output assignment. More than one physical terminal can be assigned as input for a logical terminal, but the logical terminal used must be the first logical terminal in a “chain.” LINE Specifies the non-VTAM devices to which the input or output capabilities (or both) of a logical terminal are to be assigned. The physical terminal must not be on a switched line, in conversational, response, or preset destination modes. LCT Specifies a new value for the limit count of a transaction. The new LCT value takes effect during execution of the transaction. Valid LCT parameters are numeric values from 1 to 65535. LPRI Specifies a new value for the limit priority of a transaction. The LPRI keyword is not allowed for BMP transactions, since BMP transactions should always have a priority of 0. The new LPRI value takes effect the next time the transaction is scheduled. Valid LPRI parameters are numeric values from 0 to 14. 104 Commands, Volume 1: IMS Commands A - M LTERM LTERM assigns the input and output capabilities of a local logical terminal to the given nonswitched physical terminal or terminals. The /ASSIGN LTERM command does not apply to Multiple Systems Coupling (MSC) remote logical terminals. v If you specify /ASSIGN LTERM with LINE/PTERM selected, the first physical terminal (LINE/PTERM specification) is the input assignment. The second physical terminal (LINE/PTERM specification) is the output assignment. If there is no second physical terminal specification, then the first physical terminal specification is also the output assignment. v If you specify /ASSIGN LTERM [TO] NODE, the node specification is the input and output assignment. No response is sent to a terminal referenced in an /ASSIGN command. The logical terminal must not be an inquiry logical terminal and must not have queuing or dequeuing of messages in progress. LTERMs created dynamically can be assigned to dynamically created users. Static logical terminals can be assigned to other static terminals. Dynamic logical terminals cannot be assigned to lines, static nodes, dynamic nodes, or static users. Static logical terminals cannot be assigned to dynamic nodes or users. /ASSIGN commands that split the logical terminal so that the input LTERM is associated with one node and the output is associated with another node are not allowed for any ACF/VTAM terminals. Physical terminal considerations: The physical terminal named in the command or indirectly referred to by being associated with a logical terminal in the command must not be on a switched line, in conversational, response, or preset destination modes. If a user logical terminal is specified, no logical terminal in the subpool can be currently signed on, and the line and physical terminal for input and output must be the same. If message processing programs are dependent upon a particular LTERM-to-component assignment, this relationship must be maintained by the operator. MSGDEL processing for an LTERM is based on how the MSGDEL option was defined: v For static LTERMs defined during system definition as part of the VTAMPOOL for ISC support and for dynamic LTERMs, the MSGDEL options of the users must match when moving LTERMs between the users. v For all other static LTERMs, the MSGDEL option is defined in the TERMINAL macro for the associated physical terminal. v If a terminal's MSGDEL capabilities are defined in the TERMINAL macro as MSGDEL=NONIOPCB, assignment of an LTERM can take place only if the LTERM's message queues are empty, except when the LTERM is assigned to a terminal also defined as MSGDEL=NONIOPCB. v If a terminal's MSGDEL capabilities are defined as MSGDEL=SYSINFO or NOTERM, assignment of an LTERM can take place only if the LTERM's system message queue is empty, except when the LTERM is assigned to a terminal defined as MSGDEL=SYSINFO or NOTERM, or MSGDEL=NONIOPCB. Master terminal considerations: The primary and secondary master terminals cannot be assigned to a user, an input-only or output-only device, a terminal in response mode, an unattended type 1 secondary logical unit terminal, an ISC node, or NTO terminal, or dynamic node. The LINE/PTERM or NODE to Chapter 9. /ASSIGN command 105 which the master terminal is to be assigned must be started and in an operable state. The line and physical terminal for input and output must be the same. When a 3270 is designated as the master terminal during IMS system definition, two master logical terminals are generated. One, referred to as the primary master terminal, must be assigned to a 3270 display (3275/3276/3278/3279) for all input and output messages. The other, referred to as the secondary master terminal, must be assigned to a 3270 printer (3284/3286/3287/3288/3289) for certain IMS-selected output messages. To move a single master logical terminal from one physical terminal to another physical terminal (for example, the secondary master from one 3284 to another 3284, or the primary master from one 3277 to another 3277) without moving the other, use the formats of /ASSIGN LTERM command with one LINE/PTERM or NODE, and specify the LTERM name of the master terminal. You can use either of the following commands: v /ASSIGN LTERM ltermname (TO) NODE nodename v /ASSIGN LTERM ltermname (TO). LINE line# PTERM pterm# PRIMARY parameter: The reserved parameter PRIMARY can be used with the LTERM keyword to change both the primary and secondary master terminals assignments to other physical terminals concurrently. The command formats used with the PRIMARY parameter are: v /ASSIGN LTERM PRIMARY (TO) LINE line#1 PTERM pterm#1/NODE nodename#1 This command format assigns both the input and output of the primary master terminal to LINE line#1 PTERM pterm#1, and both the input and output of the secondary master terminal to NODE nodename. v /ASSIGN LTERM PRIMARY (TO) (LINE line#1 PTERM pterm#1/NODE nodename1)(LINE line#2 PTERM pterm#2/NODE nodename2) This command format assigns the input and output of the primary master terminal to the LINE line#1 PTERM pterm#1/NODE nodename #1 and assigns the input and output of the secondary terminal to LINE line#2 PTERM#2/NODE nodename#2. These two formats can reassign: v The 3270 primary and 3270 secondary master terminals to different 3270 physical terminals, where pterm#1 or nodename1 is a 3270 display and pterm#2 or nodename2 is a 3270 printer. v A non-3270 master terminal to a 3270 display and 3270 printer, where pterm#1 or nodename1 is a 3270 display and pterm#2 or nodename2 is a 3270 printer. The first LINE/PTERM or NODE specifies the display device to which the primary master logical terminal is to be assigned. The second LINE/PTERM or NODE specifies the printer device to which both the input and output capabilities of the secondary are to be assigned. If only one LINE/PTERM or NODE is specified, then the input and output capabilities of the primary master logical terminal and the secondary master logical terminal are assigned to the same LINE/PTERM or NODE. 106 Commands, Volume 1: IMS Commands A - M Data considerations: IMS does not edit data destined for a logical terminal when an /ASSIGN LTERM or /ASSIGN USER command is executed that affects physical terminal to logical terminal relationships. Ensure that data that is to be sent to a given physical terminal is suitable for transmission to a different physical terminal. If the Message Format Service (MFS) is used and the FMT definition included the second device, the change of physical terminal from one MFS-supported device to another MFS-supported device will produce correct output. The command format used with the /ASSIGN LTERM ltermname command is: v /ASSIGN LTERM ltermname [TO] LINE line#1 PTERM pterm#1 This command format assigns the input and output capabilities of the logical terminal to LINE line#1 PTERM pterm#1. This command is not valid if the LTERM is dynamic. /ASSIGN LTERM ltermname [TO] LINE line#1 PTERM pterm#1 LINE line#2 PTERM pterm#2 This command format assigns the input capability of the logical terminal to the first LINE/PTERM pair and assigns the output capability of the logical terminal to the second LINE/PTERM pair. This command is not valid if the LTERM is dynamic. v /ASSIGN LTERM ltermname [TO] LINE line#1 PTERM pterm#1 PTERM pterm#2 This command format assigns the input capability of the logical terminal to LINE line#1 PTERM pterm#1 and assigns the output capability of the logical terminal to the same LINE, line#1, but to a different PTERM, pterm#2. This command is not valid if the LTERM is dynamic. v /ASSIGN LTERM ltermname [TO] NODE nodenamez This command format assigns the input and output capabilities of the logical terminal to NODE nodename. This command is not valid if the LTERM or NODE is dynamic. v /ASSIGN LTERM ltermname1 [TO] LTERM ltermname2 This command format allows an input chain to be moved to a symbolic location, rather than to a specific line and physical terminal. The [TO] line and terminal are determined by the current assignment of the specified [TO] logical terminal. With this format, the output assignment is not affected. This form of the /ASSIGN command is invalid for ISC nodes defined for parallel sessions, and it is not supported for LTERMs associated with VTAM terminals. v /ASSIGN LTERM ltermname [TO] USER username This command format assigns the logical terminal to the given user. When moving logical terminals between users, the MSGDEL options of the users as defined during system definition or on user descriptor must match. The user related to LTERM ltermname must not be signed on in conversation, in response mode, or in preset mode. For 3600/FINANCE, SLU P, and ISC, the user (username) can remain allocated because of terminal message resynchronization requirements. However, the user cannot be signed on because the associated terminal session must be stopped and idle. The user can be allocated, but, if allocated, must be associated with a session that is stopped and idle. This command will turn off the DEADQ status for the user associated with LTERM ltermname. Chapter 9. /ASSIGN command 107 NODE Specifies the VTAM terminal to which the input and output capabilities of a logical terminal are to be assigned. The node must not be dynamic, or in conversational, response, or preset destination modes. If a session with a VTAM terminal is terminated after a message is sent but before the response has been received, message resynchronization is necessary for this terminal. The output message for which no response was received must remain associated with this terminal until message resynchronization determines when the terminal received the message. If you use the /ASSIGN command to move the message to a different terminal, message resynchronization is no longer possible. NOSAVE Indicates that the assignment changes specified by the /ASSIGN command are lost when control blocks are deleted by the system when they are no longer needed. Omitting SAVE and NOSAVE causes the system-wide default to be used, as specified by the ASSNCHANGE parameter in the DFSDCxxx PROCLIB member. NPRI Specifies a new value for the normal priority of a transaction. The NPRI keyword is not allowed for BMP transactions, because BMP transactions should always have a priority of 0. The new NPRI value takes effect the next time the transaction is scheduled. Valid NPRI parameters are numeric values from 0 to 14. OUTPUT Specifies that the output capability of a logical terminal is to be assigned to a given nonswitched physical terminal, without affecting the input assignment. OUTPUT is invalid for ISC nodes defined for parallel sessions. PARLIM Specifies a new value for the parallel processing limit count of a transaction. parlim# 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 region will be scheduled whenever the transaction queue count (for shared-queues environments, the successful consecutive GU count is used instead of the queue count) exceeds the PARLIM value multiplied by the number of regions currently scheduled for this transaction. Valid PARLIM parameters are numeric values from 0 to 32767 and 65535, where 65535 disables transaction load balancing. A PARLIM of 65535 is the only valid value allowed for a transaction that is shown as eligible for load balancing but has an application program defined as SCHDTYPE=SERIAL. For example, if you dynamically change a parallel transaction to a serial transaction through online change, the only valid value for PARLIM is 65535. /ASSIGN PARLIM is not valid for CPI Communications driven transactions. Note: In a shared-queues environment, the PARLIM value behaves differently than it does in a non-shared-queues environment. In a non-shared-queues environment, the queue depth (the number of messages that are currently enqueued) for the transaction is used as the value that is compared with the PARLIM value to determine when to schedule another region. IMS responds to a growing queue of input transactions by scheduling more regions as the queue grows. 108 Commands, Volume 1: IMS Commands A - M In a shared-queues environment, each individual IMS does not know the depth of the queue, because the queue is in the shared-queues coupling facility structure that is managed by Common Queue Server (CQS). The transaction queue might be added to by many different IMS systems. IMS is notified only when the first message is put in a queue (that is, when the queue becomes not empty). IMS is not notified for every subsequent message that is placed on the queue after that first message. In a shared-queues environment, the PARLIM comparison is done against a counter that each IMS keeps of the number of successful consecutive GU calls for the transaction by that IMS, rather than queue depth. IMS schedules more regions when it consistently gets messages from CQS when it asks for them. Thus, in a shared-queues environment, IMS infers the depth of the queue of messages based on processing activity, but it does not know the actual depth of the queue. A PARLIM value of 0 in a shared-queues environment is the most responsive setting. PARLIM(0) ensures that message regions are scheduled until all messages are processed from the transaction queue, or until the maximum region value (MAXRGN) limit is reached. PARLIM(0) might, however, result in many unnecessary schedules (or false schedules). A false schedule occurs when a message region is scheduled and finds no more messages on the queue. This is a consequence of IMS not knowing how many messages are queued on the transaction queue, and having to try to read the queue to see if there are more messages. Setting the PARLIM to a value greater than 0 can reduce the number of false schedules, because IMS then schedules a new message region only after a number of messages have been obtained consecutively without the queue becoming empty. Setting the PARLIM to a value of 2 or greater is useful for reducing false schedules for transactions that are low-volume and that run relatively quickly (such that the queue depth is typically 1), because it avoids scheduling a second region until the first region has obtained at least two messages in a row. However, be aware that while a PARLIM value greater than 0 can reduce unnecessary schedules, it is also less responsive. If a transaction is long running, or if its processing is delayed (for example, because of locking contention), the consecutive GU count does not change while the transaction is executing, and no additional message regions are scheduled. This can result in delayed processing of other messages for this same transaction until a currently-scheduled message completes. This delay can occur even if message regions are available to process the transaction. PLCT Specifies a new value for the processing limit count of a transaction. The PLCT is the number of messages of this transaction code that a program can process in a single scheduling. The new PLCT values take effect the next time the transaction is scheduled. Valid PLCT parameters are numeric values from 0 to 65535. /ASSIGN PLCT is not valid for CPI Communications driven transaction programs. PTERM Specifies the non-VTAM device to which the input or output capabilities (or both) of a logical terminal are to be assigned. Chapter 9. /ASSIGN command 109 REGION Specifies the message processing region being assigned new classes of transactions that the region can schedule. SAVE Prevents deletion of user and LTERM control blocks across session and IMS restarts. Control blocks will be retained until the NOSAVE keyword is used with the /ASSIGN command. Omitting SAVE and NOSAVE causes the system-wide default to be used, as specified by the ASSNCHANGE parameter in the DFSDCxxx PROCLIB member. SEGNO Creates or changes the limit on the number of application program output segments allowed in message queues for each GU call. Segment limits will be established by transaction code, thereby allowing specification of more than one value for each application program. The new SEGNO value takes effect during execution of the transaction. Valid SEGNO parameters are numeric values from 0 to 65535. The /ASSIGN SEGNO command is not valid for CPI Communications driven transaction programs. SEGSZ Creates or changes the limit on the size of application program output segments allowed in message queues for each GU call. The new SEGSZ value takes effect during execution of the transaction. Valid SEGSZ parameters are numeric values from 0 to 65535. The /ASSIGN SEGSZ command is not valid for CPI Communications driven transaction programs. TRAN Specifies the transaction being assigned to a message processing class or being assigned a value. The new class takes effect the next time the transaction is scheduled. USER Assigns logical terminals to ISC half-sessions or to dynamic users. When moving logical terminals between users, the MSGDEL options of the users must match. The MSGDEL option for the static ISC users is defined in the SUBPOOL macro during system definition. The MSGDEL option for dynamic terminals is defined in the OPTIONS keyword of the ETO USER descriptor. /ASSIGN USER to VTAMPOOL is not valid if USER is not ISC. /ASSIGN LTERM ltermname (TO) USER username assigns the logical terminal to another USER. The user associated with LTERM ltermname must not be allocated. The USER username can be allocated, but it must be associated with a session that is stopped and idle, if allocated. Note: Assigning an LTERM is not a permanent action. When the destination structure is deleted (for example, with /SIGN OFF) IMS discards information about the assignment. When the original dynamic user who owned that dynamic LTERM signs on again or gets a message switch, the dynamic LTERM is recreated for the original dynamic user. If SAVE is specified, the dynamic user is not deleted unless another /ASSIGN command with the NOSAVE keyword is issued. /ASSIGN USER username1 (TO) USER username2 assigns a string of logical terminals to another USER The first user (username1) in the command 110 Commands, Volume 1: IMS Commands A - M must contain at least one logical terminal and must not be signed on, in conversation, in response mode, or in preset mode. For 3600/FINANCE, SLU P, and ISC, the second user (username2) can remain allocated due to terminal message resynchronization requirements. However, the user cannot be signed on and associated terminal sessions must be stopped and idle. This command turns off the DEADQ status for USER username1. In addition to the ISC rules and restrictions, following dynamic terminal restrictions also apply. The /ASSIGN USER to USER and /ASSIGN LTERM to USER commands are rejected if the source or destination dynamic user is in conversation mode, response mode, or preset mode. The second USER can be allocated, but it must be associated with a session that is stopped and idle, if allocated. When existing dynamic LTERMs or dynamic users are assigned to a destination user that does not exist, the destination user is created unless it is rejected by the DFSINSX0 user exit. VTAMPOOL Is valid only for VTAM ISC sessions. It is used to force a cold start of an ISC session that cannot perform a successful restart. /ASSIGN VTAMPOOL deallocates an entire string of logical terminals allocated to a given USER. The user must not be signed on, in conversation mode, response mode, or preset mode, and the terminal must be stopped and idle. This command is valid for static and dynamic ISC users. Usage notes Most changes made by the /ASSIGN command remain in effect until changed with another /ASSIGN command, or an IMS cold start (/NRESTART CHECKPOINT 0) is performed. This command can be issued to an IMSplex using the Batch SPOC utility. When dynamic LTERMs are assigned to dynamic users with the /ASSIGN LTERM TO USER command, or dynamic users are assigned to dynamic users with the /ASSIGN USER TO USER command, changes remain in effect only if the following conditions are true: v The SAVE keyword is used. v SAVE and NOSAVE keywords are omitted, but ASSNCHANGE=SAVE is specified in the DFSDCxxx PROCLIB member. Otherwise, changes are lost when the destination user is deleted during user sign-off or IMS checkpoint. Changes that affect regions, such as CLASS, are only in effect until the region terminates. Recommendation: Use the /ASSIGN command consistently on all IMS subsystems that are members of a VTAM generic resources group or share IMS queues. For example, assign an LTERM to a specific node for all IMS subsystems; assigning one LTERM to different nodes on different IMS subsystems could cause unpredictable results. Chapter 9. /ASSIGN command 111 The /ASSIGN command is mirrored on an XRF alternate environment unless the assignment involves the primary or secondary master terminal, or the assignment of a CLASS to a REGION. /ASSIGN commands attempting to assign LTERMs or users between static and dynamic terminals receive a unique error message. An error message is issued if /ASSIGN attempts any of the following v To assign a dynamic LTERM to a static USER. v To assign a static USER to a dynamic USER. v To assign a dynamic USER to a static USER. v To assign a dynamic LTERM to a LINE or NODE. v To assign a static LTERM to a dynamic USER. Restriction: You cannot use the /ASSIGN command to assign a user structure to a node that does not exist. Use the /OPN NODE nodename USER username command instead. /ASSIGN in an IMSplex In an IMSplex, the /ASSIGN LTERM and /ASSIGN USER commands alter the relationships between one or more logical terminals and a physical terminal or user. Static terminals For static terminals in an IMSplex, the control blocks should exist in all the IMS systems where a user could possibly log on to that terminal. If /ASSIGN LTERM TO NODE is specified in an IMSplex, it should be issued from the Single Point Of Control (SPOC) application. If ROUTE is specified, it should be specified as ROUTE(*). Otherwise, the /ASSIGN command may not be processed consistently across the IMSplex and could cause unpredictable results. If one of the /ASSIGN commands fails, that IMS will send back a completion code to the Operations Manager (OM) indicating failure. It will be up to the IMS installation to correct that problem. /ASSIGN LTERM TO NODE assigns the input and output capabilities of a logical terminal to a static VTAM node. The logical terminal may not be in conversational, response, or preset destination mode. The source and destination terminals do not need to be stopped or logged off. If global resource information is not kept in the Resource Manager (RM) and the node exists locally, this command applies locally. If global resource information is kept in RM, this command applies globally, if the control blocks exist in RM. However, the assignment changes are not considered significant, and if the resource is deleted, the assignment changes are deleted as well. An LTERM that exists in the RM could be deleted if the static node to which it is assigned does not exist in the RM. If NODEA and LTERMA exist in the RM because the node is in exclusive mode, but static NODEB is not in RM, an /ASSIGN LTERM LTERMA NODE NODEB command would result in LTERMA being deleted in RM. The IMS where the LTERM and node are active, or the command master if the resources are not active, will make the changes in the RM. In this case, "active" includes the case where the terminal is logged off, but has an RM affinity to a particular IMS. For /ASSIGN LTERM TO NODE, the LTERM and node might not be active in different IMS systems. 112 Commands, Volume 1: IMS Commands A - M When the log on of a static node attempts to write its LTERM names to the RM, but one or more of the LTERM names are already in use, IMS will reject the log on. This error should occur only if there are inconsistent definitions, or there have been inconsistent /ASSIGN commands issued in the IMSplex. Dynamic terminals /ASSIGN LTERM TO USER assigns the input and output capabilities of an ETO logical terminal to an ETO user or a static ISC logical terminal to a static ISC subpool. The logical terminal may not be in conversational, response, or preset destination mode. The source user associated with the ETO LTERM might not be signed on. The destination ETO user does not have to be stopped. If global resource information is not kept in RM and the user exists locally, this command applies locally. If global resource information is kept in RM, this command applies globally (if the control blocks exist in RM). However, the assignment changes are not considered significant, and if the resource is deleted, the assignment changes are deleted as well. The IMS where the LTERM and node are active, or the command master if the resources are not active, will make the changes in the RM. Use /ASSIGN LTERM TO USER with the SAVE keyword in an RM environment, to cause the assignment to persist and to apply the change to future IMS systems that join the IMSplex. The SAVE keyword is valid only for dynamic terminals, so this persistence function is not available for static terminals. Use /ASSIGN LTERM TO USER with the NOSAVE keyword in an RM environment, to stop applying the change to future IMS systems that join the IMSplex. /ASSIGN USER TO USER assigns all the logical terminals associated with the source user to the destination user. The destination user, if dynamic, does not have to be stopped. If global resource information is not kept in RM and the user exists locally, this command applies locally. If global resource information is kept in RM, this command applies globally. Use /ASSIGN USER TO USER with the SAVE keyword in an RM environment to cause the assignment to persist and to apply the change to future IMS systems that join the IMSplex. The SAVE keyword is valid only for dynamic terminals, so this persistence function is not available for static terminals. Use /ASSIGN USER TO USER with the NOSAVE keyword in an RM environment to stop applying the change to future IMS systems that join the IMSplex. The /ASSIGN command is allowed when the destination user does not exist. However, when resource information is being kept in RM, unless the SAVE keyword is used, this command will not be allowed. Assignments are not considered significant without the SAVE keyword, and if the user does not already exist because of some other significant status, there is no reason to create the user. IMS will dynamically create the source LTERM or user (if it does not exist) to enable the /ASSIGN command. If the destination also does not exist, the SAVE keyword must be specified on the /ASSIGN command. Otherwise, the SAVE keyword is optional. Non-VTAM devices and VTAM IMS supports the assignment of an LTERM between non-VTAM devices and VTAM terminals. However, IMS will not save any non-VTAM status. For example, if an LTERM is assigned from VTAM to a non-VTAM device, the LTERM will be deleted from the RM, and any status that might have been associated with that LTERM will no longer be recoverable. Chapter 9. /ASSIGN command 113 Equivalent IMS type-2 commands The following table shows variations of the /ASSIGN command and the IMS type-2 commands that perform similar functions. Table 89. Type-2 equivalents for the /ASSIGN command Task /ASSIGN command Similar IMS type-2 command Changes the value for the limit count of a transaction. /ASSIGN LCT new_lmct_number TO TRAN tranname UPDATE TRAN NAME (tranname) SET(LCT(new_limit_count)) Changes the value for the limit priority of a transaction. /ASSIGN LPRI new_lpri_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(LPRI(new_limit_priority)) Changes the value for the normal priority of a transaction. /ASSIGN NPRI new_npri_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(NPRI(new_normal_priority)) Changes the value for the parallel processing limit count of a transaction. /ASSIGN PARLIM new_parlim_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(PARLIM(new_parallel_limit)) Changes the value for the processing limit count of a transaction. /ASSIGN PLCT new_plmct_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(PLCT(new_processing_limit)) Changes the limit on the number of application program output segments allowed in message queues for each GU call. /ASSIGN SEGNO new_segno_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(SEGNO(new_segment_number)) Creates or changes the limit on the size of application program output segments allowed in message queues for each GU call. /ASSIGN SEGSZ new_segsize_number TO TRAN tranname UPDATE TRAN NAME(tranname) SET(SEGSZ(new_segment_size)) Changes the class number of a transaction. /ASSIGN TRAN tranname TO CLS new_class_number UPDATE TRAN NAME(tranname) SET(CLASS(new_class_number)) Examples The following are examples of the /ASSIGN command: Example 1 for /ASSIGN command Entry ET: /ASSIGN CLASS 5 TO REGION 3 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Class 5 is assigned to region 3. Class 5 transactions are scheduled into region 3. This command resets any previous class assignments to this region. Example 2 for /ASSIGN command Entry ET: /ASSIGN CLASS 4 6 2A TO REGION 5 Response ET: DFS058I 114 ASSIGN COMMAND COMPLETED EXCEPT CLASS 2A Commands, Volume 1: IMS Commands A - M Explanation: The requested assignment is complete except for 2A, which is an invalid class number. Example 3 for /ASSIGN command Entry ET: /ASSIGN CPRI 8 TO TRAN PIT, SEED Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: A current priority of 8 is set for the transactions named PIT and SEED. Example 4 for /ASSIGN command Entry ET: /ASSIGN INPUT LTERM JONES TO LINE 4 PTERM 3 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal JONES is assigned to LINE 4 PTERM 3 for input identification and security. It associates the chain of logical terminals, of which LTERM JONES will be chained in first, with LINE 4 PTERM 3 for input. LTERM JONES must not be in the interior of an input chain (no other logical terminal can point to it). A physical terminal can point (for input only) to the first logical terminal of any chain. The output physical terminal for LTERM JONES is not changed. Example 5 for /ASSIGN command Entry ET: /ASSIGN LTERM APPLE TO LINE 5 PTERM 1 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal APPLE has both its input and output capabilities assigned to LINE 5 PTERM 1. The components present on LINE 5 PTERM 1 must be compatible with the physical terminal previously related to logical terminal APPLE. Example 6 for /ASSIGN command Entry ET: /ASSIGN LTERM APPLE TO NODE JONES Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal APPLE has both its input and output capabilities assigned to node JONES. The components present on node JONES must be compatible with the physical terminal previously related to logical terminal APPLE. Chapter 9. /ASSIGN command 115 Example 7 for /ASSIGN command Entry ET: /ASSIGN LTERM SMITH TO LINE 4 PTERM 6 PTERM 7 COMPONENT 2 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal SMITH is assigned to LINE 4 PTERM 6 for input and LINE 4 PTERM 7 for output. Output for LINE 4 PTERM 7 is directed to COMPONENT 2. Example 8 for /ASSIGN command Entry ET: /ASSIGN LTERM X TO LINE 5 PTERM 7 PTERM 6 COMPONENT 4 ICOMPONENT 3 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal X is assigned to LINE 5 PTERM 7 for input and to LINE 5 PTERM 6 for output. Input is only received from input component 3, while output is directed to component 4. Example 9 for /ASSIGN command Entry ET: /ASSIGN LTERM JONES TO LINE 4 PTERM 6 LINE 9 PTERM 1 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal JONES is assigned to LINE 4 PTERM 6 for input capability and LINE 9 PTERM 1 for output capability. The component assignment is unaffected. Example 10 for /ASSIGN command Entry ET: /ASSIGN LTERM SMITH NODE JONES Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal SMITH is assigned to node JONES for both input and output. Example 11 for /ASSIGN command Entry ET: /ASSIGN LTERM BROWN TO LTERM WHITE Response ET: 116 Commands, Volume 1: IMS Commands A - M DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal BROWN is removed from its present input chain (if one exists) of logical terminals and added to the end of the input chain (if one exists) of logical terminal WHITE. The output physical terminal for LTERM BROWN is not changed. Example 12 for /ASSIGN command Entry ET: /ASSIGN LTERM LAX USER ILL ICOMPONENT 1 COMPONENT 2 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: Logical terminal LAX is reassigned from its existing user to the user ILL. The user associated with LAX cannot be allocated to an active session. Example 13 for /ASSIGN command Entry ET: /ASSIGN LTERM PRIMARY TO LINE 4 PTERM 3 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: PTERM 3 on LINE 4 becomes the master terminal. PTERM 3 must be a 3270 display. Example 14 for /ASSIGN command Entry ET: /ASSIGN LTERM PRIMARY TO NODE BOSS Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: The node, BOSS, becomes the primary master terminal and the secondary master terminal. Example 15 for /ASSIGN command Entry ET: /ASSIGN LTERM PRIMARY TO LINE 1 PTERM 2 LINE 2 PTERM 4 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: PTERM 2 on LINE 1 becomes the primary master terminal and PTERM 4 on LINE 2 becomes the secondary master terminal. PTERM 2 is a 3270 display station and PTERM 4 is a 3270 printer. Example 16 for /ASSIGN command Entry ET: Chapter 9. /ASSIGN command 117 /ASSIGN SEGNO 50 TO TRAN APPLE Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: A limit of 50 output segments is set for the transaction APPLE. Example 17 for /ASSIGN command Entry ET: /ASSIGN SEGSZ 1000 TO TRAN APPLE Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: A maximum size of 1000 bytes is set for any one output segment of transaction APPLE. Example 18 for /ASSIGN command Entry ET: /ASSIGN USER ILL TO USER CAL Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: All the logical terminals of user ILL are appended to the existing LTERM string of user CAL. Use of this form of the /ASSIGN command leaves ILL with no LTERMs and therefore unavailable for allocation to a session. Both user ILL and CAL cannot be allocated to a session. Example 19 for /ASSIGN command Entry ET: /ASSIGN USER CAL TO VTAMPOOL Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: The entire allocated LTERM string defined for user CAL is reassigned to the VTAM pool. The node to which user CAL is allocated must not be in session and must be stopped and idle. User CAL is then available for allocation to any ISC session. Example 20 for /ASSIGN command Entry ET: /ASSIGN TRAN APPLE TO CLASS 5 Response ET: DFS058I ASSIGN COMMAND COMPLETED Explanation: The transaction named APPLE is assigned to class 5. Related concepts: 118 Commands, Volume 1: IMS Commands A - M CPI Communications driven application programs (Communications and Connections) Related reference: UPDATE TRAN command (Commands) Chapter 9. /ASSIGN command 119 120 Commands, Volume 1: IMS Commands A - M Chapter 10. /BROADCAST command The /BROADCAST command is a multisegment command used to send a message to terminals in one or more IMS systems. Subsections: v “Environment” v “Syntax” v “Keywords” on page 122 v “Usage notes” on page 123 v “Examples” on page 124 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 90. Valid environments for the /BROADCAST command and keywords Command / Keywords DB/DC DBCTL DCCTL /BROADCAST X X ACT X X LINE X X LTERM X X MASTER X X MSNAME X X NODE X X PTERM X X SYSID X X USER X X Syntax © Copyright IBM Corp. 1974, 2014 /BROADCAST /BRO TO 121 ACT LINE line# line# PTERM pterm# ALL ALL LTERM ltermname ltermname* ALL MASTER MSNAME SYSID NODE msname ALL sysid# ALL nodename nodename* ALL PTERM ALL USER username username* ALL Keywords The following keywords can be specified for the /BROADCAST command: ACT Specifies that the supplied message is queued to the first LTERM allocated to each active node. When operating on a dynamic terminal, the /BROADCAST ACT command only succeeds if a signed on user exists. A signed on user must exist, otherwise there is no destination to which to send the message. LINE Specifies that a message is to be sent to all terminals associated with the specified line. PTERM specifies that the message is to be sent to specific terminals on the associated line. LTERM Specifies that a message is queued to each named LTERM in the local system or any remote system. The remote logical terminal must be defined in the input system. 122 Commands, Volume 1: IMS Commands A - M Where a LTERM does not exist, IMS attempts to create the LTERM and associated user structure if ETO is active. LTERM parameters can be generic, where the generic parameter specifies logical terminals that already exist. When /BROADCAST LTERM ALL is specified, one copy of the message is queued for each logical terminal in the local system. In a multiple systems configuration, the message is not sent to remote systems when the ALL parameter is used. When more than one logical terminal is assigned to a physical terminal for output purposes, multiple copies of the message will result. When the LTERM keyword specifies a logical terminal assigned to the VTAM pool, broadcast messages are queued for the first logical terminal in a subpool. MASTER Specifies that a message is to be sent to the IMS master terminal and to any specified secondary master terminal. Keywords SYSID and MSNAME can be used to further qualify the reserved parameter MASTER. MSNAME Specifies the logical link path in a multiple systems configuration. NODE Specifies that the supplied message is queued to the first output LTERM allocated to a terminal. If a terminal has no signed on user, no message can be queued. NODE parameters can be generic, where the generic parameter specifies nodes that already exist. When operating on a dynamic terminal, the /BROADCAST NODE command only succeeds if a signed on user exists. A signed on user must exist, otherwise there is no destination to which to send the message. PTERM Specifies the physical terminal to which a message is to be sent. SYSID Specifies the system identification of a system in a multiple system configuration. USER Specifies that the supplied message is queued to the first LTERM associated with the dynamic user. The USER parameter can be generic. The /BROADCAST USER command applies only to existing dynamic users. In an IMSplex, /BROADCAST USER queues the supplied message to the first LTERM associated with a dynamic user, if the user is signed on locally. /BROADCAST USER cannot be used to queue a message to an LTERM associated with a user signed on to another IMS in the IMSplex, or not signed on at all. Usage notes For /BROADCAST commands entered by the master terminal operator, the multisegment input from this command is combined into 79-character segments for output transmission. The first input segment contains only the broadcast destination. The second and subsequent input segments must contain the data to be broadcast. Messages that are broadcast are sent even if the line, terminal, or both, are stopped at the time the broadcast is issued. This command can be issued to an IMSplex using the Batch SPOC utility. Chapter 10. /BROADCAST command 123 All /BROADCAST formats require an EOM indication to denote end-of-message; an EOS indication must be included for all segments that precede the last segment. Requirement: When the /BROADCAST command is issued from an MCS/E-MCS console, OM API, or an AOI application, a period must appear as a delimiter between the command and the message text. Unlike message switches, broadcast messages are sent to a terminal even when the terminal, associated line, or both, are not available (stopped, process stopped, or locked). However, broadcast messages are never sent to terminals if the MSGDEL parameter of the TERMINAL macro is specified MSGDEL=NONIOPCB. Broadcast messages are always queued for logical terminals. When the ACTIVE, LINE, NODE, PTERM, or USER keywords are used, IMS queues the message for the first logical terminal found that is associated for output purposes with the specified line or physical terminal. Examples The following are examples of the /BROADCAST command: Example 1 for /BROADCAST command Entry ET: /BROADCAST ACTIVE (EOS) SYSTEM WILL BE SHUTDOWN FOR PM (EOS) IN 5 MINUTES (EOM) Response ET: DFS058I BROADCAST COMMAND COMPLETED Response RT: SYSTEM WILL BE SHUTDOWN FOR PM IN 5 MINUTES Explanation: The entered message is transmitted to all active terminals. Example 2 for /BROADCAST command Entry ET: /BROADCAST TO LTERM APPLE, TREE (EOS) DON’T USE TRANSACTION GREENTRE UNTIL FURTHER (EOS) NOTICE. (EOM) Response ET: DFS058I BROADCAST COMMAND COMPLETED Response RT: DON’T USE TRANSACTION GREENTRE UNTIL FURTHER NOTICE. Explanation: The entered message is transmitted to the logical terminals named APPLE and TREE. Example 3 for /BROADCAST command Entry ET: 124 Commands, Volume 1: IMS Commands A - M /BROADCAST TO LINE ALL (EOS) SYSTEM WILL SHUTDOWN AT 5PM (EOM) Response ET: DFS058I BROADCAST COMMAND COMPLETED Response RT: SYSTEM WILL SHUTDOWN AT 5PM Explanation: The entered message is transmitted to all physical terminals. Example 4 for /BROADCAST command Entry ET: /BROADCAST TO LINE 13 PTERM ALL (EOS) EXPECT DEMO YOUR LINE AT 9PM (EOM) Response ET: DFS058I BROADCAST COMMAND COMPLETED Response RT: EXPECT DEMO YOUR LINE AT 9PM Explanation: The entered message is transmitted to all physical terminals on line 13. Example 5 for /BROADCAST command Entry ET: /BROADCAST MASTER SYSID 2 (EOS) SYSTEM WILL SHUTDOWN AT 5:00 PM (EOM) Response ET: DFS058I BROADCAST COMMAND COMPLETED Response RT: SYSTEM WILL SHUTDOWN AT 5:00 PM Explanation: The message is transmitted to the master terminal of the system specified by the SYSID 2. Example 6 for /BROADCAST command Entry ET: /BROADCAST MASTER MSNAME BOSTON, CHICAGO (EOS) SYSTEM WILL SHUTDOWN AT 5:00 PM (EOM) Response ET: DFS058I BROADCAST COMMAND COMPLETED Response RT: SYSTEM WILL SHUTDOWN AT 5:00 PM Explanation: The message is transmitted to the master terminals. of the remote systems specified by the MSNAMEs BOSTON and CHICAGO. Chapter 10. /BROADCAST command 125 Example 7 for /BROADCAST command Remote Terminal entry: /FORMAT DFSMO4 /BRO LTERM WTOR this is segment this is segment this is segment (eos) 1 (eos) 2 (eos) 3 (eom) Response ET: DFS058I BROADCAST COMMAND COMPLETED Response RT: THIS IS SEGMENT 1 THIS IS SEGMENT 2 THIS IS SEGMENT 3 Explanation: The remote terminal is first formatted by the /FORMAT command, where default format DFSMO4 supports the input of four segments. This is followed by /BROADCAST with four segments. Related reference: “Multisegment command input” on page 6 126 Commands, Volume 1: IMS Commands A - M Chapter 11. /CANCEL command The /CANCEL command cancels all segments of a multisegment input message. It must be entered prior to the end-of-message (EOM) indicator from the terminal that was entering the message. Subsections: v “Environment” v “Syntax” v “Usage notes” v “Example” Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) from which the command can be issued. Table 91. Valid environments for the /CANCEL command Command DB/DC /CANCEL X DBCTL DCCTL X Syntax /CANCEL /CAN Usage notes Because a /CANCEL command must comprise a segment, it cannot be used to cancel a single-segment message. On a non-3270 device, you can cancel a single-segment message by entering two asterisks (**), followed immediately by an end-of-segment (EOS) indicator. When Message Format Service (MFS) is used, you can define delete characters other than (**) to cancel other segments besides the first. /CANCEL command has no meaning on display terminals where it is not possible to have some segments of a message already received by IMS while receiving subsequent segments. Example Entry ET: /BROADCAST TO ACTIVE (EOS) SYSTEM WILL BE AVAILABLE (EOS) Entry ET: /CANCEL © Copyright IBM Corp. 1974, 2014 127 Response ET: DFS058I CANCEL COMMAND COMPLETED Explanation: All previously entered segments of the current message are discarded. 128 Commands, Volume 1: IMS Commands A - M Chapter 12. /CHANGE commands The /CHANGE commands are multisegment commands used to change or delete internal resources within IMS. All /CHANGE formats require an EOM indication to denote end-of-message; an EOS indication must be included for all segments that precede the last segment. These commands can be issued to an IMSplex using the Batch SPOC utility. Subsections: v “/CHANGE APPC command” v “/CHANGE CCTL command” on page 130 v “/CHANGE CPLOG command” on page 132 v “/CHANGE DESC command” on page 132 v “/CHANGE DIR MFS command” on page 134 v “/CHANGE FDR command” on page 135 v v v v v “/CHANGE “/CHANGE “/CHANGE “/CHANGE “/CHANGE LINK command” on page 136 NODE command” on page 140 SUBSYS command” on page 144 SURV command” on page 145 TRAN command” on page 148 v “/CHANGE UOR command” on page 149 v “/CHANGE USER command” on page 151 Related reference: “Multisegment command input” on page 6 /CHANGE APPC command Use the /CHANGE APPC command to specify a change to the timeout value for APPC/IMS. This value is set in the DFSDCxxx member of IMS.PROCLIB. IMS passes this value to APPC/z/OS for every implicit APPC/IMS conversation. Subsections: v v v v “Environment” “Syntax” on page 130 “Keywords” on page 130 “Usage notes” on page 130 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. © Copyright IBM Corp. 1974, 2014 129 Table 92. Valid environments for the /CHANGE APPC command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X APPC X OUTBND X X X TIMEOUT X X X X Syntax /CHANGE /CHA APPC TIMEOUT mmmm:ss OUTBND luname Keywords The following keywords are valid for the /CHANGE APPC command: OUTBND Specifies a different outbound LU. The specified LU must be one of the APPC LUs defined in the APPCPMxx member of the SYS1.PARMLIB library. The default outbound LU is BASE LU. Message DFS182 is issued if the specified luname is not defined as a SCHEDULER in APPC/MVS for this IMS (in the APPCPMxx SYS1.PARMLIB member or through the SETAPPC command). TIMEOUT Specifies the timeout value in minutes and seconds (mmmm:ss). mmmm can be a number between 0 and 1440. ss can be a number between 0 and 59. If the timeout value is 0, APPC/IMS timeout will be deactivated. Usage notes A DFS34091 or DFS3491I message is issued after the /CHANGE APPC TIMEOUT command is issued to inform the operator of the new timeout value. /CHANGE CCTL command Use the /CHANGE CCTL command to specify the coordinator control subsystem. The recovery elements are resolved by IMS. Subsections: v “Environment” v “Syntax” on page 131 v “Keywords” on page 131 v “Examples” on page 131 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 93. Valid environments for the /CHANGE CCTL command and keywords Command / Keywords /CHANGE 130 Commands, Volume 1: IMS Commands A - M DB/DC DBCTL DCCTL X X X Table 93. Valid environments for the /CHANGE CCTL command and keywords (continued) Command / Keywords DB/DC DBCTL ABORT X X CCTL X X COMMIT X X PRTKN X X DCCTL Syntax /CHANGE /CHA CCTL cctlname PRTKN prtkn ALL ABORT COMMIT Keywords The following keywords are valid for the /CHANGE CCTL command: cctlname Specifies CCTL subsystem ID. prtkn Specifies the pseudorecovery token, which designates the unit of recovery to be aborted or committed. Use the /DISPLAY CCTL command to determine the name of the pseudorecovery token. ABORT Backs out changes for a unit of recovery. After completion of backout, the recoverable indoubt structure (RIS) is removed. COMMIT Commits changes for a unit of recovery. After the process is complete, the RIS is removed. Examples This set of examples shows that an INDOUBT unit of recovery can be aborted if the INDOUBT status cannot be resolved. The /CHANGE ... PRTKN command backs out changes made to the database. Entry ET: /DISPLAY CCTL CICS1 IND Response ET: CCTL CICS1 PSEUDO-RTKN RECOVERY-TOKEN 000100C0 00010040 *90067/113446* REGID 9FFA956B7AE24E00 9FFA9568FF594301 PSBNAME BMP255 BMP255 STATUS ATTACHED INDOUBT INDOUBT Entry ET: /CHANGE CCTL CICS1 PRTKN 000100C0 ABORT (EOM) Response ET: Chapter 12. /CHANGE commands 131 DFS058I CHANGE COMMAND COMPLETED DBS0699I REYNC ABORT COMPLETE FOR PSB BMP255... Explanation: The INDOUBT unit of recovery whose pseudorecovery token (PRTKN) is 000100C0 has been aborted. /CHANGE CPLOG command Use the /CHANGE CPLOG command to change the value of the IMS execution parameter, CPLOG. The IMS CPLOG execution parameter specifies the number of system log records between system-generated checkpoints. Subsections: v “Environment” v “Syntax” v “Keywords” Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 94. Valid environments for the /CHANGE CPLOG command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X CPLOG X X X Syntax /CHANGE /CHA CPLOG cp_log Keywords The following keyword is valid for the /CHANGE CPLOG command: cp_log This value must be specified as one or more numeric characters followed by either K or M. Values can range from 1K (1 KB) to 16M (16 MB). /CHANGE DESC command Use the /CHANGE DESC command to specify the name of an LU 6.2 descriptor that will be updated with new values. An error message is issued if the specified descriptor is not found. Subsections: v “Environment” on page 133 v “Syntax” on page 133 v “Keywords” on page 133 132 Commands, Volume 1: IMS Commands A - M v “Usage notes” on page 134 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 95. Valid environments for the /CHANGE DESC command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X DESC X X LUNAME X X MODE X X OUTBND X X SIDE X X SYNCLEVEL X X TPNAME X X TYPE X X Syntax /CHANGE /CHA DESC descriptor LUNAME MODE luname modename NONE OUTBND locallu SIDE sidename SYNCLEVEL NONE CONFIRM TPNAME tpname TYPE BASIC MAPPED Keywords The following keywords are valid for the /CHANGE DESC command: LUNAME Specifies the LU name that is updated in the LU 6.2 descriptor. The luname value in the descriptor is set to blanks unless the LUNAME keyword is also specified. A network-qualified LU name is optional for the LUNAME keyword. MODE Specifies the VTAM mode table entry name that is updated in the LU 6.2 descriptor. The NONE parameter resets the mode field to its null state. The MODE value in the descriptor is set to blanks unless the MODE keyword is also specified. OUTBND Identifies a local LU to be used for outbound message processing. If you do Chapter 12. /CHANGE commands 133 not specify a local LU, no LU name is displayed in the OUTBNDLU column of the /DISPLAY DESC command, and IMS uses the default LU. SIDE Specifies the APPC/z/OS side information that is set in the LU 6.2 descriptor. The side information contains default values for APPC conversation attributes such as LUNAME, TPNAME, and MODE. SYNCLEVEL Specifies the APPC sync level that is updated in the LU 6.2 descriptor. One of the following must be specified: CONFIRM IMS sync point processing continues. NONE IMS sync processing continues despite a session failure. TPNAME Specifies the tpname that is updated in the LU 6.2 descriptor. Message DFS182 is issued if the TPNAME parameter specified is DFSSIDE. The TPNAME value in the descriptor is set to blanks unless the TPNAME keyword is also specified. TYPE Specifies the APPC conversation type that is updated in the LU 6.2 descriptor. The conversation types are: BASIC Specifies that the data is to be formatted by the transaction programs, using the pattern “LL,data,LL,data”. MAPPED Specifies that the data is to be formatted by APPC. Usage notes The /CHANGE DESC command changes the destination for future messages only. It does not the change the destination for existing messages. The existing output messages are delivered only to the luname and tpname that had been previously specified for that message. This restriction is required by security requirements so message delivery to the intended destination only occurs at the time the messages are created. /CHANGE DIR MFS command Use the /CHANGE DIR MFS command to specify that the entries in the MFS dynamic directory are to be deleted. This restores the dynamic directory to the original state that it was in just after IMS was initialized. Subsections: v “Environment” on page 135 v “Syntax” on page 135 v “Usage notes” on page 135 134 Commands, Volume 1: IMS Commands A - M Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 96. Valid environments for the /CHANGE DIR MFS command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X DIR X X Syntax /CHANGE /CHA DIR MFS Usage notes When IMS is initialized, IMS creates an MFS block primary directory based on the contents of all the $$IMSDIR members found. At the same time, IMS issues GETMAINs to acquire additional storage that is large enough to hold approximately 10% of the members in the active format library. While IMS is running, entries are only added to the dynamic directory, they are not deleted. Therefore, the dynamic directory continues to get larger until it runs out of space. When this happens, IMS can extend the amount of space in the dynamic directory to hold another 10%. IMS can extend the size of the dynamic directory a maximum of 9 times. If you want to delete the in-storage (or index) entries from the dynamic directory without restarting IMS or performing an online change for the format library, use the /CHANGE DIR MFS command. /CHANGE FDR command Use the /CHANGE FDR command to specify a change to the timeout value for IMS Fast Database Recovery surveillance. This value is set in the DFSFDRxx member of IMS.PROCLIB. IMS uses this value to determine how long to wait before initiating a Fast Database Recovery takeover. Subsections: v “Environment” v “Syntax” on page 136 v “Usage notes” on page 136 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 97. Valid environments for the /CHANGE FDR command and keywords Command / Keywords /CHANGE DB/DC DBCTL DCCTL X X X Chapter 12. /CHANGE commands 135 Table 97. Valid environments for the /CHANGE FDR command and keywords (continued) Command / Keywords DB/DC DBCTL FDR X X TIMEOUT X X DCCTL X Syntax /CHANGE /CHA FDR TIMEOUT #second Usage notes The timeout value (#seconds) must be at least 3 but no greater than 999. IMS rejects this command if the active IMS subsystem is not connected to a Fast Database Recovery region. /CHANGE LINK command Use the /CHANGE LINK command with FORCSESS, SYNCSESS, COLDSESS to override the system definition option defined for forcing resynchronization until the next /CHANGE LINK command or IMS cold start. The /CHANGE LINK command applies only to IMS systems that are linked by Multiple Systems Coupling (MSC) when TCP/IP or VTAM is used. Subsections: v “Environment” v “Syntax” on page 137 v “Keywords” on page 137 v Examples Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 98. Valid environments for the /CHANGE LINK keywords Command / Keywords 136 DB/DC DBCTL DCCTL /CHANGE LINK X X ASR X X COLDSESS X X FORCSESS X X MODE X X SYNCSESS X X Commands, Volume 1: IMS Commands A - M Syntax /CHANGE /CHA LINK link# ALL FORCSESS SYNCSESS A COLDSESS A: ASR MODE ON OFF modename NONE Keywords The following keywords are valid for the /CHANGE LINK command: FORCSESS Defines the link as capable of being warm started from an ERE state, even if the message sequence numbers on each side of the link are not synchronized. Attention: The use of FORCSESS can cause messages to be lost. Specify FORCSESS for a link only if the loss of messages during a restart can be tolerated. SYNCSESS Defines the link as incapable of being warm started from an ERE state, unless the message sequence numbers on each side of the link are synchronized. COLDSESS Resets a link that is in either ERE or NRE state to COLD state, the state of a link when IMS comes up with a cold start. The FORCSESS or the SYNCSESS keyword must be specified with the COLDSESS keyword. The specification of FORCSESS or SYNCSESS keyword with COLDSESS overrides the previous specification of FORCSESS or SYNCSESS for the link. Attention: Use of the COLDSESS keyword can cause messages to be lost. Use the COLDSESS keyword only if one of the systems associated with an MSC link goes down, and the only way to bring up the session is to cold start it. The COLDSESS keyword can be specified to terminate control blocks associated with the specified link or links and reset the link to COLD. COLDSESS should be used only after the /PSTOP command is issued and completes against the link or links and the links appear to be hung. If COLDSESS is specified, it should be used on both sides of the link or links. Gather documentation to determine why the link or links did not come down normally. ASR Changes the automatic keyword session restart designation of a VTAM link. The default parameter for ASR is ON. Chapter 12. /CHANGE commands 137 Automatic session restart is not necessarily activated for a link just because a status of ASR is displayed for that link. You must also have coded SONSCIP=YES on the APPL definition statement for VTAM when defining the network for the VTAM. ASR applies only to VTAM MSC links. Attempting to turn ASR ON for any other type of MSC link is invalid. If non-VTAM MSC links are specified on the /CHANGE LINK ASR command, the command response indicates that the command processing completed with exceptions. MODE Changes the default mode table name of a VTAM link. This default is usually established by system definition. Parameter NONE resets this field to its null state (as if no mode table name was specified at system definition). MODE applies only to VTAM MSC links. Changing the mode table name for any other type of MSC link is invalid. If non-VTAM MSC links are specified on the /CHANGE LINK MODE command, the command response indicates that the command processing completed with exceptions. Examples: FORCSESS, SYNCSESS, and COLDSESS The following series of command examples illustrate the use the /CHANGE LINK command with the FORCSESS, SYNCSESS, and COLDSESS keywords. In all of the examples in this series, LINK 22 is an MSC TCP/IP link. In the following example, LINK 22 is displayed. The link has not been used yet and is in a PSTOPPED IDLE COLD state. /DISPLAY LINK 22 DFS000I LINK PARTNER RECD ENQCT DEQCT QCT SENT DFS000I 22 TA 0 0 0 0 0 PSTOPPED IDLE COLD In the following example, /CHANGE LINK 22 FORCSESS is issued to define the link as capable of being restarted when the message sequence numbers are not synchronized. /CHANGE LINK 22 FORCSESS. DFS058I 16:58:59 CHANGE COMMAND COMPLETED In the following example, the /DISPLAY LINK command shows that the status of the link now includes FORCE, which indicates that the FORCSESS attribute is set on the link. /DISPLAY LINK 22 DFS000I LINK PARTNER RECD ENQCT DEQCT QCT SENT DFS000I 22 TA 0 0 0 0 0 PSTOPPED IDLE COLD FORCE In the following example, the /RSTART command starts the link and the /DISPLAY command shows that the status of the link is now IDLE ACTV PRI FORCE. /RSTART LINK 22 DFS058I 17:02:03 RSTART COMMAND COMPLETED DFS2168I 17:02:05 CONNECTION ESTABLISHED ON LINK 22 /DISPLAY LINK 22 138 Commands, Volume 1: IMS Commands A - M DFS000I LINK PARTNER RECD ENQCT DEQCT QCT SENT DFS000I 22 TA 0 0 0 0 0 IDLE ACTV PRI FORCE In the following example, the /PSTOP command is issued with the FORCE keyword, which stops the link. Because LINK 22 is a TCP/IP link, the link does not need to be shut down before issuing the /PSTOP command with the FORCE keyword. After the /PSTOP command is processed, the reason code and LOSTSESS value in message DFS3177E indicate why the link stopped. /PSTOP LINK 22 FORCE DFS058I 17:08:01 PSTOP COMMAND COMPLETED DFS3177E 17:08:01 MSC DETECTED AN ERROR, DFS000I SENDMSG , RETCODE = 00000000, RSNCODE = 00000070, LOSTSESS = FORCESTO DFS000I MODULE = DFSTC7C0, LINK = 022, LNK12T01 DFS2169I 17:08:01 DISCONNECTION COMPLETED ON LINK 0022 After the disconnection of LINK 22 is complete, a /DISPLAY LINK command shows the status of LINK 22 as PSTOPPED IDLE ERE FORCE IMS1. In the link status, v ERE indicates that the link is in a warm state and that when the link is restarted, emergency restart synchronization will be performed. v FORCE indicates that the link will start even if the message sequence numbers are not synchronized. v IMS1 identifies the IMS system in which the link was stopped. /DISPLAY LINK 22 DFS000I LINK PARTNER RECD ENQCT DEQCT QCT SENT DFS000I 22 TA 0 0 0 0 0 PSTOPPED IDLE ERE FORCE IMS1 In the following example, the /CHANGE LINK command is issued with the SYNCSESS COLDSESS keywords. The COLDSESS keyword resets the link status from ERE to COLD. The SYNCSESS keyword changes FORCSESS attribute of the link to the SYNCSESS attribute, which redefines the link as requiring the message sequence numbers on each side of the link to be synchronized before the link can start. /CHANGE LINK 22 SYNCSESS COLDSESS. DFS058I 17:08:45 CHANGE COMMAND COMPLETED In the following final example of this series, the /DISPLAY LINK command shows that the link status no longer includes FORCE, which indicates that the FORCSESS attribute is no longer set and that the message sequence numbers must be synchronized before the link will start from a warm state. /DISPLAY LINK 22 DFS000I LINK PARTNER RECD ENQCT DEQCT QCT SENT DFS000I 22 TA 0 0 0 0 0 PSTOPPED IDLE COLD Examples: ASR This set of commands illustrates how the ASR setting of a link can be modified by the /CHANGE command: Entry ET: Chapter 12. /CHANGE commands 139 /DISPLAY LINK 6 Response ET: LINK PARTNER RECD ENQCT 6 AL 0 0 *90179/102004* IMSA DEQCT 0 QCT 0 SENT 0 ASR PSTOPPED IDLE COLD Explanation: Automatic Session Restart was defined for link 6 by system definition. Entry ET: /CHANGE LINK 6 ASR OFF (EOM) Response ET: DFS058I CHANGE COMMAND COMPLETED Entry ET: /DISPLAY LINK 6 Response ET: LINK PARTNER RECD 6 AL 0 *90179/102126* ENQCT 0 DEQCT 0 QCT 0 SENT 0 PSTOPPED IDLE COLD Explanation: Automatic Session Restart is not available for link 6 Entry ET: /CHANGE LINK 6 ASR (EOM) Response ET: DFS058I CHANGE COMMAND COMPLETED Explanation: The ASR parameter will default to ON. Entry ET: /DISPLAY LINK 6 Response ET: LINK PARTNER RECD 6 AL 0 *90179/102300* ENQCT 0 DEQCT 0 QCT 0 SENT 0 ASR PSTOPPED IDLE COLD Explanation: Automatic Session Restart is in effect again as a result of the second /CHANGE command. /CHANGE NODE command Use the /CHANGE NODE command to specify a VTAM node to be changed. The NODE parameter can be generic if the USER keyword is not present. The generic parameter specifies nodes that already exist. Subsections: v “Environment” on page 141 v “Syntax” on page 141 v “Keywords” on page 141 140 Commands, Volume 1: IMS Commands A - M v “Examples” on page 143 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 99. Valid environments for the /CHANGE NODE command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X ASR X X COLDSESS X X FORCSESS X X MODE X X NODE X X SYNCSESS X X USER X X Syntax /CHANGE /CHA NODE nodename A B USER nodename nodename* username ALL A COLDSESS ALL A: ASR MODE ON OFF modename NONE B: FORCSESS SYNCSESS COLDSESS Keywords The following keywords are valid for the /CHANGE NODE command: ASR The ASR keyword allows you to change the automatic session restart designation of a node. The default parameter for ASR is ON. Chapter 12. /CHANGE commands 141 Automatic session restart is not necessarily activated for a node just because a status of ASR is displayed for that node. You must also have coded SONCSIP=YES on the APPL definition statement for VTAM when defining your network. COLDSESS When COLDSESS is used with the NODE keyword, it sets up the SLU P or FINANCE session so that the session can be cold started. The COLDSESS keyword should be used if the SLU P or FINANCE session has experienced problems and attempts to warm start the session fail. The COLDSESS keyword terminates terminal and user control blocks associated with the specified node or nodes, and resets the node status to COLD. In an IMSplex, if global resource information is not kept in Resource Manager (RM), the change is applied locally. If global resource information is kept in RM, the change is applied globally. A DFS0581 COMMAND COMPLETE EXCEPT message may be received if the node is temporarily in use by another task even if the criteria (node is terminated and idle) for successful completion of the command is met. FORCSESS, SYNCSESS The FORCSESS and SYNCSESS keywords are valid only for ISC nodes. Specify FORCESS and SYNCSESS to override the system definition or logon descriptor option defined to force or not force synchronization of sessions. This override is effective until the next /CHANGE command is issued or an IMS cold start is effected. MODE Changes the default mode table name of a node. This default is usually established by system definition or logon descriptor. MODE resets this field to its null state (as if no mode table name had been specified at system definition). Changing ASR or the mode table name for VTAM 3270 nodes is invalid. If nodes of this type are referred to specifically in the /CHANGE ASR or /CHANGE MODE commands, they are marked in error. USER Indicates the ISC user that is allocated to the node or the dynamic user that is signed on to the node. /CHANGE USER AUTOLOGON SAVE changes the autologon information previously specified by a user descriptor, Destination Creation exit routine (DFSINSX0), or signon exit routine (DFSSGNX0). The autologon change is saved. The autologon information includes the node name, the mode table, the logon descriptor, and the ID. If the Resource Manager is active, the user will be dynamically created if it does not already exist. The SAVE keyword must be specified. If SAVE is not specified, the command is rejected with message DFS1199. Restrictions for using NODE and USER parameters together: v Commands with the NODE USER keyword pair are valid only if: – The USER is signed on to the NODE – In an ISC environment, the USER is allocated to the NODE – The nodes and users already exist v /CHANGE NODE USER commands with ASR or MODETABLE keyword are valid for ISC and non-ISC nodes and users. 142 Commands, Volume 1: IMS Commands A - M v /CHANGE NODE USER commands with FORCSESS or SYNCSESS keyword are valid for ISC nodes only. Examples The following are examples of the /CHANGE NODE command: Example 1 Entry ET: /DISPLAY NODE LUTYPEP1 MODE Response ET: NODE-USR TYPE LUTYPEP1 SLUP *90179/100630* DEF MODETBL DEFRESP ACT MODETBL Explanation: DEFRESP is the mode table name defined for node LUTYPEP1 at system definition or logon descriptor or resource creation. The session is not active so the active mode table field (ACT MODETBL) is blank. Entry ET: /CHANGE NODE LUTYPEP1 MODE XXXXXXXX (EOM) Response ET: DFS058I CHANGE COMMAND COMPLETED Entry ET: /DISPLAY NODE LUTYPEP1 MODE Response ET: NODE-USR TYPE LUTYPEP1 SLUP *84179/100733* DEF MODETBL XXXXXXXX ACT MODETBL Explanation: The default mode table name has been changed to XXXXXXXX by the previous /CHANGE command. The session is still not active so the active mode table field (ACT MODETBL) is blank. Example 2 Entry ET: /DISPLAY NODE LUTYPEP Response ET: NODE-USR TYPE CID LUTYPEP SLUP 00000000 *98276/153630* RECD 37 ENQCT 37 DEQCT 37 QCT 0 SENT 37 IDLE Explanation: Node LUTYPEP is terminated warm after session received and processed 37 messages. Entry ET: /CHANGE NODE LUTYPEP COLDSESS (EOM) Chapter 12. /CHANGE commands 143 Response ET: DFS058I CHANGE COMMAND COMPLETED Entry ET: /DISPLAY NODE LUTYPEP Response ET: NODE-USR TYPE CID LUTYPEP SLUP 00000000 *98279/153630* RECD 0 ENQCT DEQCT QCT SENT 0 0 0 0 IDLE COLD Explanation: Terminal and user blocks associated with node LUTYPEP have been cleared and the status has been reset to COLD. /CHANGE SUBSYS command Use the /CHANGE SUBSYS command to specify the subsystem name from which IMS recovery elements are to be deleted. Subsections: v “Environment” v “Syntax” v “Keywords” v “Examples” on page 145 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 100. Valid environments for the /CHANGE SUBSYS command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X OASN X X X RESET X X X SUBSYS X X X Syntax /CHANGE /CHA SUBSYS subsysname OASN oasnname RESET subsysname ALL Keywords The following keywords are valid for the /CHANGE SUBSYS command: 144 Commands, Volume 1: IMS Commands A - M OASN Specifies the outstanding recovery element to be deleted. RESET Causes an incomplete unit of work assigned to an external subsystem (not a CCTL subsystem) to be deleted. Examples The following are examples of the /CHANGE SUBSYS command: Example 1 Entry ET: /CHANGE SUBSYS DSN RESET (EOM) Response ET: DFS058I CHANGE COMMAND COMPLETED Explanation: Reset all IN-DOUBT recovery units for subsystem DSN. Example 2 Entry ET: /CHANGE SUBSYS ALL RESET (EOM) Response ET: DFS058I CHANGE COMMAND COMPLETED Explanation: Reset all IN-DOUBT recovery units for all subsystems. Example 3 Entry ET: /CHANGE SUBSYS ABCD OASN 99 685 2920 RESET (EOM) Response ET: DFS058I CHANGE COMMAND COMPLETED Explanation: Reset IN-DOUBT recovery units identified by OASN numbers 99, 685, 2920 for subsystem ABCD. /CHANGE SURV command Use the /CHANGE SURV command to specify that the interval or timeout value on the active or alternate system in an XRF environment is changed. Subsections: v v v v v “Environment” on page 146 “Syntax” on page 146 “Keywords” on page 146 “Usage notes” on page 146 “Examples” on page 147 Chapter 12. /CHANGE commands 145 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 101. Valid environments for the /CHANGE SURV command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X INTERVAL X X SURV X X TIMEOUT X X X Syntax /CHANGE /CHA SURV ALL LNK LOG RDS INTERVAL TIMEOUT #seconds Keywords The following keywords are valid for the /CHANGE SURV command: ALL Same as specifying LNK, LOG, and RDS. INTERVAL Specifies the new interval on the active or alternate system in an XRF environment. The INTERVAL keyword identifies the new value in seconds and must be in the range 1 through 99. LNK IMS ISC link. LOG IMS system log. RDS IMS restart data set. TIMEOUT Specifies the new timeout value on the active or alternate system in an XRF environment. The TIMEOUT keyword identifies the new value in seconds and must be in the range 1 through 99. Usage notes When /CHANGE SURV is entered on the active system, it becomes effective on both the active and alternate systems if the alternate system is up. If entered on the alternate system, only the alternate system is changed. Recommendation: Change surveillance on the active system and allow the alternate system to take affect. 146 Commands, Volume 1: IMS Commands A - M Additional considerations when changing the TIMEOUT values are shown in the following table. Listed in the table are the TIMEOUT value requirements for certain systems where the command is entered on and the action taken for exceptions. Table 102. Changing the TIMEOUT value System the command is entered on Requirement Action taken for exceptions Active New timeout value must be DFS3832 issued. Active timeout value greater than or equal to twice forced to twice the active interval the active interval value. value. Alternate Alternate interval value must DFS3812 issued. Alternate interval be greater than or equal to value forced to active interval value. the active interval value. Alternate New timeout value must be DFS3832 issued. Alternate timeout greater than or equal to twice value forced to twice the alternate the alternate interval value. interval value. Additional considerations when changing the INTERVAL values are shown in the following table. Listed in the table are the INTERVAL value requirements for certain systems where the command is entered and the action taken for exceptions. Table 103. Changing the INTERVAL value System the command is entered on Requirement Action taken for exceptions Active Twice the new interval value must be less than or equal to the active timeout value. DFS3832 issued. Active timeout value forced to twice the new interval value. Alternate Alternate interval value must DFS3812 issued. Alternate interval be greater than or equal to value forced to active interval value. the active interval value. Alternate New alternate interval value DFS3833 issued. Alternate interval must be greater than or equal value forced to alternate log interval to the alternate LOG interval value. value (LNK and RDS). Alternate New alternate interval value must be less than or equal to the alternate RDS and LNK interval value (LOG only). DFS3833 issued. Alternate interval value forced to alternate RDS then LNK interval value. Alternate Twice the new interval value must be less than or equal to the alternate timeout value. DFS3832 issued. Alternate timeout value forced to twice the new interval value. Examples This set of commands illustrates how surveillance can be modified by the /CHANGE command. Entry ET (Alternate system): /DISPLAY HSB Chapter 12. /CHANGE commands 147 Response ET (Alternate system): RSENAME DFSRSENM STATUS PHASE IMS-ID BACKUP TRK IMSB BACKUP SYSTEM SURVEILLANCE INTERVAL TIMEOUT STATUS LOG 2 99 INACTIVE LNK 4 99 INACTIVE RDS 3 99 INACTIVE TAKEOVER CONDITIONS - ALARM AUTO RDS LINK LOG *RDS LINK VTAM *IRLM *91226/103517* VTAM UVAR ACT-ID LOG-TIME USERVAR IMSA 10:35:17 ACTIVE SYSTEM INTERVAL TIMEOUT STATUS 2 99 INACTIVE 4 99 INACTIVE 3 99 INACTIVE Entry ET (Alternate system): /CHANGE SURV LNK INTERVAL 3 (EOM) Response ET (Alternate system): DFS058I CHANGE COMMAND COMPLETED DFS3812I BACKUP LNK INTERVAL VALUE OF 3 HAS BEEN FORCED TO ACTIVE VALUE OF 4 DFS3811I LNK SURVEILLANCE INACTIVE: INTERVAL VALUE CHANGED FROM 4 TO 4 Explanation: An attempt to change the interval value was made by entering /CHANGE on the alternate system. The new alternate interval value was not greater than or equal to the active interval value, so IMS forced the interval to the active value and issued asynchronous message DFS3812. Asynchronous message DFS3811 indicates the status of the change that follows the above action by IMS. /CHANGE TRAN command Use the /CHANGE TRAN command with the MAXRGN keyword to change the maximum number of regions that can be simultaneously scheduled for a given transaction. Subsections: v “Environment” v “Syntax” v “Keywords” on page 149 v “Examples” on page 149 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 104. Valid environments for the /CHANGE TRAN command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X MAXRGN X X TRAN X X Syntax 148 /CHANGE /CHA TRAN tranname Commands, Volume 1: IMS Commands A - M MAXRGN #regions Keywords The following keywords are valid for the /CHANGE TRAN command: MAXRGN Specifies the maximum number of regions that can be simultaneously scheduled for a given transaction. The transaction must be eligible for parallel scheduling (load balancing). For static transactions, the MAXRGN parameter (#regions) is initially set by system definition using the TRANSACT macro statement. For CPI Communications driven transactions, the initial value is obtained from the TP profile. The value of #regions must be between 0 and the number specified on the MAXPST= region parameter. Examples The following commands illustrate how to change the maximum number of regions that can be simultaneously scheduled for a given transaction. Entry ET: /DISPLAY TRAN SKS7 Response ET: TRAN CLS ENQCT QCT LCT PLCT CP NP LP SEGSZ SEGNO PARLM RC SKS7 7 0 0 65535 65535 8 8 8 0 0 1 0 PSBNAME: DFSDDLT7 STATUS: BAL( 2) *90226/134816* Explanation: The status of transaction SKS7 indicates it is eligible for load balancing (BAL) and that two regions can be simultaneously scheduled. Entry ET: /CHANGE TRANSACTION SKS7 MAXRGN 4 (EOM) Response ET: DFS058I CHANGE COMMAND COMPLETED Entry ET: /DISPLAY TRAN SKS7 Response ET: TRAN CLS ENQCT QCT LCT PLCT CP NP LP SEGSZ SEGNO PARLM RC SKS7 7 0 0 65535 65535 8 8 8 0 0 1 0 PSBNAME: DFSDDLT7 STATUS: BAL( 4) *90226/134845* Explanation: The maximum number of regions that can be simultaneously scheduled for transaction SKS7 has been changed from 2 to 4. /CHANGE UOR command Use the /CHANGE UOR command to specify that IMS should resolve units of recovery (UORs) for protected resources on the z/OS Resource Recovery Services (RRS) platform. Chapter 12. /CHANGE commands 149 Recommendation: Use the /CHANGE UOR command only when you are certain that no other resource managers would be adversely affected after IMS resolves the UOR. Subsections: v “Environment” v “Syntax” v “Keywords” v “Examples” Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 105. Valid environments for the /CHANGE UOR command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X ABORT X X COMMIT X X UOR X X Syntax /CHANGE /CHA UOR prtkn ALL ABORT COMMIT Keywords The following keywords are valid for the /CHANGE UOR command: prtkn Specifies the pseudorecovery token that designates the UOW to be committed. Use the /DISPLAY UOR command to obtain the pseudorecovery token (prtkn). If you specify ALL, the /CHANGE UOR command affects all units of recovery. ABORT Specifies that IMS back out changes for the protected resources. COMMIT Specifies that IMS make changes permanent for the protected resources. Examples The following commands illustrate the changing of a unit of recovery. Entry ET: /CHANGE UOR 010040 ABORT Response ET: 150 Commands, Volume 1: IMS Commands A - M DFS058I CHANGE COMMAND COMPLETED DFS0699I RESYNC ABORT COMPLETE FOR PSB STLDDTL1, PRTKN=00010040, TOKEN IMS2 0000000100000000 IMS2 *97226/134816* Explanation: IMS backs out changes for pseudorecovery token 010040. Entry ET: /CHANGE UOR 010040 COMMIT Response ET: DFS058I CHANGE COMMAND COMPLETED DFS0699I RESYNC COMMIT COMPLETE FOR PSB STLDDTL1, PRTKN=00010040, TOKEN IMS2 0000000100000000 IMS2 *97226/134816* Explanation: IMS makes changes for pseudorecovery token 010040 permanent. /CHANGE USER command Use the /CHANGE USER command to specify that an ETO user will change. The user parameter cannot be generic. Subsections: v “Environment” v “Syntax” v “Keywords” on page 152 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 106. Valid environments for the /CHANGE USER command and keywords Command / Keywords DB/DC DBCTL DCCTL /CHANGE X X X AUTOLOGON X X ID X X LOGOND X X MODE X X NOSAVE X X SAVE X X USER X X Syntax /CHANGE /CHA USER username AUTOLOGON C SAVE NOSAVE Chapter 12. /CHANGE commands 151 C: nodename MODE modename LOGOND ldname ID idname Keywords The following keywords are valid for the /CHANGE USER command: AUTOLOGON Specifies that the autologon information previously specified by a user descriptor, the Destination Creation exit routine (DFSINSX0), or the signon exit routine (DFSSGNX0) is being updated dynamically. nodename Specifies the autologon terminal session for the specified user. Omitting the nodename clears all autologon information. MODE Specifies the VTAM mode table entry name. LOGOND Specifies the logon descriptor used to build the terminal control blocks. ID Specifies the ISC partner's half-session qualifier (if the terminal is ISC). NOSAVE Indicates that the changed autologon information should not be retained. Deletion of the user occurs when an IMS checkpoint is taken, at session termination, IMS restart, or XRF takeover. If SAVE and NOSAVE are omitted, IMS uses the system-wide default as specified in the DFSDCxxx PROCLIB member. SAVE Indicates that the changed autologon information should be retained. This keyword prevents deletion of the user and remains in effect across a restart or XRF takeover until another /CHANGE command with the NOSAVE option is issued. If SAVE and NOSAVE are omitted, IMS uses the system-wide default as specified in the DFSDCxxx PROCLIB member. If global resource information is kept in Resource Manager, the change is applied globally when the SAVE keyword is specified. If SAVE is not specified in this environment, the command is rejected. 152 Commands, Volume 1: IMS Commands A - M Chapter 13. /CHECKPOINT command The /CHECKPOINT command records control and status information about the system log. Subsections: v “Environment” v “Syntax” v “Keywords” on page 154 v “Usage notes” on page 156 v “Examples” on page 157 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 107. Valid environments for the /CHECKPOINT command and keywords Command / Keyword DB/DC DBCTL DCCTL /CHECKPOINT X X X ABDUMP X X X DUMPQ X FREEZE X LEAVEGR X LEAVEPLEX X NOCQSSHUT X PURGE X QUIESCE X X SNAPQ X X STATISTICS X X X X X X X X X X X X Syntax Shutdown checkpoint /CHECKPOINT /CHE DUMPQ FREEZE PURGE LEAVEPLEX ABDUMP QUIESCE LEAVEGR NOCQSSHUT Attention: This command shuts down your IMS system. Be sure that you understand the consequences of shutting down the system before you issue this command. © Copyright IBM Corp. 1974, 2014 153 Simple checkpoint /CHECKPOINT /CHE SNAPQ Statistics checkpoint /CHECKPOINT /CHE STATISTICS Keywords The following keywords are valid for the /CHECKPOINT command: (blank) Requests a simple checkpoint. Simple checkpoints are also invoked by IMS based on the number of entries to the system log. The number of log entries between simple checkpoints is specified during system definition. In an ETO environment, any dynamic nodes, LTERMs or users with no messages queued or status are deleted. ABDUMP Requests an abnormal termination dump of the IMS control region in addition to the shutdown option selected. In a DBCTL environment, when /CHECKPOINT FREEZE ABDUMP is entered, all of the DBCTL address spaces are dumped. FREEZE | DUMPQ | PURGE Requests a shutdown of IMS. These variations of shutdown are provided for control over the method of stopping programs and lines, and to control the method of disposing of queues. The effects of these variations are shown in Table 108 on page 155. The request for a checkpoint shutdown might not be responded to immediately if any dependent regions are active. IMS will wait until these regions complete their current processing before continuing with the checkpoint shutdown. Message resynchronization for a specified transaction pipe does not affect IMS shutdown. Restriction: A shutdown checkpoint is not allowed in a shared-queues environment if the CQS is not available. Connections to external subsystems (not CCTL subsystems) will be quiesced. Connection attempts originating from dependent regions will be prohibited. After all dependent region connections have terminated, the control region will terminate its connection. The FREEZE keyword shuts down IMS pending actions shown in Table 108 on page 155. For DBCTL, active CCTL threads are allowed to complete before this keyword takes effect. This is also true when ABDUMP is used with this keyword. In the DBCTL environment, a /CHECKPOINT command with the PURGE keyword will be processed as though the FREEZE keyword was used instead of PURGE. /CHECKPOINT FREEZE in the DBCTL environment is correct because there are no message queues to empty. The DUMPQ and SNAPQ keywords designate starting points from which the message queue data sets can be rebuilt. However, the SNAPQ option dumps the message queues online while IMS is running without causing a shutdown of IMS. 154 Commands, Volume 1: IMS Commands A - M The PURGE keyword attempts to empty all the queues so that no outstanding work remains. For DBCTL, IMS performs FREEZE processing because there are no message queues. In a DBCTL environment, when /CHECKPOINT FREEZE ABDUMP is entered, all of the DBCTL address spaces are dumped. In a shared-queues environment, the DUMPQ and PURGE keywords cause IMS to shut down (as if you entered a /CHECKPOINT FREEZE command), but the message queues are not dumped or purged because the local IMS subsystem has no local queues. To dump the shared message queues when CQS terminates, use the /CQSET command before issuing the IMS shutdown checkpoint command. The following table displays when to issue one of the three IMS shutdown options (FREEZE, DUMPQ, and PURGE) and the effect on the IMS resource. Table 108. IMS shutdown options and their effect on IMS resources Resource status FREEZE keyword DUMPQ keyword PURGE keyword Message processing regions stopped At program completion At program completion When transaction queues are empty Batch message processing regions stopped At checkpoint, SYNC call, or program completion At checkpoint, SYNC call, or program completion At program completion Line input stopped At message completion At message completion At message completion Line output stopped At message completion At message completion When all messages complete Transaction and message queues Retained in queue data sets Dumped to system log Emptied normally Message-driven regions stopped At message completion At program completion When transaction queues are empty Fast Path output messages queued Dumped to system log Dumped to system log Emptied normally Fast Path input messages queued Discarded Emptied normally Emptied normally Fast Path DEDB online utility region At program completion At program completion At program completion Fast Path DEDBs Closed Closed Closed MSDBs Dumped to MSDB checkpoint data set Dumped to MSDB checkpoint data set Dumped to MSDB checkpoint data set CCTL Regions See DRA thread statistics (System Programming APIs) for a discussion of DRA threads. LEAVEGR Deletes all affinities from the VTAM affinity table for the IMS subsystem on which this command is issued. Using this keyword removes the IMS subsystem from the generic resource group. Recommendation: Cold start the DC component of an IMS subsystem that has been shut down with the LEAVEGR keyword to ensure that all affinities in IMS control blocks are also deleted. The IMS subsystem rejoins the generic resource group during startup. Chapter 13. /CHECKPOINT command 155 If the VTAM ACB is closed (usually because of a /STOP DC command), a shutdown checkpoint command with the LEAVEGR keyword is rejected. LEAVEPLEX In an IMSplex, this keyword is specified if the IMS that is being shut down is not going to rejoin the IMSplex. Specify the LEAVEPLEX keyword when you do not intend to bring the IMS back up in the IMSplex. If LEAVEPLEX is specified, and the IMS is a member of an IMSplex with global online change enabled, an attempt is made to remove the IMS ID from the OLCSTAT data set. If there is any error in removing the IMS ID from the OLCSTAT, message, DFS3443, DFS3444, or DFS3448 is written out to the system console and the IMS is shut down. In this case, the IMS ID might still be in the OLCSTAT data set and will have to be deleted by using the DFSUOLC utility. NOCQSSHUT Is used with the /CHE DUMPQ, /CHE FREEZE, or /CHE PURGE commands to not shut down the CQS address space when the IMS control region terminates. The CQS address space remains active and connected to the message queue structures. NOCQSSHUT is only applicable when IMS is running in a shared-queues environment. The default is to shut down the CQS address space when the IMS control region terminates. QUIESCE Halts processing of all VTAM terminals. When QUIESCE is specified, IMS sends the VTAM shutdown indicator to all VTAM terminals and waits until these nodes have completed processing before performing the normal checkpoint shutdown. During the processing of a quiesce shutdown, the master terminal operator might want to terminate the VTAM network without waiting for the orderly termination to complete. This can be done by entering the /CHECKPOINT command again, either with FREEZE, DUMPQ, or PURGE but without QUIESCE. SNAPQ Requests a simple checkpoint and dumps the contents of the message queues to the system log. In a shared-queues environment, /CHECKPOINT SNAPQ does not snap the queues because the local IMS subsystem has no local queues. Use the /CQCHKPT command to initiate a CQS structure checkpoint. In an XRF environment, /CHECKPOINT SNAPQ synchronizes the active and alternate IMS subsystems. STATISTICS Requests that IMS performance records be created and written to the system log. No other checkpoint processing occurs. The /CHECKPOINT STATISTICS command does not create a system checkpoint on the log. Usage notes The /CHECKPOINT command can be used to take a simple checkpoint of IMS, with the option of also dumping the contents of the message queue data sets to the system log or to shut down IMS normally. When IMS is shut down by the /CHECKPOINT command, it can be restarted with the /NRESTART command. This command can be issued to an IMSplex using the Batch SPOC utility. 156 Commands, Volume 1: IMS Commands A - M There are two conditions under which IMS cannot complete a shutdown normally. The most frequent is when there are multiple-page messages on a master terminal non-VTAM line, paging is not complete, and the master terminal is sharing a communication line with other physical terminals. It might be necessary to use the /ASSIGN command to reassign the master terminal to a line by itself so that the /IDLE command can be issued to terminate the multiple page output. If the master terminal cannot be reassigned to another line, assign it to the system console line. The second condition occurs when a number of system messages generated by IMS are awaiting delivery to the master terminal. All system messages destined for the master terminal will be delivered, because they can affect the way the system is restarted. The master terminal operator should acknowledge delivery of a message by causing an I/O interrupt; that is, pressing PA2, which in turn causes another message to be sent, if one exists. Another option is to assign the master terminal to the system console. When the /CHECKPOINT command is used to shut down IMS, the /BROADCAST command can be helpful in notifying the remote terminal operators that IMS is shutting down. If OTMA is active and a tpipe is idle for three consecutive system checkpoints, depending on certain eligibility requirements, the tpipe is removed. Examples The following are examples of the /CHECKPOINT command: Example 1 for /CHECKPOINT command Entry ET: /CHECKPOINT Response ET: DFS058I (time stamp) CHECKPOINT COMMAND IN PROGRESS DFS994I *CHKPT 82102/110247**SIMPLE* Explanation: A simple checkpoint of IMS is written to the system log at 110247 (time) on 82102 (Julian date). The checkpoint number is 82102/110247. Example 2 for /CHECKPOINT command Entry ET: /CHECKPOINT FREEZE Response ET: DFS058I (time stamp) CHECKPOINT COMMAND IN PROGRESS DFS994I *CHKPT 82206/120118**FREEZE* Explanation: IMS is terminated after all checkpoint freeze functions are completed. The checkpoint is written to the system log at 120118 (time) on 82206 (Julian date). The checkpoint number is 82206/120118. Example 3 for /CHECKPOINT command Entry ET: Chapter 13. /CHECKPOINT command 157 /CHECKPOINT FREEZE QUIESCE Response ET: DFS058I (time stamp) CHECKPOINT COMMAND IN PROGRESS DFS994I *CHKPT 82102/110247**FREEZE* Explanation: IMS is terminated after all VTAM nodes have returned a shutdown-complete indicator to IMS and IMS has completed all checkpoint freeze functions. The checkpoint is written to the system log at 110247 (time) on 82102 (Julian date). The checkpoint number is 82102/110247. Example 4 for /CHECKPOINT command Entry ET: /CHECKPOINT PURGE ABDUMP Response ET: DFS058I (time stamp) CHECKPOINT COMMAND IN PROGRESS DFS994I *CHKPT 82128/101112**PURGE* Explanation: IMS is terminated after all checkpoint purge functions are completed. The checkpoint is written to the system log at 101112 (time) on 82128 (Julian date). The checkpoint number is 82128/101112. A z/OS ABEND message is issued when the dump of the IMS control region is completed. Example 5 for /CHECKPOINT command Entry ET: /CHECKPOINT PURGE Response ET: DFS058I (time stamp) CHECKPOINT COMMAND IN PROGRESS DFS994I *CHKPT 82103/131415**PURGE* Explanation: IMS is terminated after all checkpoint purge functions are completed. The checkpoint is written to the system log at 131415 (time) on 82103 (Julian date). The checkpoint number is 82103/131415. Example 6 for /CHECKPOINT command Entry ET: /CHECKPOINT STATISTICS Response ET: /DFS058I /DFS994I (timestamp) CHECKPOINT COMMAND IN PROGRESS STATISTICS CHECKPOINT COMMAND COMPLETED Explanation: IMS performance statistics records are written to the system log. No other information is saved. This checkpoint cannot be used for a system restart. 158 Commands, Volume 1: IMS Commands A - M Chapter 14. /CLSDST command The /CLSDST command causes IMS to disconnect an ISC TCP/IP or a VTAM terminal. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 161 v “Example” on page 161 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 109. Valid environments for the /CLSDST command and keywords Command / Keywords DB/DC DBCTL DCCTL /CLSDST X X FORCE X X NODE X X USER X X Syntax /CLSDST /CLS NODE nodename nodename* ALL nodename USER username ALL (1) nodename FORCE USER username Notes: | 1 ISC TCP/IP nodes do not support the FORCE keyword. Keywords The following keywords are valid for the /CSLDST command: FORCE Allows IMS to reinitialize a hung node with I/O in progress. FORCE reinitializes one session and is valid only on an active IMS system. To activate FORCE on VTAM nodes, use the command /CLSDST NODE P1 FORCE. © Copyright IBM Corp. 1974, 2014 159 For ISC VTAM nodes with parallel sessions, the USER keyword must be specified and only one USER parameter is allowed. ISC TCP/IP nodes do not support the FORCE keyword. | FORCE operates under the following conditions: v A display from VTAM indicates that no session exists. If a session does exist, or is in process, you must issue the VTAM command VARY NET,INACT,FORCE to terminate the session, and the command must successfully complete. This command terminates all parallel sessions. Attention: If VARY NET,INACT,FORCE is not issued or does not successfully complete before you issue the FORCE command, and the terminal is in the process of creation or termination, the results might be unpredictable. v The session is connected to IMS and output is in progress. A /DISPLAY on the node indicates that a CID exists, that the node is connected (a status of CON is displayed), and that the node is not idle (a status of IDLE is not displayed). NODE Specifies the node to be disconnected by IMS. The specified node must be connected before a command is issued to disconnect it, as indicated by CON on the /DISPLAY NODE command referring to that terminal. If the USER keyword is omitted for ISC nodes, all half-sessions of a session type 6 node are terminated. If the USER keyword is omitted, generic parameters are allowed for the NODE keyword. The timing of the disconnection depends on the type of terminal: v For keyboards or printers, console components and interactive terminals, the disconnection occurs at the next message boundary. v For component types that group messages (such as a SLU 1 statement reader, printer, or disk), the disconnection occurs at the end of any group where processing is in progress. v For 3270 displays, the disconnection occurs at the completion of the current (if any) I/O operation. USER Must be specified with the NODE keyword. NODE USER specifies the ISC user allocated to the ISC node or the dynamic user signed on to the dynamic node. When a /CLSDST NODE nodename USER username command is issued, it only affects the NODE if the USER is still associated with the node. For non-ISC dynamic nodes, this command is valid only if the user is still signed on to the node. For ISC nodes, the half-sessions of the ISC node allocated to the specific users are terminated and the users are not deallocated from the session. On restart, the /OPNDST command must specify the same users and ID pairs. Restrictions for using NODE and USER parameters together: v Commands with the NODE USER keyword pair are valid only if: – The USER is signed on to the NODE – In an ISC environment, the USER is allocated to the NODE – The nodes and users already exist v /CLSDST NODE USER commands are valid for ISC and non-ISC nodes and users. 160 Commands, Volume 1: IMS Commands A - M Usage notes /CLSDST resets preset mode, test mode, lock node, lock LTERM, pstop LTERM, and purge LTERM, because these statuses are not significant and therefore are not kept after a logon or restart. This command can be issued to an IMSplex using the Batch SPOC utility. The /CLSDST command will also do some other cleanup depending on the recovery settings for the node. Below are the actions taken: RCVYSTSN=NO /CLSDST acts like a /CHANGE NODE COLDSESS command for FINANCE and SLUP nodes by setting the session status to “cold”. /CLSDST will act like a /QUIESCE NODE command for ISC (LU6.1) nodes by initiating the shutdown and deallocating the user for the specified node. This action changes the session status to cold. With these actions taken by the /CLSDST command, the next session initiation request for this node will be allowed to again attempt a session cold start. For ETO nodes, the control block structure could be deleted, if no significant status exists. RCVYCONV=NO /CLSDST causes any IMS conversations (active and held) to be terminated. Any conversational message that is queued or being processed will have its output response message delivered asynchronously. RCVYFP=NO /CLSDST causes Fast Path status and messages to be discarded. RCVYRESP=NO /CLSDST resets full-function response mode. If global resource information is not kept in Resource Manager (RM), /CLSDST logs a node off and resets status locally. If global resource information is kept in RM, /CLSDST resets status globally. If the node has no significant status, /CLSDST deletes the node in RM. If ROUTE is specified, it should be specified with ROUTE(*). The command fails if not routed to the IMS where the node is active. Example Entry ET: /CLSDST NODE WEST Response ET: DFS058I CLSDST COMMAND COMPLETED Explanation: The node, WEST, is disconnected from IMS. Chapter 14. /CLSDST command 161 162 Commands, Volume 1: IMS Commands A - M Chapter 15. /COMPT command The /COMPT command sets a particular terminal component to a ready or not-ready state. Output messages queued for a particular component will not be sent unless the component is ready. Depending on terminal type and the availability of messages queued for other components, output operations for other components can continue. Subsections: v “Environment” v “Syntax” on page 164 v “Keywords” on page 164 v “Usage notes” on page 165 v “Examples” on page 165 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 110. Valid environments for the /COMPT command and keywords Command / Keywords DB/DC DBCTL DCCTL /COMPT X X CNS X X CRD X X NODE X X NOTRDY X X PCH X X PDS X X PRT X X RDR X X READY X X TDS X X UDS X X USER X X VID X X WPM1 X X WPM2 X X WPM3 X X © Copyright IBM Corp. 1974, 2014 163 Syntax /COMPT /COM 1 CNS NODE nodename CRD compt# PCH PDS PRT RDR TDS UDS VID WPM1 WPM2 WPM3 1 NODE nodename 2 USER username 3 4 READY NOTRDY Keywords The following keywords are valid for the /COMPT command: CNS | CRD | PCH | PDS | PRT | RDR | TDS | UDS | VID | WPM1 | WPM2 | WPM3 | 1 | 2 | 3 | 4 Specifies the component that you want to set to a ready or not-ready state. The command format can take two forms. That is, a component can be referenced by using a keyword, such as VID, or by using a number, such as 2. When a keyword is used, a search is made of the components (as defined in the TERMINAL macro during IMS system definition) for the component type defined that corresponds to the specified keyword. When a match is found, that component is made ready/not ready as specified by the command. If a number other than 1 follows the keyword, the corresponding occurrence of that component type is made ready/not ready. /COMPT supports up to four components. When a number from 1 through 4 is used instead of a keyword, the component affected is the one defined in that position during system definition, independent of component type. Restriction: When the /COMPT command contains the keyword CRD, it cannot also contain any of the following keywords: WPM1, WPM2, or WPM3. READY Sets the specified terminal component to a ready state. NOTRDY Sets the specified terminal component to a not-ready state. NODE Specifies the node name (as specified by the TERMINAL macro) of the terminal component that is to be set in ready or not-ready state. USER Specifies the ISC subpool name of the nodename. The USER keyword is required if the node specified on the command is an ISC node. 164 Commands, Volume 1: IMS Commands A - M Usage notes The ready or not-ready state set by the /COMPT command can be altered by the following: v Another /COMPT command v A /START, /RSTART, or /RCOMPT command v An I/O error on the terminal component The /COMPT command can only refer to a VTAM-attached terminal component. Restrictions for using NODE and USER parameters together: v Commands with the NODE USER keyword pair are valid only if: – The USER is signed on to the NODE – In an ISC environment, the USER is allocated to the NODE – The nodes and users already exist v /COMPT (1|2|3|4) NODE USER (READY/NOTRDY) commands are valid for ISC and non-ISC nodes and users. Examples The following are examples of the /COMPT command: Example 1 for /COMPT command Entry ET: /COMPT 4 NODE ABC READY Response ET: DFS058I COMPT COMMAND COMPLETED Explanation: The fourth component defined in the TERMINAL macro on node ABC is made ready to IMS. Example 2 for /COMPT command Entry ET: /COMPT VID 2 NODE ABC READY Response ET: DFS058I COMPT COMMAND COMPLETED Explanation: The second display component on node ABC is declared operable to IMS. Related reference: Chapter 9, “/ASSIGN command,” on page 101 Chapter 15. /COMPT command 165 166 Commands, Volume 1: IMS Commands A - M Chapter 16. /CQCHKPT command The /CQCHKPT command initiates a CQS checkpoint for a specific coupling facility list structure or all the coupling facility list structures to which the IMS subsystem is connected. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 168 v “Examples” on page 168 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 111. Valid environments for the /CQCHKPT command and keywords Command / Keywords DB/DC DBCTL DCCTL /CQCHKPT X X SHAREDQ X X STRUCTURE X X SYSTEM X X Syntax /CQCHKPT /CQC SYSTEM SHAREDQ STRUCTURE structurename ALL Keywords The following keywords are valid for the /CQCHKPT command: SHAREDQ Specifies that the entire queue structure is to be checkpointed to the structure recovery data set. While the checkpoint is in progress for the structure, no CQS can access the structure. During a structure checkpoint, every CQS connected to that structure also takes a system checkpoint. Recommendation: When possible, issue this command when it will have the least performance impact to your online IMS subsystems. STRUCTURE Specifies a specific structure name (or all) for which a CQS checkpoint is to be taken. If an overflow structure exists for a structure, a checkpoint is taken for both the primary and overflow structure. © Copyright IBM Corp. 1974, 2014 167 SYSTEM Specifies that a system checkpoint is to be taken; the CQS internal tables are checkpointed and written to the CQS log. Only the CQS for which you enter the command takes a system checkpoint. Usage notes This command sends the DFS058 CQCHKPT COMMAND IN PROGRESS message to the inputting terminal, and sends an asynchronous response to the system console and master terminal when the CQS checkpoint is complete. This command is valid only in a shared-queues environment. This command can be issued to an IMSplex using the Batch SPOC utility. Examples The following are examples of the /CQCHKPT command: Example 1 for /CQCHKPT command Entry ET: /CQCHKPT SYSTEM STRUCTURE IMSMSGQ01 Response ET: DFS058I CQCHKPT COMMAND IN PROGRESS CQS0030I SYSTEM CHECKPOINT COMPLETE, STRUCTURE IMSMSGQ01 , LOGTOKEN 0000000001687D3F CQS1CQS DFS1972I CQCHKPT SYSTEM COMMAND COMPLETE FOR STRUCTURE=IMSMSGQ01 Explanation: A CQS system checkpoint completes successfully. Recommendation: Record the log token displayed in the CQS0030I message because you might need it for a CQS restart. Example 2 for /CQCHKPT command Entry ET: /CQCHKPT SHAREDQ STRUCTURE IMSMSGQ01 Response ET: DFS058I CQCHKPT COMMAND IN PROGRESS CQS0220I CQS CQS1CQS STARTED STRUCTURE CHECKPOINT FOR STRUCTURE IMSMSGQ01 CQS1CQS CQS0200I STRUCTURE IMSMSGQ01 QUIESCED FOR STRUCTURE CHECKPOINT CQS1CQS CQS0201I STRUCTURE IMSMSGQ01 RESUMED AFTER STRUCTURE CHECKPOINT CQS1CQS CQS0030I SYSTEM CHECKPOINT COMPLETE, STRUCTURE IMSMSGQ01 , LOGTOKEN 0000000001688652 CQS1CQS CQS0221I CQS CQS1CQS COMPLETED STRUCTURE CHECKPOINT FOR STRUCTURE IMSMSGQ01 CQS1CQS DFS1972I CQCHKPT SHAREDQ COMMAND COMPLETE FOR STRUCTURE=IMSMSGQ01 Explanation: A CQS structure checkpoint for a specific structure completes successfully. 168 Commands, Volume 1: IMS Commands A - M Chapter 17. /CQQUERY command The /CQQUERY command displays information regarding a specific coupling facility list structure or all the coupling facility list structures holding IMS messages. The /CQQUERY STATISTICS command displays the statistics and status information for the coupling facility list structures specified by the STRUCTURE keyword. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 170 v “Examples” on page 170 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 112. Valid environments for the /CQQUERY command and keywords Command / Keywords DB/DC DBCTL DCCTL /CQQUERY X X STATISTICS X X STRUCTURE X X Syntax /CQQUERY /CQQ STATISTICS STRUCTURE structurename ALL Keywords The following keywords are valid for the /CQQUERY command: STATISTICS Specifies that statistics should be gathered and displayed. STRUCTURE Specifies that one or more structure names follow. Only primary, coupling facility list-structure names used by IMS for shared queues are valid. © Copyright IBM Corp. 1974, 2014 169 Usage notes This command is valid only in a shared-queues environment. The following statistics information is displayed: v v v v v Number of data elements that can be allocated in the structure Number of list entries that can be allocated in the structure Number of data elements in use in the structure Number of list entries in use in the structure Entry-to-element ratio The entry-to-element ratio is the ratio of list entries to list elements in the structure when the structure was first allocated, or last altered (for structures defined with ALLOWAUTOALT(YES)). The ratio value is initially derived by CQS from the OBJAVGSZ parameter in the CQSSGxxx PROCLIB member. The ratio can be changed by z/OS dynamically as needed for ALLOWAUTOALT(YES) structures. The ratio might also change slightly when a structure is rebuilt, because CQS uses the saved values of the actual number of allocated entries and elements to derive the entry-to-element ratio for the connection to a rebuild structure. In an IMSplex, /CQQUERY displays information regarding a specific shared queue coupling facility list structure or all the shared queue coupling facility list structures holding IMS messages. /CQQUERY does not display any information about resource structures. When the /CQQ command is issued through OM, command processing is not serialized through the IMS CTL TCB. This command can be issued to an IMSplex by using the Batch SPOC utility. Examples The following are examples of the /CQQUERY command: Example 1 for /CQQUERY command Entry ET: /CQQUERY STATISTICS STRUCTURE ALL Response ET: STRUCTURE NAME IMSMSGQ01 IMSMSGQ01OFLW IMSEMHQ01 IMSEMHQ01OFLW *08282/211714* LEALLOC 1789 N/A 377 N/A LEINUSE ELMALLOC ELMINUSE LE/EL 11 1787 19 00001/00001 N/A N/A N/A N/A 3 375 3 00001/00001 N/A N/A N/A N/A Explanation: This command displays the structure statistics of the message queue and Fast Path EMH queue structures used by IMS. The list entries allocated (LEALLOC), the list entries in use (LEINUSE), the elements allocated (ELMALLOC) and the elements in use (ELMINUSE) show the usage of the structures. When CQS allocates a structure, it allocates a certain number of list entries and elements to manage data on the structure. A structure is full if all list entries are in use or if all elements are in use. 170 Commands, Volume 1: IMS Commands A - M Example 2 for /CQQUERY command Entry ET: /CQQ STATISTICS STRUCTURE IMSMSGQ01 Response ET: STRUCTURE NAME IMSMSG101 IMSMSGQ01OFLW *08282/211714* LEALLOC 9132 1915 LEINUSE ELMALLOC ELMINUSE LE/EL 9027 9130 9071 00001/00001 1866 1912 1866 00001/00001 Explanation: This command displays the structure statistics of the message queue structure used by IMS and its associated overflow queue. Related concepts: Using structure alter for CQS (System Administration) Related reference: CQSSGxxx member of the IMS PROCLIB data set (System Definition) Chapter 17. /CQQUERY command 171 172 Commands, Volume 1: IMS Commands A - M Chapter 18. /CQSET command Use a /CQSET SHUTDOWN SHAREDQ ON|OFF command to tell CQS whether to take a structure checkpoint during normal shutdown. You can specify a structure checkpoint for a specific coupling facility or for all coupling facility list structures used by IMS. Subsections: v “Environment” v v v v “Syntax” “Keywords” “Usage notes” on page 174 “Example” on page 174 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 113. Valid environments for the /CQSET command and keywords Command / Keyword DB/DC DBCTL DCCTL /CQSET X X SHAREDQ X X SHUTDOWN X X STRUCTURE X X Syntax ON /CQSET /CQS SHUTDOWN SHAREDQ STRUCTURE OFF structurename ALL Keywords The following keywords are valid for the /CQSET command: SHAREDQ Specifies that the entire queue structure is to be checkpointed to the structure recovery data set. While the checkpoint is in progress for the structure, no CQS can access the structure. During a structure checkpoint, every CQS connected to that structure also takes a system checkpoint. SHUTDOWN Specifies that CQS should take a structure checkpoint during normal CQS shutdown. © Copyright IBM Corp. 1974, 2014 173 STRUCTURE Specifies a specific structure name (or all) for which a CQS checkpoint is to be taken. If an overflow structure exists for a structure, a checkpoint is taken for both the primary and overflow structure. Usage notes IMS initiates a normal CQS shutdown during a normal IMS shutdown. This command is valid only in a shared-queues environment. In an IMSplex, when the /CQS command is issued through OM command processing, it is not serialized through the IMS CTL TCB. This command can be issued to an IMSplex using the Batch SPOC utility. Example Entry ET: /CQSET SHUTDOWN SHAREDQ ON STRUCTURE ALL Response ET: DFS058I CQSET COMMAND COMPLETE Explanation: CQS will take a structure checkpoint when it shuts down. 174 Commands, Volume 1: IMS Commands A - M Chapter 19. CREATE commands Use the IMS CREATE commands to create resources and resource descriptors. These commands can be issued through TSO SPOC or the Manage Resources options in the IMS Applications menu. These commands can also be issued to an IMSplex using the Batch SPOC utility. Subsections: v “CREATE DB command” | v v v v v v v v “CREATE “CREATE “CREATE “CREATE “CREATE “CREATE “CREATE “CREATE DBDESC command” on page 183 IMSCON commands” on page 189 OTMADESC command” on page 205 PGM command” on page 215 PGMDESC command” on page 226 RTC command” on page 235 RTCDESC command” on page 241 TRAN command” on page 246 v “CREATE TRANDESC command” on page 270 CREATE DB command Use the CREATE DB command to create the database resource requirements for one or more physical databases managed by IMS. Subsections: v “Environment” v “Syntax” on page 176 v “Keywords” on page 176 v v v v “Usage notes” on page 178 “Output fields” on page 179 “Return, reason, and completion codes” on page 179 “Examples” on page 181 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 114. Valid environments for the CREATE DB command and keywords Command / Keywords DB/DC DBCTL CREATE DB X X LIKE X X NAME X X SET X X © Copyright IBM Corp. 1974, 2014 DCCTL 175 Syntax , CREATE CRE DB NAME( name ) LIKE( DESC(descriptor_name) RSC(resource_name) ) , SET( UPD BRWS ) READ EXCL N RESIDENT( Y ) ACCTYPE( ) Default values shown in this syntax diagram reflect the default values that are defined in the IMS database descriptor, DFSDSDB1. If you define another descriptor as the default with a CREATE or UPDATE DBDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE DB command: LIKE Specifies that the resource is created using an existing resource or descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DFSDSDB1, or the one that you define. The model type can either be a descriptor (DESC), or a resource (RSC). The new resource is created with all the same attributes as the model, except for the DEFAULT(Y) value. Attributes set explicitly by the CREATE command override the model attributes. Later changes to the model are not propagated to resources or descriptors that were created from it. You can use QUERY commands to display the model name and model type used to create the resource. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition, including the model name and model type, to the definition member. The IMPORT command imports a resource definition, including the model name and model type, from the definition member. An IMPORT command that creates a resource saves the model name and model type, but does not use the models attributes. When you specify LIKE on a CREATE command, IMS sets the attributes of the newly created resource or descriptor to the models current attributes, except for the default attribute. DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this resource. 176 Commands, Volume 1: IMS Commands A - M RSC(resource_name) Specifies the name of the resource to use as a model to define this resource. NAME Specifies the 1-8 character name of the database (DBD name). Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). All database names must begin with an alphabetic character (A through Z, #, $, and @) followed by 0–7 alphanumeric characters. Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin with DFS, except for DFSIVPxx and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBRC, ISCEDT, MSDB, SDB, or WTOR. A database resource and a database descriptor can have the same name. SET Specifies the attributes of the database to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either IMS descriptor DFSDSDB1 or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. ACCTYPE() Specifies the access intent for the named database, which is how the subsystem requesting access plans to use the database. Access type is used with the database sharing level declared to DBRC. Access types include the following options: BRWS The database is available for read-only processing on this IMS subsystem. The only programs that can use the database on this subsystem are those that have a PCB processing option of GO (PROCOPT=GO). Programs that access the data using the GO processing option might see uncommitted data since a sharing IMS subsystem could be updating the database. The database is opened for read-only processing. EXCL The database is to be used exclusively by this IMS subsystem. This exclusive access is guaranteed only when the database is registered to DBRC. READ The database is available for read-only processing in this IMS subsystem. Programs with update intent can be scheduled, but cannot update the database. Access type READ differs from access type BRWS in that the data is read with integrity (locking is performed) and all programs can access the data, not just those with a processing option of GO. The database is opened for read-only processing. UPD The database is available for update as well as read processing in the IMS subsystem. This is the default. RESIDENT Specifies the resident option. The RESIDENT(N) option takes effect immediately. The RESIDENT(Y) option takes effect at the next restart, unless the database was created as RESIDENT(Y) after the checkpoint from which this IMS is performing emergency restart. A database defined as a Chapter 19. CREATE commands 177 DEDB or an MSDB in ACBLIB always sets the RESIDENT(Y) attribute, regardless of the RESIDENT value specified. N The DMB associated with the named database resource is not made resident in storage. The DMB is loaded at scheduling time. Y The DMB associated with the named database resource is made resident in storage at the next IMS restart. At the next IMS restart, IMS loads the DMB and initializes it. A resident database is accessed from local storage, which eliminates I/O to the ACBLIB. In an online environment, the DMB control blocks are stored in the ACBLIB. If the DLI/SAS address space exists, DLI/SAS loads the DMB; otherwise, it is the IMS control region that loads it. This makes the DMB dependent on the existence of the corresponding database resource. Usage notes The database can be HSAM, HISAM, HDAM, HIDAM, DEDB, MSDB, or a HALDB master database. Two database resources must be defined for a HIDAM database; one for the INDEX DBD, and one for the HIDAM DBD. No database resource should be defined for a PHIDAM primary index. One database must be defined for each secondary index that refers to any database defined to the online system. The database cannot be a HALDB partition. HALDB partitions can be defined using the HALDB Partition Definition utility. A BLDL is performed on the DMB associated with this database. The database is created even if the DMB is not defined in ACBLIB. In this case, the database cannot be used. The database status is NOTINIT when a /DISPLAY DB or QUERY DB is issued for the database. Online Change must be used to add the DMB to ACBLIB, before the database can be used. After a CREATE DB command for a HALDB master database, the user must issue a QUERY DB command or a /DISPLAY DB command for the HALDB master to determine if the partitions were built. If the partitions were not built, the user must issue one of the following commands to initialize the partitions: v A /START DB HALDB_Master OPEN command v An UPDATE DB NAME(HALDB_Master) START(ACCESS) OPTION(OPEN) command Fast Path DEDB or MSDB-related control blocks are loaded. If the DMB is in the ACBLIB library, IMS loads the DMB and can determine what type of database it is. IMS takes different actions depending on whether it is a full function database, a DEDB, or an MSDB. v For full function databases, the DMB is loaded into the DMB pool. Even if the database is created with RESIDENT(Y), DMB residency does not take effect until the next IMS restart. v For DEDBs, the DMCB (DEDB version of a DMB), is chained into the DMCB chain (all DEDB DMCBs are resident). The parameters are then checked for CI size and to see whether the DMCB contains an area that already exists. If the CI size of any AREA is larger than the CI size specified for the DBBF buffers (fast path global buffer pool), then the CREATE command fails with completion code E3. If the DMCB contains an area definition that already exists in the FPAL (Fast Path Area List), the CREATE command fails with completion code E4. v For MSDBs, a special procedure is required to make the MSDB available. The MSDB can then be used at the next IMS restart 178 Commands, Volume 1: IMS Commands A - M If the DMB is not in the ACBLIB library, then the DDIR control block is successfully created, but has an initial status of NOTINIT. Resources exist in IMS until they are deleted using a DELETE command. Resources are recoverable across an IMS warm start or emergency restart. Resources are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE DB command is similar to local online change (using a /MODIFY command) or global online change (using an INITIATE OLC command) for database resources in the MODBLKS data set, except that databases are added dynamically. Restrictions: v The CREATE DB command can be issued only through the OM API. v This command is not valid: – On the XRF alternate, RSR tracker, or FDBR region. – If online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx are defined with MODBLKS=OLC, or MODBLKS is not defined). Output fields The following table shows the CREATE DB output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 115. Output fields for the CREATE DB command Short label Keyword Meaning CC N/A Completion code. CCTXT error Completion code text that briefly explains the meaning of the non-zero completion code. DB DB Database name. MBR N/A IMSplex member that built the output line. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Chapter 19. CREATE commands 179 Table 116. Return and reason codes for CREATE DB | | | | | | | Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000008' X'00002048' Invalid SET attribute. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004204' Model is quiesced. Cannot quiesce the model. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000010' X'00004301' Command is not allowed because the database is defined RESIDENT(Y), the DMB indicates there is a logical relationship for the database, but the other database is not defined. X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. X'00000014' X'00005010' Unable to obtain latch. X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 117. Completion codes for the CREATE DB command Completion code Completion code text 0 11 180 Meaning Command completed successfully for database. RESOURCE ALREADY EXISTS Commands, Volume 1: IMS Commands A - M Database exists. Table 117. Completion codes for the CREATE DB command (continued) Completion code Completion code text Meaning 17 ANOTHER CMD IN PROGRESS Quiescing the default descriptor failed because it was being referenced by another command. 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 60 GETMAIN STORAGE ERROR A GETMAIN request for storage was unsuccessful. 61 DFSBCB STORAGE ERROR Request to get BCB storage for DDIR control block failed. 65 DMB POOL STORAGE ERROR During a CREATE command for a DB resource, there was no storage available in the DMB pool to load a resident DMB. 8A WILDCARD PARAMETER NOT SUPPORTED The CREATE command does not support wildcard parameters. You must explicitly specify the names of the resources you want to create. 90 INTERNAL ERROR An IMS system service failure. 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. BC MAX 32767 DB EXCEEDED The CREATE DB command failed, because it attempted to create the 32768th database. A maximum of 32,767 databases are allowed. DE ACBLIB READ FAILURE A read request for a member in ACBLIB failed. FA AREA SIZE GREATER THAN BUFF A CREATE command for a DEDB SIZE failed because one of the areas in the DEDB has a buffer size greater than the system buffer size (BSIZ). E4 DUPLICATE AREA ALREADY EXISTS A CREATE command for a DEDB failed because one of the areas in the DEDB already exists. Examples The following are examples of the CREATE DB command: Example 1 for CREATE DB command TSO SPOC input: CREATE DB NAME(DB000001,DB000002,DB000003) SET(ACCTYPE(UPD),RESIDENT(Y)) TSO SPOC output: Chapter 19. CREATE commands 181 DBName DB000001 DB000002 DB000003 MbrName IMS1 IMS1 IMS1 CC 0 0 0 OM API input: CMD(CREATE DB NAME(DB000001,DB000002,DB000003) SET(ACCTYPE(UPD),RESIDENT(Y))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.254 23:22:04.212509</statime> <stotime>2006.254 23:22:04.267816</stotime> <staseq>BF6461C25FD1D8C5</staseq> <stoseq>BF6461C26D528480</stoseq> <rqsttkn1>USRT011 10162204</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>DB </kwd> <input>CREATE DB NAME(DB000001,DB000002,DB000003) SET(ACCTYPE(UPD),RESIDENT(Y)) </input> </cmd> <cmdrsphdr> <hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>DB(DB000001) MBR(IMS1) CC( 0) </rsp> <rsp>DB(DB000002) MBR(IMS1) CC( 0) </rsp> <rsp>DB(DB000003) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> TSO SPOC input: QRY DB NAME(DB00*) SHOW(ACCTYPE,RESIDENT,DEFNTYPE,MODEL) TSO SPOC output: DBName DB000001 DB000002 DB000003 MbrName IMS1 IMS1 IMS1 CC TYPE 0 0 0 LAcc UPD UPD UPD Rsdnt Y Y Y LRsdnt N N N ModelName DFSDSDB1 DFSDSDB1 DFSDSDB1 ModelType DESC DESC DESC DefnType CREATE CREATE CREATE Explanation: Several databases are created dynamically, with an access type of update (UPD) and an attribute of resident. Attributes not specified on the command are set to the attributes defined in the database default descriptor. The QRY DB command displays the database attributes specified on the SHOW keyword. The database TYPE is shown as blank for both databases, since there is no DMB in ACBLIB and IMS cannot tell what the database type is. The resident 182 Commands, Volume 1: IMS Commands A - M attribute (Rsdnt) is shown as Y (yes), but the local resident attribute (Lrsdnt) is shown as N (no), since the resident attribute does not take effect until the next restart. The database default descriptor used to create the databases is shown as ModelName DFSDSDB1 and ModelType DESC for descriptor. The definition type Defntype is CREATE, since both of these databases were defined with a CREATE command. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related tasks: Adding MSDB databases dynamically to an online IMS system (Database Administration) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 CREATE DBDESC command Use the CREATE DBDESC command to create database descriptors, which serve as models for creating database resources or other database descriptors. A descriptor is created with a value set for every attribute. Subsections: v “Environment” v “Syntax” v “Keywords” on page 184 v “Usage notes” on page 186 v “Output fields” on page 186 v “Return, reason, and completion codes” on page 187 v “Examples” on page 189 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 118. Valid environments for the CREATE DBDESC command and keywords Command / Keywords DB/DC DBCTL DCCTL CREATE DBDESC X X LIKE X X X NAME X X X SET X X X Syntax , CREATE CRE DBDESC NAME( name ) Chapter 19. CREATE commands 183 LIKE( DESC(descriptor_name) RSC(resource_name) ) , SET( UPD BRWS ) EXCL READ N DEFAULT( Y ) N RESIDENT( Y ) ACCTYPE( ) Default values shown in this syntax diagram reflect the default values that are defined in the IMS database descriptor, DFSDSDB1. If you define another descriptor as the default with a CREATE or UPDATE DBDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE DBDESC command: LIKE Specifies that the descriptor is created using an existing descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DFSDSDB1, or user-defined. The model type can either be a descriptor (DESC), or a resource (RSC). The descriptor is created with all the same attributes as the model, except for the DEFAULT(Y) value. Attributes set explicitly by the CREATE command override the model attributes. DEFAULT(Y) must be specified explicitly to make a descriptor the default descriptor. Later changes to the model are not propagated to resources or descriptors that were created from it. Use QUERY commands to display the model name and model type used to create the descriptor. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition including the model name and model type to the definition member. The IMPORT command imports a resource definition including the model name and model type from the definition member. An IMPORT command that creates a resource saves the model name and model type, but does not use the model's attributes. When you specify LIKE on a CREATE command, IMS uses the model's current attributes to set the attributes of the newly-created descriptor, except for the default attribute. DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this descriptor. 184 Commands, Volume 1: IMS Commands A - M RSC(resource_name) Specifies the name of the resource to use as a model to define this descriptor. NAME Specifies the 1-8 character name of the database descriptor. Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). All database descriptor names must begin with an alphabetic character (A through Z, #, $, and @) followed by 0–7 alphanumeric characters. Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin with DFS, except for DFSIVPxx and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBRC, ISCEDT, MSDB, SDB, or WTOR. A database resource and a database descriptor can have the same name. SET Specifies the attributes of the database to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either IMS descriptor DFSDSDB1 or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. ACCTYPE() Specifies the access intent for the named database, which is how the subsystem requesting access plans to use the database. Access type is used in conjunction with the database sharing level declared to DBRC. UPD The database is available for update as well as read processing in the IMS subsystem. This is the default. BRWS The database is available for read-only processing on this IMS subsystem. The only programs that can use the database on this subsystem are those that have a PCB processing option of GO (PROCOPT=GO). Programs that access the data using the GO processing option might see uncommitted data since a sharing IMS subsystem could be updating the database. The database is opened for read-only processing. EXCL The database is to be used exclusively by this IMS subsystem. This exclusive access is guaranteed only when the database is registered to DBRC. READ The database is available for read-only processing in this IMS subsystem. Programs with update intent can be scheduled, but cannot update the database. Access type READ differs from access type BRWS in that the data is read with integrity (locking is performed) and all programs can access the data, not just those with a processing option of GO. The database is opened for read-only processing. DEFAULT Specifies whether the descriptor is the default. N The descriptor is not the default. Y The descriptor is the default, which resets the existing default descriptor to DEFAULT(N). When a descriptor is created without the LIKE keyword, any attribute not specified on the CREATE command takes the value defined in the default descriptor. Only one descriptor Chapter 19. CREATE commands 185 can be defined as the default for a resource type. IMS defines a default database descriptor called DFSDSDB1, where all attributes are defined with the default value. Defining a user-defined descriptor as the default overrides the IMS-defined descriptor. Since only one database descriptor can be the default at one time, only one database name may be specified with DEFAULT(Y). RESIDENT Specifies the resident option. The RESIDENT(N) option takes effect right away. The RESIDENT(Y) option takes effect at the next restart, unless the database was created as RESIDENT(Y) after the checkpoint from which this IMS is performing emergency restart. A database defined as a DEDB in ACBLIB always sets the RESIDENT(Y) attribute when the DEDB is loaded, regardless of the RESIDENT value specified. RESIDENT(N) is rejected for a DEDB N The DMB associated with the named database resource is not made resident in storage. The DMB is loaded at scheduling time. Y The DMB associated with the named database resource is made resident in storage at the next IMS restart. At the next IMS restart, IMS loads the DMB and initializes it. A resident database is accessed from local storage, which eliminates I/O to the ACBLIB. In an online environment, the DMB control blocks are stored in the ACBLIB. If the DLI/SAS address space exists, DLI/SAS loads the DMB; otherwise, it is the IMS control region that loads it. This makes the DMB dependent on the existence of the corresponding database resource. Usage notes Attributes not explicitly specified on the CREATE command take the default value. Any database resource or descriptor can be created using this descriptor as a model, by specifying the CREATE command with LIKE(DESC(descriptor_name)). Descriptors exist for the life of the IMS unless they are deleted using a DELETE command. The descriptors are recoverable across an IMS warm start or emergency restart. Descriptors are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE DBDESC command can only be issued through the Operations Manager API. This command applies to DB/DC and DBCTL systems. This command is not valid on the XRF alternate, RSR tracker, or FDBR region. The CREATE DBDESC command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). Output fields The following table shows the CREATE DBDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. 186 Commands, Volume 1: IMS Commands A - M Meaning Provides a brief description of the output field. Table 119. Output fields for the CREATE DBDESC command Short label Keyword Meaning CC N/A Completion code. CCTXT error Completion code text that briefly explains the meaning of the non-zero completion code. DESC DBDESC Database descriptor name. MBR N/A IMSplex member that built the output line. OLDDEF DBDESC Old default descriptor name, if this descriptor is made the default by specifying DEFAULT(Y). The old default descriptor is no longer the default. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 120. Return and reason codes for CREATE DBDESC Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000008' X'00002048' Invalid SET attribute. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. X'00000008' X'00002133' Multiple name parameters specified with DEFAULT(Y) is invalid. Only one descriptor may be the default at one time. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004204' Model is quiesced. Cannot quiesce model. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). Chapter 19. CREATE commands 187 Table 120. Return and reason codes for CREATE DBDESC (continued) Return code Reason code Meaning X'00000010' X'00004301' Command is not allowed because the database is defined RESIDENT(Y), the DMB indicates there is a logical relationship for the database, but the other database is not defined. X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. | X'00000014' X'00005010' Unable to obtain latch. | | | | | | | X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 121. Completion codes for the CREATE DBDESC command Completion code Completion code text 0 188 Meaning Command completed successfully for database descriptor. 11 RESOURCE ALREADY EXISTS Database descriptor already exists. 17 ANOTHER CMD IN PROGRESS Quiescing the default descriptor failed because it was being referenced by another command. 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 60 GETMAIN STORAGE ERROR A GETMAIN request for storage was unsuccessful. 61 DFSBCB STORAGE ERROR Request to get BCB storage for DDIR control block failed. 8A WILDCARD PARAMETER NOT SUPPORTED You must explicitly specify the names of the descriptors you want to create. The CREATE command does not support wildcard parameters. 90 INTERNAL ERROR An IMS system service failure. 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. Commands, Volume 1: IMS Commands A - M Examples The following are examples of the CREATE DBDESC command: Example 1 for CREATE DBDESC command In this example, the database descriptors listed in the command with the NAME keyword are created with update access. Attributes not specified on the command are assigned the system defaults. TSO SPOC input: CREATE DBDESC NAME(DBHDAM1,DBHDAM2,DBHDAM3,DBHDAM4) SET(ACCTYPE(UPD)) TSO SPOC output: DBName DBHDAM1 DBHDAM2 DBHDAM3 DBHDAM4 MbrName IMS1 IMS1 IMS1 IMS1 CC 0 0 0 0 Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 | CREATE IMSCON commands | | | Use the CREATE IMSCON commands to add IMS Connect port or data store definitions during runtime processing without having to restart your IMS Connect instance. | The TYPE keyword specifies the type of IMS Connect resource to create. | | | The CREATE IMSCON command is processed by every IMS Connect to which OM routes the command, whether or not OM has designated a particular IMS Connect as the command master. | | Subsections: v “CREATE IMSCON TYPE(DATASTORE) command” v “CREATE IMSCON TYPE(PORT) command” on page 197 | | Related reference: | IMS Connect type-2 commands (Commands) | HWSCFGxx member of the IMS PROCLIB data set (System Definition) | CREATE IMSCON TYPE(DATASTORE) command | | | Use the CREATE IMSCON TYPE(DATASTORE) command to add IMS Connect data store definitions during runtime processing without having to restart your IMS Connect instance. | | The CREATE IMSCON TYPE(DATASTORE) command is used to add a communications path to an IMS data store from IMS Connect. Chapter 19. CREATE commands 189 | | You can also create data store definitions by specifying the DATASTORE statement in the HWSCFGxx member of the IMS PROCLIB data set. | | | | Subsections: v “Environment” v “Syntax” v “Keywords” | | | | | v v v v v | v “Examples” on page 195 | Environment | | | | | | The CREATE IMSCON command is applicable only to IMS Connect. To issue this command, the following conditions must be satisfied: | Syntax | | | | | | A: “Usage notes” on page 193 “Equivalent WTOR and z/OS commands” on page 193 “Output fields” on page 193 “Return, reason, and completion codes” on page 194 “Return, reason, and completion codes handled by OM” on page 195 v IMS Connect must be active and configured to communicate with the Common Service Layer (CSL) Structured Call Interface (SCI). v A type-2 command environment with Structured Call Interface (SCI) and Operations Manager (OM) must be active. CREATE CRE IMSCON TYPE(DATASTORE) NAME(name) LIKE(rsc_name) SET( | A ) , 120 ACKTO( timeout_value ) APPL(appl_name) CM0ATOQ(que_name) DRU(exit_name) GROUP(xcf_group_name) 5000 MAXI( flood_ctrl_value ) MEMBER(xcf_member_name) 999999 OAAV( acee_aging_value ) RRNAME(reroute_name) SMEMBER(super_member_name) TMEMBER(ims_xcf_member_name) | | Keywords | | The following keywords are valid for the CREATE IMSCON TYPE(DATASTORE) command: 190 Commands, Volume 1: IMS Commands A - M | | | | LIKE Specifies the existing IMS Connect data store to use as a model. The new resource is created with all of the same attribute values as the specified model data store. | | | | Attributes that are set explicitly by the CREATE IMSCON TYPE(DATASTORE) command override the attribute values that are generated from the model. Later changes to the model are not propagated to resources that were created from it. | | | NAME Specifies the 1- to 8-character name of the IMS data store. The name can consist of alphanumeric characters and must be unique within IMS Connect. | | This keyword is equivalent to the ID parameter of the DATASTORE statement in the HWSCFGxx member of the IMS PROCLIB data set. | This parameter is required. | | SET Specifies the attributes of the IMS data store to be created. | | If the LIKE keyword is omitted, the required attributes must be specified. If an optional attribute is not specified, IMS Connect uses its default value. | | If the LIKE keyword is specified, the attribute values that are specified with the SET keyword override the values that are generated from the model. | | | | ACKTO Specifies the timeout interval for acknowledgements to OTMA for CM0 and CM1 output messages and for IMS-to-IMS transaction messages. The timeout value can be 0 - 255 seconds. | | | This parameter is optional and defaults to 120. If the timeout value is 0 or is not specified, the OTMA ACK timeout default value of 120 seconds is set. | | | For IMS-to-IMS transaction messages, if an acknowledgement is not received by OTMA before the timeout interval expires, OTMA reroutes the transaction message to the timeout queue, DFS$$TOQ. | | | APPL Specifies the 1- to 8-character alphanumeric TCP/IP APPL name defined to RACF in the PTKTDATA statement. This parameter is optional and defaults to blanks. If you are using PassTicket and user message exits, you must specify the APPL parameter. | | | | | CM0ATOQ Specifies the 1- to 8-character alphanumeric name for the OTMA CM0 ACK timeout queue. | | | The value that is specified here overrides both the OTMA default value of DFS$$TOQ and the value that is set in the HWS statement of the HWSCFGxx member of the IMS PROCLIB data set. | This parameter is optional and defaults to blanks. | | | | | DRU Specifies the 1- to 8-character alphanumeric name for the OTMA destination resolution user (DRU) exit that is passed to OTMA. The DRU exit is required to support asynchronous output to IMS Connect clients. This parameter is optional and defaults to DFSYDRU0. Chapter 19. CREATE commands 191 | | | | GROUP Specifies the 1- to 8-character alphanumeric name of the z/OS cross-system coupling facility (XCF) group for the IMS OTMA. IMS Connect uses this value to join the XCF group. | | | | Because IMS Connect and IMS must be in the same XCF group to communicate, this group name must match the XCF group name that you define to IMS (GRNAME) in the IMS startup JCL (for example, "OTMA=Y,GRNAME=&GROUP,USERVAR=&MEMBER",...). | This parameter is required if the LIKE keyword is not specified. | | | MAXI Specifies the OTMA input message flood control value. The valid range is 0 - 9999. | If you specify a value of 0, the OTMA default value of 5000 is used. | If you specify a value 1 - 200, the OTMA minimum value of 200 is used. | This parameter is optional and defaults to 5000. | | | | MEMBER Specifies the 1- to 8-character alphanumeric XCF member name that identifies IMS Connect in the XCF group that is specified by the GROUP parameter. | | | | This name is the XCF name that IMS uses to communicate with IMS Connect in that XCF group. This XCF member name for IMS Connect must be unique in the data store definitions for all data stores that are members of the same XCF group. | This parameter is required. | | | OAAV Specifies the decimal integer that defines the OTMA accessor environment element (ACEE) aging value, in seconds, for this IMS data store. | | | When the OTMA ACEE aging value is reached, OTMA refreshes the ACEE before it processes the next input message that is received from IMS Connect. | | | Valid values are 0 - 999999. If you specify 0, OTMA uses the default value of 999999. If you specify a value 1 - 300, OTMA uses a value of 300 seconds. | This parameter is optional and defaults to 999999. | | | | | RRNAME Specifies the 1- to 8-character alphanumeric name of the alternative destination of a client reroute request. The name can consist of alphanumeric characters (A – Z, 0 – 9) and special characters (@, #, $). IMS Connect translates lowercase characters to uppercase characters. This parameter is optional and defaults to HWS$DEF. | | | | SMEMBER Specifies the 1-4 character name of the OTMA super member to which this IMS data store belongs. | | | If specified, this value overrides the attribute values for the SMEMBER parameter in the HWS statement of the HWSCFGxx member of the IMS PROCLIB data set. 192 Commands, Volume 1: IMS Commands A - M | | To disable the value of SMEMBER specified on this IMS data store, specify the parameter with no value, for example, SMEMBER(). | This parameter is optional and defaults to blanks. | | | TMEMBER Specifies the 1- to 8-character alphanumeric XCF member name of the IMS that this IMS Connect communicates with in the XCF group. | | | | This target member name must match the member name that IMS uses when it joins the XCF group. The XCF member name for IMS is specified in the IMS startup JCL (for example, “...,OTMA=Y,GRNAME=&GROUP,OTMANM= &TMEMBER,...”). | This parameter is required if the LIKE keyword parameter is not specified. | Usage notes | | You can issue the CREATE IMSCON TYPE(DATASTORE) command only through the Operations Manager (OM) API. | | IMS Connect can process IMS Connect type-2 commands only if the IMSplex from which the commands were issued has a status of ACTIVE. | | When a keyword is specified without any value, that keyword is ignored. IMS Connect processes the command as if the keyword were not specified. | | | At the completion of the CREATE IMSCON TYPE(DATASTORE) command, IMS Connect starts the IMS data store and sets the IMS data store status to CONNECT if it is successful and DISCONNECT if it is not successful. | | IMS Connect resources that are modified by using this command are not saved across restarts of IMS Connect. | Equivalent WTOR and z/OS commands | | Equivalent WTOR and z/OS commands that perform similar functions as the CREATE IMSCON TYPE(DATASTORE) command are not available. | Output fields | | The following table shows the CREATE IMSCON TYPE(DATASTORE) output fields. The following is a list of the columns that are available in the table: | | Short label Contains the short label that is generated in the XML output. | | Long label Contains the column heading for the output field in the formatted output. | | | | Keyword Identifies the keyword on the command that caused the field to be generated. N/A is displayed for output fields that are always returned. For output fields that are returned only in case of an error, error is displayed. | | Meaning Provides a brief description of the output field. Chapter 19. CREATE commands 193 | Table 122. Output fields for the CREATE IMSCON TYPE(DATASTORE) command | Short label Long label Keyword Meaning | CC | | CC N/A Completion code that indicates whether IMS Connect was able to process the command for the specified resource. The completion code is always returned. | CCTXT | | CCText N/A Completion code text that briefly explains the meaning of the nonzero completion code. This field is returned only for an error completion code. | DS | DataStore N/A The data store name. The data store name is always returned. | MBR | | MbrName N/A Identifier of the IMS Connect that built the output line. The identifier is always returned. | Return, reason, and completion codes | | | | An IMS Connect return and reason code is returned to OM by the CREATE IMSCON TYPE(DATASTORE) command. The OM return and reason codes that might be returned as a result of the CREATE IMSCON TYPE(DATASTORE) command are standard for all commands that are entered through the OM API. | | | The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. | | Table 123. Return and reason codes for the CREATE IMSCON TYPE(DATASTORE) command | Return code Reason code Meaning | | | | X'00000000' X'00000000' The command completed successfully. The command output contains a line for each resource, which is accompanied by its completion code. See the completion codes table for details. | X'0C000008' X'00002010' Wildcards (* and %) are not supported. | X'0C000008' X'00002018' The required NAME parameter is not specified. | | X'0C000008' X'00002024' The LIKE keyword parameter value is invalid. The resource cannot be found. | X'0C000008' X'0000202C' The resource already exists. | X'0C000008' X'0000204C' The required GROUP parameter is not specified. | X'0C000008' X'00002050' The required MEMBER parameter is not specified. | X'0C000008' X'00002054' The required TMEMBER parameter is not specified. | | X'0C000008' X'0000207C' The MEMBER parameter value is a duplicate of an existing DATASTORE MEMBER value. | X'0C000008' X'00002133' Multiple NAME parameter values are not allowed. | | | | X'0C00000C' X'00003000' The command was successful for some resources but failed for others. The command output contains a line for each resource, which is accompanied by its completion code. | | | | | X'0C00000C' X'00003004' The command was not successful for any resource. The command output contains a line for each resource, which is accompanied by its completion code. 194 Commands, Volume 1: IMS Commands A - M | | | The following table includes an explanation of the completion codes. Errors unique to the processing of this command are returned as completion codes. A completion code is returned for each action against an individual resource. | Table 124. Completion codes for the CREATE IMSCON TYPE(DATASTORE) command | | Completion code | | | 0 | | 13 Completion code text Meaning The CREATE IMSCON TYPE(DATASTORE) command completed successfully. The resource already exists. The data store already exists. | Return, reason, and completion codes handled by OM | | | IMS Connect registers its type-2 command set with OM. When OM detects a command parsing error, OM returns a return code and reason code to the requester, and the command is not routed to IMS Connect. | | | Clients such as the TSO SPOC send commands to OM by using the CSLOMCMD API. CSLOMCMD return and reason codes are listed in the description of the CSLOMCMD request. | Examples | | The following are examples of the CREATE IMSCON TYPE(DATASTORE) command: | Example 1 for CREATE IMSCON TYPE(DATASTORE) command | | | TSO SPOC input: | | | TSO SPOC output: | | | OM API input: | | | | | | | | | | | | | | | | OM API output: CREATE IMSCON TYPE(DATASTORE) NAME(IMS2) SET(GROUP(XCFGRP1),MEMBER(ICON1),TMEMBER(IMS2)) DataStore MbrName IMS2 HWS1 CC 0 CMD(CRE IMSCON TYPE(DATASTORE) NAME(IMS2) SET(GROUP(XCFGRP1),MEMBER(ICON1),TMEMBER(IMS2))) <?xml version="1.0"?> <!DOCTYPE imsout SYSTEM "imsout.dtd"> <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.6.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2012.314 00:31:32.035293</statime> <stotime>2012.314 00:31:32.035883</stotime> <staseq>CA7155B83AADD297</staseq> <stoseq>CA7155B83AD2B797</stoseq> <rqsttkn1>USRT011 10163132</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> Chapter 19. CREATE commands 195 | | | | | | | | | | | | | | | | | | | | | | <cmd> <master>HWS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>IMSCON </kwd> <input>CREATE IMSCON TYPE(DATASTORE) NAME(IMS2) SET(GROUP(XCFGRP1),MEMBER(ICON1), TMEMBER(IMS2)) </input> </cmd> <cmdrsphdr> <hdr slbl="DS" llbl="DataStore" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> <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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>DS(IMS2 ) MBR(HWS1 ) CC( 0) </rsp> </cmdrspdata> </imsout> | Explanation: Data store IMS2 is created with the specified attributes. | Example 2 for CREATE IMSCON TYPE(DATASTORE) command | | | | TSO SPOC input: | | | TSO SPOC output: | | | | OM API input: | | | | | | | | | | | | | | | | | | | | | | OM API output: CREATE IMSCON TYPE(DATASTORE) NAME(IMS2) LIKE(IMS1) SET(GROUP(XCFGRP1),MEMBER(ICON1B),TMEMBER(IMS2),ACKTO(60), SMEMBER(SM02)) DataStore MbrName IMS2 HWS1 CC 0 CMD(CRE IMSCON TYPE(DATASTORE) NAME(IMS2) LIKE(IMS1) SET(GROUP(XCFGRP1),MEMBER(ICON1B),TMEMBER(IMS2),ACKTO(60), SMEMBER(SM02))) <?xml version="1.0"?> <!DOCTYPE imsout SYSTEM "imsout.dtd"> <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.6.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2012.314 00:55:31.481740</statime> <stotime>2012.314 00:55:31.482361</stotime> <staseq>CA715B14FE08C99D</staseq> <stoseq>CA715B14FE2F921D</stoseq> <rqsttkn1>USRT011 10165531</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>HWS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>IMSCON </kwd> <input>CREATE IMSCON TYPE(DATASTORE) NAME(IMS2) LIKE(IMS1) SET(GROUP(XCFGRP1), 196 Commands, Volume 1: IMS Commands A - M | | | | | | | | | | | | | | | | | MEMBER(ICON1B),TMEMBER(IMS2),ACKTO(60), SMEMBER(SM02)) </input> </cmd> <cmdrsphdr> <hdr slbl="DS" llbl="DataStore" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> <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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>DS(IMS2 ) MBR(HWS1 ) CC( 0) </rsp> </cmdrspdata> </imsout> | | | | Explanation: Data store IMS2 is created with the same attribute values as data store IMS1. However, the GROUP, MEMBER, TMEMBER, ACKTO, and SMEMBER attributes are also specified, and their values override the values from the IMS1 data store model. Related reference: | | CSLOMCMD: command request (System Programming APIs) | IMSPLEX statement (System Definition) | DATASTORE statement (System Definition) | CREATE IMSCON TYPE(PORT) command | | | Use the CREATE IMSCON TYPE(PORT) command to add IMS Connect port definitions during runtime processing without having to restart your IMS Connect instance. | The CREATE IMSCON TYPE(PORT) command is used to add a listening port. | Specifying PORTTYPE(REG) creates a regular listening port. | Specifying PORTTYPE(DRDA®) creates a DRDA listening port. | | Table 125. Type-2 CREATE IMSCON TYPE(PORT) command and HWSCFGxx member configuration equivalents | | Type-2 command | | CREATE IMSCON TYPE(PORT) PORTTYPE(REG) PORT= substatement of the TCPIP statement | | | CREATE IMSCON TYPE(PORT) PORTTYPE(DRDA) DRDAPORT= substatement of the ODACCESS statement | | | | Subsections: v “Environment” on page 198 | | v v v v Configuration for the HWSCFGxx member of the IMS PROCLIB data set “Syntax” on page 198 “Keywords” on page 198 “Usage notes” on page 200 “Equivalent WTOR and z/OS commands” on page 200 Chapter 19. CREATE commands 197 “Output fields” on page 200 “Return, reason, and completion codes” on page 201 “Return, reason, and completion codes handled by OM” on page 202 “Examples” on page 202 | | | | v v v v | Environment | | | | | | The CREATE IMSCON command is applicable only to IMS Connect. To issue this command, the following conditions must be satisfied: v IMS Connect must be active and configured to communicate with the Common Service Layer (CSL) Structured Call Interface (SCI). v A type-2 command environment with Structured Call Interface (SCI) and Operations Manager (OM) must be active. | Syntax | CREATE CRE IMSCON TYPE(PORT) A | A: | | , NAME( name , SET( ) LIKE(rsc_name) ) EDITRTN(exit_name) 0 KEEPAV( value ) 18000 PORTTMOT( value ) REG PORTTYPE( DRDA ) | | Keywords | | The following keywords are valid for the CREATE IMSCON TYPE(PORT) command: | | | | LIKE Specifies the existing IMS Connect port resource to use as a model. The new resource is created with all of the same attribute values as the specified model port resource. Attributes that are set explicitly by the CREATE IMSCON TYPE(PORT) command override the attribute values that are generated from the model. Later changes to the model are not propagated to resources that were created from it. | | | | | | | NAME Specifies the 1- to 5-character decimal field of the port number. Valid values are decimal numbers 1 - 65535. | | Port numbers must be unique for a specific instance of IMS Connect and must not conflict with other ports selected in the TCP/IP domain. | This parameter is required. 198 Commands, Volume 1: IMS Commands A - M | | SET Specifies the attributes of the port to be created. | | If the LIKE keyword is omitted, the required attributes must be specified. If an optional attribute is not specified, IMS Connect uses its default value. | | If the LIKE keyword is specified, the attribute values that are specified with the SET keyword override the values that are generated from the model. | | | EDITRTN Specifies the 1- to 8-character name of the IMS Connect Port Message Edit exit routine. | | | This parameter is equivalent to the EDIT parameter of the PORT substatement of the TCPIP statement of the HWSCFGxx member of the IMS PROCLIB data set. | | | The exit routine can modify messages that do not conform to the standard message formats for IMS Connect. The exit routine must be accessible to IMS Connect by JOBLIB, STEPLIB, or LinkList. | This parameter is optional and defaults to blanks. | | This parameter is valid only when the (PORTTYPE(REG)) keyword is specified. | | | KEEPAV Specifies the number of seconds for the z/OS TCP/IP KeepAlive interval for sockets on this port. TCP/IP accepts a range 1 - 2147460 seconds. | | | Use the TCP/IP KeepAlive function to detect error situations for inactive sockets. Specify the KEEPAV parameter to override the default TCP/IP KeepAlive interval value. | | | This parameter is optional and defaults to 0. If you specify 0, the KeepAlive interval value is bypassed, and the setting for the TCP/IP stack is used. | | PORTTMOT Specifies the numeric value of the DRDA port timeout value. | | | This value is the amount of time that IMS Connect waits for the next input message from a client application that is connected on a DRDA port before IMS Connect disconnects the client. | | The timeout interval is specified as a decimal integer in hundredths of a second. Valid values are 0 - 2,147,483,647 (X’7FFFFFFF’). | Specifying a value of 0 disables the timeout function. | This parameter is optional and defaults to 6000 (1 minute). | | This parameter is valid only when the PORTTYPE(DRDA) keyword is specified. | | PORTTYPE Specifies the type of port. | This keyword is optional and defaults to PORTTYPE(REG). | | | DRDA Indicates that this port is being created for listening to DRDA messages. Chapter 19. CREATE commands 199 Specifying this parameter is equivalent to creating a port by defining the DRDAPORT substatement in the ODACCESS statement of the HWSCFGxx member of the IMS PROCLIB data set. | | | | | | REG Indicates that this port is being created for listening to regular IMS Connect client messages. Specifying this parameter is equivalent to creating a port by defining the PORT substatement in the TCPIP statement of the HWSCFGxx member of the IMS PROCLIB data set. | | | | Usage notes | | You can issue the CREATE IMSCON TYPE(PORT) command only through the Operations Manager (OM) API. | | IMS Connect can process IMS Connect type-2 commands only if the IMSplex from which the commands were issued has a status of ACTIVE. | | | | | | | | | | When a keyword is specified without any value, that keyword is ignored. IMS Connect processes the command as if the keyword were not specified. The following command examples are valid: v CREATE IMSCON TYPE(PORT) NAME(1111) SET() | | | At the completion of the CREATE IMSCON TYPE(PORT) command, IMS Connect starts the port and sets the port status to ACTIVE if it is successful and NOT ACTIVE if it is not successful. | | | | | If TCP/IP is up, at the successful completion of the CREATE IMSCON TYPE(PORT) command, IMS Connect issues a HWSS0790I message to the system console. If TCP/IP is down, at the successful completion of the CREATE IMSCON TYPE(PORT) command, IMS Connect issues a HWSS0771W message to the system console. | | IMS Connect resources that are modified by using this command are not saved across restarts of IMS Connect. | Equivalent WTOR and z/OS commands | | Equivalent WTOR and z/OS commands that perform similar functions as the CREATE IMSCON TYPE(PORT) command are not available. | Output fields | | The following table shows the CREATE IMSCON TYPE(PORT) output fields. The following is a list of the columns that are available in the table: | | Short label Contains the short label that is generated in the XML output. None of the SET attribute keywords are required, so the command is processed as if it were CREATE IMSCON TYPE(PORT) NAME(1111). v CREATE IMSCON TYPE(PORT) NAME(2222) SET(KEEPAV()) The command is processed as if it were CREATE IMSCON TYPE(PORT) NAME(2222). v CREATE IMSCON TYPE(PORT) NAME(3333) LIKE() The command is processed as if it were CREATE IMSCON TYPE(PORT) NAME(3333). 200 Commands, Volume 1: IMS Commands A - M | | Long label Contains the column heading for the output field in the formatted output. | | | | Keyword Identifies the keyword on the command that caused the field to be generated. N/A is displayed for output fields that are always returned. For output fields that are returned only in case of an error, error is displayed. | | Meaning Provides a brief description of the output field. | Table 126. Output fields for the CREATE IMSCON TYPE(PORT) command | Short label Long label Keyword Meaning | | | CC CC N/A Completion code that indicates whether IMS Connect was able to process the command for the specified resource. The completion code is always returned. | | | CCTXT CCText N/A Completion code text that briefly explains the meaning of the nonzero completion code. This field is returned only for an error completion code. | | MBR MbrName N/A Identifier of the IMS Connect that built the output line. The identifier is always returned. | | PORT Port N/A The port number. The port number is always returned. | Return, reason, and completion codes | | | | An IMS Connect return and reason code is returned to OM by the CREATE IMSCON TYPE(PORT) command. The OM return and reason codes that might be returned as a result of the CREATE IMSCON TYPE(PORT) command are standard for all commands that are entered through the OM API. | | | The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. | Table 127. Return and reason codes for the CREATE IMSCON TYPE(PORT) command | Return code Reason code Meaning | | | | X'00000000' X'00000000' The command completed successfully. The command output contains a line for each resource, which is accompanied by its completion code. See the completion codes table for details. | | X’0C000008’ X'00002004' The command contains an invalid primary keyword or no client is registered for the keyword. | X’0C000008’ X’00002010’ Wildcards (* and %) are not supported. | | X’0C000008’ X’00002024’ The LIKE keyword parameter value is invalid. The resource cannot be found. | | X’0C000008’ X’00002028’ The LIKE keyword parameter value cannot be an SSL port. | | X’0C000008’ X’00002058’ IMS Connect could not load the Port Message Edit exit routine. | | X’0C000008’ X’00002084’ The EDITRTN keyword is invalid for PORTTYPE(DRDA). | | X’0C000008’ X’00002088’ The PORTTMOT keyword is invalid for PORTTYPE(REG). Chapter 19. CREATE commands 201 | | Table 127. Return and reason codes for the CREATE IMSCON TYPE(PORT) command (continued) | Return code Reason code Meaning | | | | X’0C00000C’ X’00003000’ The command was successful for some resources but failed for others. The command output contains a line for each resource, which is accompanied by its completion code. | | | | | X’0C00000C’ X’00003004’ The command was not successful for any resource. The command output contains a line for each resource, which is accompanied by its completion code. | | | The following table includes an explanation of the completion codes. Errors unique to the processing of this command are returned as completion codes. A completion code is returned for each action against an individual resource. | Table 128. Completion codes for the CREATE IMSCON TYPE(PORT) command | | Completion code | | 0 | | 13 Completion code text Meaning The CREATE IMSCON TYPE(PORT) command completed successfully. The resource already exists. The port already exists. | Return, reason, and completion codes handled by OM | | | IMS Connect registers its type-2 command set with OM. When OM detects a command parsing error, OM returns a return code and reason code to the requester, and the command is not routed to IMS Connect. | | | Clients such as the TSO SPOC send commands to OM by using the CSLOMCMD API. CSLOMCMD return and reason codes are listed in the description of the CSLOMCMD request. | Examples | The following are examples of the CREATE IMSCON TYPE(PORT) command: | Example 1 for CREATE IMSCON TYPE(PORT) command | | | TSO SPOC input: | | | TSO SPOC output: | | | OM API input: | OM API output: CREATE IMSCON TYPE(PORT) NAME(8888) SET(EDITRTN(HWSEDIT0),KEEPAV(120)) Port 8888 MbrName HWS1 CC 0 CMD(CRE IMSCON TYPE(PORT) NAME(8888) SET(EDITRTN(HWSEDIT0),KEEPAV(120))) 202 Commands, Volume 1: IMS Commands A - M | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | <?xml version="1.0"?> <!DOCTYPE imsout SYSTEM "imsout.dtd"> <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.6.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2012.314 16:51:36.534771</statime> <stotime>2012.314 16:51:36.535211</stotime> <staseq>CA723167E3C4711B</staseq> <stoseq>CA7231682AD21F14</stoseq> <rqsttkn1>USRT011 10085423</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>HWS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>IMSCON </kwd> <input>CREATE IMSCON TYPE(PORT) NAME(8888) SET(EDITRTN(HWSEDIT0),KEEPAV(120)) </input> </cmd> <cmdrsphdr> <hdr slbl="PORT" llbl="Port" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> <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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>PORT(8888 ) MBR(HWS1 ) CC( 0) </rsp> </cmdrspdata> </imsout> | | Explanation: Regular port 8888 is created with the EDITRTN and KEEPAV attributes specified. | Example 2 for CREATE IMSCON TYPE(PORT) command | | | TSO SPOC input: | | | TSO SPOC output: | | | OM API input: | | | | | | | | | | | | OM API output: CREATE IMSCON TYPE(PORT) NAME(8888) LIKE(9999) SET(EDITRTN(HWSEDIT0)) Port 8888 MbrName HWS1 CC 0 CMD(CRE IMSCON TYPE(PORT) NAME(8888) LIKE(9999) SET(EDITRTN(HWSEDIT0))) <?xml version="1.0"?> <!DOCTYPE imsout SYSTEM "imsout.dtd"> <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.6.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2012.314 17:20:25.453406</statime> <stotime>2012.314 17:20:25.535260</stotime> <staseq>CA7237396535EC18</staseq> <stoseq>CA7237397931C697</stoseq> Chapter 19. CREATE commands 203 | | | | | | | | | | | | | | | | | | | | | | | | | <rqsttkn1>USRT011 10092025</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>HWS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>IMSCON </kwd> <input>CREATE IMSCON TYPE(PORT) NAME(8888) LIKE(9999) SET(EDITRTN(HWSEDIT0)) </input> </cmd> <cmdrsphdr> <hdr slbl="PORT" llbl="Port" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> <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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>PORT(8888 ) MBR(HWS1 ) CC( 0) </rsp> </cmdrspdata> </imsout> | | | Explanation: Regular port 8888 is created with the same attributes as port 9999. However, the EDITRTN attribute is also specified, and its values override the values from the 9999 port model. | Example 3 for CREATE IMSCON TYPE(PORT) command | | | TSO SPOC input: | | | | TSO SPOC output: | | | OM API input: | | | | | | | | | | | | | | | | | | | | OM API output: CREATE IMSCON TYPE(PORT) NAME(8888,9999) SET(PORTTYPE(DRDA)) Port 8888 9999 MbrName HWS1 HWS1 CC CCText 0 13 Resource already exists CMD(CRE IMSCON TYPE(PORT) NAME(8888,9999) SET(PORTTYPE(DRDA))) <?xml version="1.0"?> <!DOCTYPE imsout SYSTEM "imsout.dtd"> <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.6.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2012.314 17:30:09.273414</statime> <stotime>2012.314 17:30:09.277816</stotime> <staseq>CA7239662B64659E</staseq> <stoseq>CA7239662C778D9C</stoseq> <rqsttkn1>USRT011 10093009</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="HWS1 "> 204 Commands, Volume 1: IMS Commands A - M | | | | | | | | | | | | | | | | | | | | | | | | | | | | | <typ>IMSCON </typ> <rc>0C00000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful </rsntxt> </mbr> </cmderr> <cmd> <master>HWS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>IMSCON </kwd> <input>CREATE IMSCON TYPE(PORT) NAME(8888,9999) SET(PORTTYPE(DRDA)) </input> </cmd> <cmdrsphdr> <hdr slbl="PORT" llbl="Port" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" skipb="no" /> <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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>PORT(8888 ) MBR(HWS1 ) CC( 0) </rsp> <rsp>PORT(9999 ) MBR(HWS1 ) CC( 13) CCTXT(Resource already exists) </rsp> </cmdrspdata> </imsout> | | | Explanation: DRDA port 8888 is created without any attribute overrides. DRDA port 9999 is not created and returns completion code 13, which indicates that port 9999 already exists. Related reference: | | CSLOMCMD: command request (System Programming APIs) | IMS Connect Port Message Edit exit routine (Exit Routines) | IMSPLEX statement (System Definition) | ODACCESS statement (System Definition) | TCPIP statement (System Definition) CREATE OTMADESC command Use the CREATE OTMADESC command to create a OTMA destination descriptor without restarting IMS. Subsections: v “Environment” on page 206 v “Syntax” on page 206 v “Keywords” on page 207 v “Usage notes” on page 211 v “Output fields” on page 211 v “Return, reason, and completion codes” on page 212 v “Examples” on page 214 Chapter 19. CREATE commands 205 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the commands and keywords. Table 129. Valid environments for the CREATE OTMADESC command and keywords Command / Keywords DB/DC DBCTL DCCTL CREATE OTMADESC X X NAME X X SET X X Syntax | | | , | | CREATE CRE OTMADESC NAME( TYPE(IMSCON) destname* ) A SET( ) TYPE(IMSTRAN) TYPE(MQSERIES) TYPE(NONOTMA) B C EXIT( N Y ) | A (TYPE=IMSCON): | | | SMEM(N) TMEMBER(tmem) SMEM(Y) TPIPE(tpipename) | | | | | | SYNTIMER(syntimer) ADAPTER(adaptername) CONVRTR(convertrname) RMTIMSCON(rmtimsconnect) RMTIMS(remote_IMS) RMTTRAN(trancode) USERID(user_id) | B (TYPE=IMSTRAN): | | | TMEMBER(tmem) | | TPIPE(tpipename) LTERMOVR(ltermname) REPLYCHK( Y N ) | 206 Commands, Volume 1: IMS Commands A - M SMEM( N Y SYNTIMER(timeout value) ) | C (TYPE=MQSERIES): | | TMEMBER(tmem) TPIPE(tpipename) MQREPORT( | | COPYMTOC NEWMSGID PASSMSG1 PASSCORR NONE ) USERID(userid) MQFORMAT( | | | | | | | | MQIMSVS MQIMS NONE ) MQRTF(mqmd_replytoformatname) MQMSGID(mqmd_msgid) MQRTQ(mqmd_replytoqueuename) MQCORREL(mqmd_correlid) MQRTQMGR(mqmd_replytoqueuemgrname) MQCOPYMD( Y N ) SYNCTP( N Y MQAPPLID(mqmd_appidentitydata) ) MQPERST( N Y ) | | Keywords The following keywords are valid for the CREATE OTMADESC command: ADAPTER(adaptername) An optional keyword for TYPE(IMSCON). The adaptername is a 1- to 8-character name that identifies the IMS Connect adapter. If TYPE(NONOTMA) is specified, you cannot specify this keyword. CONVRTR(convertrname) A required parameter only if the ADAPTER keyword is specified. The convertrname is a 1- to 8-character converter name used by the adapter. Coding this keyword without the ADAPTER keyword or with TYPE(NONOTMA) will cause an error. | | | | EXIT(N|Y) When TYPE=IMSTRAN, this is an optional parameter used to indicate whether the IMS user exit (DFSCMUX0) can override the descriptor routing information for late messages. | | | For other descriptor types, this is an optional parameter used to specify whether the OTMA routing exits (DFSYPRX0 and DFYDRU0) can override the descriptor switch destination from ALT IOPCB. | | | | | | | | LTERMOVR(ltermname) When TYPE=IMSTRAN, this is an optional parameter used to specify a logical terminal name that overrides the name specified in the application I/O PCB. If an override name is also specified in the AIBRSNM2 field of the AIB, that name is used instead of the name in the descriptor. If neither the descriptor or the AIB contains an override name, the IMS application terminal symbolic (PSTSYMBO) is used as the default logical terminal name for the target transaction. Chapter 19. CREATE commands 207 | | | | | MQAPPLID(mqmd_appidentitydata) When TYPE=MQSERIES, this is an optional parameter that specifies a 1- to 32-character value for the MQMD_APPLIDENTITYDATA field. This field is used to pass data to the receiving WebSphere® MQ application. The default is 32 blanks. | | | | MQCOPYMD(Y | N) When TYPE=MQSERIES, this is an optional parameter that specifies whether the original input values of the MQMD data structure from the MQ IMS Bridge are copied to the output message. | | | | | MQCORREL(mqmd_correlid) When TYPE=MQSERIES, this is an optional parameter that specifies a 1- to 24-character value for the MQMD_CORRELID field. This value is passed directly to the receiving WebSphere MQ application if the value of the MQREPORT parameter is PASSCORR. The default is 0. | | | MQFORMAT(MQIMSVS | MQIMS | NONE) When TYPE=MQSERIES, this is an optional parameter that specifies value for the MQMD_FORMAT field. The default value is MQIMSVS. | | | | | MQMSGID(mqmd_msgid) When TYPE=MQSERIES, this is an optional parameter that specifies a 1- to 24-character value for the MQMD_MSGID field. This value is passed directly to the receiving WebSphere MQ application if the value of the MQREPORT parameter is PASSMSG1. | | | | | MQPERST(N | Y) When TYPE=MQSERIES, this is an optional parameter that specifies whether messages that use this descriptor are persistent on a SYNC TPIPE. Setting this parameter to Y is analogous to setting X’40’ for the output flag value of the DFSYDRU0 exit routine. | | | | | MQREPORT(COPYMTOC | NEWMSGID | PASSMSG1 | PASSCORR | NONE) When TYPE=MQSERIES, this is an optional parameter that specifies the MQMD_REPORT field value for messages that use the descriptor. The default value is COPYMTOC. Each supported value corresponds to an equivalent value in the MQMD data structure: | | Parameter value Equivalent MQMD structure value | | NEWMSGID MQRO_NEW_MSG_ID | | PASSMSGI MQRO_PASS_MSG_ID | | COPYMTOC MQRO_COPY_MSG_ID_TO_CORREL_ID | | PASSCORR MQRO_PASS_CORREL_ID | | PASSMSCO MQRO_PASS_MSG_ID and MQRO_PASS_CORREL_ID | | NONE MQRO_NONE | | | MQRTF(mqmd_replytoformat) When TYPE=MQSERIES, this is a 1- to 8-character value for the MQMD_REPLYTOFORMAT field. The default is 0. 208 Commands, Volume 1: IMS Commands A - M | | | MQRTQ(mqmd_replytoqueuename) When TYPE=MQSERIES, this is a required parameter that specifies a 1- to 48-character value for the MQMD_REPLYTOQ field. | | | | MQRTQMGR(mqmd_replytoqueuemanagername) When TYPE=MQSERIES, this is an optional parameter that specifies a 1- to 48-character value for the MQMD_REPLYTOQMGR field. If this parameter is not specified, MQSeries® will use the local queue manager. NAME(destname*) A required keyword parameter that specifies a 1- to 8-character destination name. The destination name can have an asterisk (*) at the end to mask groups of names. An asterisk by itself is a valid name and is an entry in the table of destination routing descriptors. A masked name that encompasses another masked name does not have to be created in the order from most specific to most generic. However, the search order starts from the most specific to the most generic. Creating a destination name that already exists in the system is an error. | | | | | | REPLYCHK(Y|N) Specifies whether an IMS application replies to the IOPCB for a synchronous program switch request. When REPLYCHK=YES and the ICAL target application does not reply to the IOPCB or switch to another transaction, IMS gives the error return code X’0100’, with reason code X’0110’, and extended reason code X’0014’ instead of a timeout to the ICAL call. The default is Y. RMTIMS An optional 1- to 8-character name of a remote, destination IMS system for ALTPCB output messages. When RMTIMS is specified, you must also specify the RMTIMSCON parameter. The RMTIMS value must match the value specified on the ID parameter of a DATASTORE statement in the configuration member of the remote IMS Connect instance. This parameter is valid only when TYPE(IMSCON) is specified. RMTIMSCON An optional 1- to 8-character name of a connection to a remote IMS Connect instance, as defined on ID parameter of the RMTIMSCON statement in the HWSCFGxx PROCLIB member of the local IMS Connect. When RMTIMSCON is specified, you must also specify RMTIMS. This parameter is valid only when TYPE(IMSCON) is specified. RMTTRAN An optional 1- to 8-character name of the transaction to use at the remote, destination IMS system. When this parameter is specified with RMTIMSCON and RMTIMS parameters, OTMA passes the transaction code to IMS Connect, which inserts it into the outgoing message. This parameter is valid only when TYPE(IMSCON) is specified. SMEM(N | Y) An optional parameter that can either be a Y or N value to indicate whether the TMEMBER name specified in the TMEMBER parameter is a super member. If the TMEMBER name is a super member, the length of the TMEMBER name has a maximum of 4 characters. SMEM and TYPE(NONOTMA) are mutually exclusive. | | SYNCTP(N | Y) When TYPE=MQSERIES, this parameter specifies whether a SYNC TPIPE must Chapter 19. CREATE commands 209 be created for messages that use this descriptor. Setting this parameter to Y is analogous to setting X’80’ for the output flag value of the DFSYDRU0 exit routine. | | | SYNTIMER(syntimer) An optional parameter that specifies the timeout value that when reached, the synchronous callout reply expires because an ACK/NAK or reply from the client has not been received. The value syntimer, which is expressed in hundredths of a second, must be numeric and within a range of 0 through 999999, inclusive. When the parameter is coded, a numeric value must be specified. If SYNTIMER(0) is specified, the value defaults to 1000, which is equivalent to 10 seconds. If TYPE(IMSTRAN) is specified, this parameter is the timeout value for synchronous program switch ICAL calls. If a timeout value is also specified in the AIB interface, IMS will compare the timeout values and use the lower value. | | | | TMEMBER(tmem) A required parameter for TYPE(IMSCON). The tmem value is a 1- to 16-character OTMA TMEMBER name. Coding this keyword with TYPE(NONOTMA) causes an error. If SMEM(Y) is specified, tmem is a maximum of 4-character super member name. An optional parameter for TYPE(IMSTRAN). The tmem value is a 1- to 16-character OTMA TMEMBER name. IMS queues late responses from a synchronous program switch to this OTMA TMEMBER. The destination name is used as the default OTMA TPIPE name if the TPIPE parameter is not specified in the descriptor. | | | | | TPIPE(tpipename) An optional parameter that is a 1- to 8-character TPIPE name when TYPE(IMSCON) is specified. If this keyword is not coded, the TPIPE name is the destination name specified in the NAME keyword. This keyword is not valid if TYPE(NONOTMA) is specified. If the TPIPE is not coded and the NAME is a mask, the TPIPE will be a specific destination name that matched the mask in the table of destination routing descriptors and not the NAME keyword. An optional parameter for TYPE(IMSTRAN) that specifies a 1- to 8-character TPIPE name. This parameter defaults to the destination name. IMS queues late responses from a synchronous program switch to this OTMA TPIPE. A value for the TMEMBER parameter is required when TPIPE is specified. | | | | | | TYPE(IMSCON | IMSTRAN | MQSERIES | NONOTMA) Specifies the type of destination: | | IMSCON An IMS Connect client. This is the default value. | | IMSTRAN An IMS transaction. | | MQSERIES WebSphere MQ. | | | NONOTMA A non-OTMA destination. Only the EXIT parameter is valid with this descriptor type. USERID(userid) For TYPE=IMSCON, this is an optional 1- to 8-character RACF user ID. When 210 Commands, Volume 1: IMS Commands A - M this parameter is specified with RMTIMSCON, RMTTRAN, and RMTIMS parameters, a remote, destination IMS system uses the USERID value to perform transaction authorization. The value of USERID specified in the OTMA destination descriptor overrides the user ID provided by the IMS application program that issued the ISRT call to the OTMA ALTPCB. This parameter is valid only when TYPE(IMSCON) is specified. | | | | | For TYPE=MQSERIES, this is a 1- to 8-character user ID that corresponds with the MQMD_USERIDENTIFIER field in the MQMD data structure. This field allows the OTMA descriptor to override the default user ID in the MQMD structure. Specify the value *USERID* to use the IMS user ID value from the PST. Usage notes The CREATE OTMADESC command is used to facilitate the creation of OTMA destination descriptors while IMS is up and running. The user can add new routing descriptors dynamically in addition to the statically defined destination routing descriptors in DFSYDTx of IMS.PROCLIB. The order in which the destination routing descriptors are coded is unrestricted and need not be coded in the order from most specific to most generic destination routing descriptor name. However, the search order in the table of destination routing descriptors will be performed from most specific to most generic. Note: Note the distinction between the coding in DFSYDTx and the search order that is performed internally in the table of destination routing descriptors. In DFSYDTx, the rule of coding does not require the order from most specific to most generic; however, the search order in the table of destination routing descriptor is performed from most specific to most generic. The destination routing descriptors are part of the checkpoint records used for persistency on IMS restart. Also, all CREATE OTMADESC commands will generate log records. The checkpoint log record is X4035 and the log record for CREATE, DELETE, and UPDATE is X221B. During an IMS warm restart, the destination routing descriptors will be rebuilt based on the checkpoint records. In case of an ERE restart, the log records will be used to completely rebuild the destination routing descriptors after the checkpoint records have been processed. Because of the rebuilding process, the routing descriptors in member DFSYDTx in PROCLIB will not be read and processed. However, during cold start processing, the routing descriptors in member DFSYDTx will be read and processed. The CREATE OTMADESC command is not valid in an XRF alternate, RSR tracking, or an FDBR region environment. The checkpoint and log records will be used to update the destination routing descriptors in these environments. The CREATE OTMADESC command becomes a valid command only when the XRF alternate or the RSR tracking environment becomes the active IMS environment. Output fields The following table shows the CREATE OTMADESC output fields. The columns in the table are: Short label Contains the short label generated in the XML output. Long label Contains the column heading for the output field in the formatted output. Chapter 19. CREATE commands 211 Keyword Identifies the keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 130. Output fields for the CREATE OTMADESC command Short label Long label Keyword Meaning CC CC N/A Completion code for the line of output. The completion code indicates whether IMS was able to process the command for the specified resource. See “Return, reason, and completion codes” for more information. The completion code is always returned. CCTXT CCText N/A Completion code text that briefly explains the meaning of the non-zero completion code. This field is returned only for an error completion code. DEST DestName NAME Destination name. MBR MbrName N/A Member name. Return, reason, and completion codes An IMS return and reason code is returned to OM by the CREATE OTMADESC command. The OM return and reason codes that might be returned as a result of the CREATE OTMADESC command are standard for all commands entered through the OM API. The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 131. Return and reason codes for the CREATE OTMADESC command 212 Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. See the completion codes table for details. X'02000008' X'00002000' The command contains an invalid verb or no client is registered for the verb. X'02000008' X'00002004' The command contains an invalid primary keyword or no client is registered for the keyword. X'02000008' X'00002028' The command contains an invalid keyword. X'02000008' X'0000202C' The command contains an unknown positional parameter. X'02000008' X'00002034' The command contains an incomplete keyword parameter. X'02000008' X'00002038' The command is missing a required parameter. X'02000008' X'0000203C' The command contains an invalid keyword parameter value. Commands, Volume 1: IMS Commands A - M The following table includes an explanation of the completion codes. Errors unique to the processing of this command are returned as completion codes. A completion code is returned for each action against an individual resource. Table 132. Completion codes for the CREATE OTMADESC command Completion code Completion code text Meaning 0 Command completed successfully The CREATE OTMADESC command completed successfully for the resource. 153 Adapter blank, Convrtr not blank Both ADAPTER() and CONVRTR() keywords must be either both blanks or both contain valid names. 154 Adapter not blank, Convrtr blank Both ADAPTER() and CONVRTR() keywords must be either both blanks or both contain valid names. 155 NONOTMA, other parms specified For TYPE(NONOTMA), no other keywords must be specified, such as TYPE(), TMEMBER(), SMEM(), ADAPTER(), or CONVRTR(). 156 SMEM(Y), super mbr name > 4 char For SMEM(Y), the TMEMBER value must not be greater than 4 characters. 157 SMEM(Y), Tmember parm not specfd 159 TMEMBER is required for IMSCON For TYPE(IMSCON), a value for the TMEMBER keyword is required and must be specified. 162 Descriptor already exist in tbl The descriptor being created already exists in the table of destination routing descriptors. 167 SYNTIMER must have numeric value The timeout value must have a value expressed in numbers within parenthesis. 169 SYNTIMER has nonnumeric value The value must not contain alphabetic characters or any character that is not numeric. 16A RmtIMSCon blank, RmtIMS not blank The RMTIMS and RMTIMSCON keywords were specified on the CREATE OTMADESC command, but no value was entered for RMTIMSCON. When a value is specified on the RMTIMS keyword, a value must also be specified on the RMTIMSCON keyword. 16B RmtIMSCon not blank, RmtIMS blank The RMTIMS and RMTIMSCON keywords were specified on the CREATE OTMADESC command, but no value was entered for RMTIMS. When a value is specified on the RMTIMSCON keyword, a value must also be specified on the RMTIMS keyword. The TMEMBER keyword is a required parameter when SMEM(Y) is specified. Chapter 19. CREATE commands 213 Examples The following are examples of the CREATE OTMADESC command: Example 1 for CREATE OTMADESC command TSO SPOC input: CREATE OTMADESC NAME(OTMACL*) SET(TYPE(IMSCON) TMEMBER(HWS2)) TSO SPOC output: DestName OTMACL* MbrName IMSA CC 0 Explanation: In the example, the CREATE OTMADESC command is issued with NAME(OTMACL*) and the descriptor OTMACL* is included in the table of destination routing descriptors. Example 2 for CREATE OTMADESC command TSO SPOC input: CREATE OTMADESC NAME(OTMACL99) SET(TYPE(IMSCON) TMEMBER(HWS1) TPIPE(HWS1TP01)) TSO SPOC output: DestName OTMACL99 MbrName IMSA CC 0 Explanation: If the CREATE OTMADESC command is issued with the TPIPE keyword, the descriptor OTMACL99 is included in the table of destination routing descriptors. Although not shown in the example, a CREATE command issued for OTMACL* would be ahead of the CREATE for OTMACL99. Example 3 for CREATE OTMADESC command TSO SPOC input: CREATE OTMADESC NAME(OTMACL01) SET(TYPE(IMSCON) TMEMBER(ICON1) RMTIMSCON(ICON2) RMTIMS(IMS2) RMTTRAN(TRAN01) USERID(USER01)) TSO SPOC output: DestName OTMACL01 MbrName IMS1 CC 0 Explanation: The CREATE OTMADESC command shown in this example creates an OTMA destination descriptor called OTMACL01 that routes ALTPCB output messages to a remote IMS system via a TCP/IP connection between two instances of IMS Connect. The command also defines the following values on the OTMA destination descriptor: v The local instance of IMS Connect, as specified by TMEMBER(ICON1). v The remote IMS Connect connection, as specified by RMTIMSCON(ICON2) in the local IMS Connect configuration member. This value is also specified on the ID parameter of the RMTIMSCON configuration statement of the local IMS Connect instance. v The remote IMS system, as specified by RMTIMS(IMS2). v The transaction to schedule at the remote IMS system, as specified by RMTTRAN(TRAN01). 214 Commands, Volume 1: IMS Commands A - M v The user ID to be used for transaction authorization at the remote IMS system, as specified by USERID(USER01). When the OTMA messages reach IMS2, IMS2 schedules TRAN01 to process the messages. The descriptor OTMACL01 is included in the table of destination routing descriptors. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related tasks: Specifying a remote transaction code (Communications and Connections) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 CREATE PGM command Use the CREATE PGM command to define the program resource requirements for application programs that run under the control of the DB/TM environment, as well as for application programs that access databases through DBCTL. The program resource describes an application program that operates in a message processing region, Fast Path message-driven program region, batch processing region, batch message processing region, or CCTL threads. Program resources combined with transactions define the scheduling and resource requirements for a message-driven application program. Subsections: v “Environment” v “Syntax” on page 216 v v v v v “Keywords” on page 216 “Usage notes” on page 220 “Output fields” on page 221 “Return, reason, and completion codes” on page 221 “Examples” on page 223 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 133. Valid environments for the CREATE PGM command and keywords Command / Keywords DB/DC DBCTL DCCTL CREATE PGM X X X LIKE X X X NAME X X X SET X X X Chapter 19. CREATE commands 215 Syntax , CREATE CRE PGM NAME( name ) LIKE( DESC(descriptor_name) RSC(resource_name) ) , SET( N BMPTYPE( Y ) N DOPT( Y ) N FP( E ) N GPSB( Y ) LANG( ASSEM ) COBOL JAVA PASCAL PLI N RESIDENT( Y ) PARALLEL SCHDTYPE( SERIAL N TRANSTAT( Y ) ) ) Default values shown in this syntax diagram reflect the default values that are defined in the IMS program descriptor, DFSDSPG1. If you define another descriptor as the default with a CREATE or UPDATE PGMDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE PGM command: LIKE Specifies that the resource is created using an existing resource or descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DFSDSPG1, or user-defined. The model type can either be a descriptor (DESC), or a resource (RSC). The new resource is created with all the same attributes as the model. Attributes set explicitly by the CREATE command override the model attributes. Later changes to the model are not propagated to resources or descriptors that were created from it. The QUERY commands can be used to display the model name and model type used to create the resource. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition, including the model name and model type, to the definition member. The IMPORT command imports a resource definition, including the model name and model type, from the definition 216 Commands, Volume 1: IMS Commands A - M member. An IMPORT command that creates a resource saves the model name and model type, but does not use the models attributes. DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this resource. RSC(resource_name) Specifies the name of the resource to use as a model to define this resource. NAME Specifies the 1-8 character name of the program. Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). All program names must begin with an alphabetic character (A through Z, #, $, and @) followed by zero to seven alphanumeric characters. Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin with DFS, except for DFSIVPxx and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBF#FPU0, DBRC, ISCEDT, MSDB, SDB, or WTOR. Each local program name must be unique. If the program is defined with BMPTYPE(N) and FP(N), the program name and associated PSB name must be the same. A program resource and a program descriptor can have the same name. SET Specifies the attributes of the program to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either IMS descriptor DFSDSPG1 or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. BMPTYPE() BMP type option. Specifies whether the program executes in a BMP type region or not. A BMP type region can be a BMP region or a JBP region. PSBs scheduled by DB2® stored procedures, by programs running under WebSphere Application Server, and by other users of the ODBA interface may be defined with BMPTYPE Y or N. N The program does not execute in a BMP type region. It might execute in an IMS TM MPP, JMP, or IFP region or it might use either the ODBA or DRA interface. This specification should be used for programs running in IMS TM MPP, JMP, and IFP regions, or PSBs scheduled by CICS® programs using DBCTL and other users of the DRA interface. This is the default. Y The program executes in a BMP type region. It might execute in an IMS BMP region or a JBP region. Any associated transactions are assigned normal and limit priority values of zero. FP(E) and BMPTYPE(Y) are mutually exclusive. DOPT Specifies the dynamic option. N The PSB associated with the program is not to be located dynamically. The PSB must exist in ACBLIB, otherwise the program is set to a NOTINIT status and cannot be scheduled. This is the default. Y The PSB associated with this program is located dynamically. Each time the program associated with this PSB is scheduled, the latest copy of the PSB is loaded from ACBLIB. The PSB does not need to be in any Chapter 19. CREATE commands 217 data set defined for ACBLIB until it is actually required to process a transaction. A new version of the PSB can be defined in ACBLIB and is picked up the next time the PSB is scheduled. DOPT PSBs referencing DBDs that are missing from ACBLIB cannot be scheduled. When the program terminates, the PSB is deleted from the PSB pool. Keyword combination rules include the following: v DOPT(Y) and GPSB(Y) are mutually exclusive. v DOPT(Y) and LANG(JAVA) is a valid combination. v v v v LANG is invalid with GPSB(N), except if DOPT(Y) and LANG(JAVA). LANG(JAVA), DOPT(Y), and GPSB(N) is a valid combination. RESIDENT(Y) and DOPT(Y) are mutually exclusive. SCHDTYPE(PARALLEL) and DOPT(Y) are mutually exclusive. FP Specifies the Fast Path option. E The program is a Fast Path-exclusive program. This implicitly defines a wait-for-input (WFI) program. Either a transaction or a routing code that can be assigned by the user Input Edit/Routing exit routine must be defined for the Fast Path-exclusive program, in order for this program to be usable. Fast Path must be defined in the IMS system. N The program is not a Fast Path-exclusive program. This is the default. When FP(N) is specified, any attempt to use Fast Path resources or commands will yield unpredictable results. Keyword combination rules include the following: v FP(E) requires that Fast Path be defined. v LANG(JAVA) and FP(E) are mutually exclusive. v BMPTYPE(N) and FP(E) are mutually exclusive. GPSB Specifies the generated PSB option. N Use N to specify that the PSB associated with the program is not generated by IMS. The PSB must exist in ACBLIB, otherwise the program is set to a NOTINIT status and cannot be scheduled. This is the default. Y Use Y to specify that the PSB associated with the program is generated by IMS. It is not loaded from ACBLIB. The scheduling process of all environments generates a PSB containing an I/O PCB and an alternate modifiable PCB. You do not need to perform the PSBGEN and ACBGEN. The generated PSB contains an I/O PCB named IOPCBbbb and a modifiable, alternate PCB named TPPCB1bb. With an alternate modifiable PCB, an application can use the CHNG call to change the output destination and send output to a destination other than the input destination. Keyword combination rules include the following: v DOPT(Y) and GPSB(Y) are mutually exclusive. v DOPT(Y) and LANG(JAVA) is a valid combination. v GPSB(Y) requires LANG. 218 Commands, Volume 1: IMS Commands A - M v LANG is invalid with GPSB(N), except if DOPT(Y) and LANG(JAVA). v LANG(JAVA), DOPT(Y), and GPSB(N) is a valid combination. v RESIDENT(Y) and GPSB(Y) are mutually exclusive. LANG Specifies the language interface of the program for a GPSB, or defines a DOPT(Y) program as using the Java™ language. In order to define a DOPT program using the Java language, the program must be defined with DOPT(Y) and LANG(JAVA). DOPT PSBs are not loaded at IMS restart, they are loaded every time the program is scheduled. When the program is scheduled for the first time, IMS does not know the language until after the program is scheduled in a region and the PSB is loaded. Unless LANG(JAVA) is defined for the DOPT(Y) program, the program is incorrectly scheduled in a non-Java region. LANG parameter Meaning ASSEM Assembler COBOL COBOL JAVA Java PASCAL Pascal PLI PL/I Keyword combination rules include the following: v LANG is invalid with GPSB(N), except if DOPT(Y) and LANG(JAVA). v DOPT(Y) and LANG(JAVA) is a valid combination. v LANG(JAVA), DOPT(Y), and GPSB(N) is a valid combination. v LANG(JAVA) and FP(E) are mutually exclusive. RESIDENT Specifies the resident option. The RESIDENT(N) option takes effect right away. The RESIDENT(Y) option takes effect at the next restart, unless an error is encountered such as no PSB in ACBLIB for the program, or if the program was created as RESIDENT(Y) after the checkpoint from which this IMS is performing emergency restart. N Use N to specify that the PSB associated with the program is not made resident in storage. The PSB is loaded at scheduling time. This is the default. The RESIDENT(N) option takes effect immediately. Y The PSB associated with the program is made resident in storage at IMS cold start or restart. IMS loads the PSB and initializes it. A resident PSB is accessed in local storage, which avoids I/O to the ACBLIB. In an online environment, the PSB control blocks are stored in the ACBLIB. Keyword combination rules include the following: v DOPT(Y) and RESIDENT(Y) are mutually exclusive. v GPSB(Y) and RESIDENT(Y) are mutually exclusive. SCHDTYPE Specifies whether this program can be scheduled into more than one message region or batch message region simultaneously. PARALLEL The program can be scheduled in multiple regions simultaneously. This is the default. Chapter 19. CREATE commands 219 SERIAL The program can be scheduled in only one region at a time. Keyword combination rules include the following: v DOPT(Y) and SCHDTYPE(PARALLEL) are mutually exclusive. TRANSTAT Specifies whether transaction level statistics should be logged. The value specified has meaning only if the program is a JBP or a non-message driven BMP. If Y is specified, transaction level statistics are written to the log in a X'56FA' log record. N Transaction level statistics should not be logged. Y Transaction level statistics should be logged. The TRANSTAT keyword is optional. If a value is not specified for the TRANSTAT keyword, the system default is used. The system default for the transaction level statistics parameter is set with the TRANSTAT parameter in the DFSDFxxx PROCLIB member. If a value is not specified for the TRANSTAT parameter, the system default is set to N. The TRANSTAT keyword on the CREATE PGM command gives the user the ability to override the system default when creating a program resource. Usage notes BLDL is performed on the PSB associated with this program (except DOPT or GPSB). If the PSB is not defined in ACBLIB, the program is created anyway and the command results in a completion code of zero, even though it cannot be scheduled. The program status is NOTINIT when a /DIS PGM or QRY PGM is issued for the program. Online Change must be used to add the PSB to ACBLIB, before the application program can be scheduled. Resources exist for the life of the IMS unless they are deleted using a DELETE command. The resources and descriptors are recoverable across an IMS warm start or emergency restart. Resources and descriptors are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE PGM command is similar to local online change (using a /MODIFY command) or global online change (INITIATE OLC) for application program resources in the MODBLKS data set, except that programs are added dynamically. A CREATE PGM command can be issued only through the Operations Manager API. This command applies to DB/DC, DBCTL and DCCTL systems. These commands are not valid on the XRF alternate, RSR tracker, or FDBR region. The CREATE command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). When a program is created, if the PSB is in the ACBLIB library, the PSB is loaded into the PSB pool at first schedule. If the program is created with RESIDENT(Y), the PSB is made resident at the next IMS restart. If the PSB is not in the ACBLIB library, the program is created anyway, but marked bad because it is unusable. A QRY PGM command specified with SHOW(ALL) or SHOW(STATUS) shows the program status as NOTINIT-40-NOPSB, which means there is no PSB in the ACBLIB library for it. You must use online change for the ACBLIB library to add the PSB before the program can be used 220 Commands, Volume 1: IMS Commands A - M Output fields The following table shows the CREATE PGM output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 134. Output fields for the CREATE PGM command Short label Keyword Meaning CC N/A Completion code. CCTXT error Completion code text that briefly explains the meaning of the non-zero completion code. MBR N/A IMSplex member that built the output line. PGM PGM Program name. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 135. Return and reason codes for CREATE PGM Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000008' X'00002009' Multiple values specified for the same attribute are invalid. For example, you cannot specify both BMPTYPE(Y) and BMPTYPE(N). This reason code is applicable only when you create a program by using the DFSINSX0 user exit. X'00000008' X'00002048' Invalid SET attribute. X'00000008' X'00002106' DOPT(Y) mutually exclusive with RESIDENT(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was gotten from the model. X'00000008' X'00002107' DOPT(Y) mutually exclusive with SCHDTYPE(PARALLEL). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was gotten from the model. X'00000008' X'0000210B' FP(E) mutually exclusive with BMPTYPE(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was gotten from the model. Chapter 19. CREATE commands 221 Table 135. Return and reason codes for CREATE PGM (continued) | | | | | | | 222 Return code Reason code Meaning X'00000008' X'0000210D' FP(E) mutually exclusive with LANG(JAVA). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was gotten from the model. X'00000008' X'00002113' GPSB(Y) mutually exclusive with DOPT(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was gotten from the model. X'00000008' X'00002114' GPSB(N) mutually exclusive with LANG. X'00000008' X'00002115' GPSB(Y) mutually exclusive with RESIDENT(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was gotten from the model. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. X'00000008' X'00002131' GPSB(Y) requires LANG to be specified. X'00000008' X'00002132' DOPT(Y) not supported with LANG except for LANG(JAVA). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was gotten from the model. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No FP defined, so FP(E) invalid. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004204' Model is quiesced. Cannot quiesce model. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. X'00000014' X'00005010' Unable to obtain latch. X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. Commands, Volume 1: IMS Commands A - M Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 136. Completion codes for the CREATE PGM command Completion code Completion code text 0 Meaning Command completed successfully for the program. 11 RESOURCE ALREADY EXISTS Program exists. 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 61 DFSBCB STORAGE ERROR Request to get BCB storage for PDIR control block failed. 8A WILDCARD PARAMETER NOT SUPPORTED CREATE command does not support wildcard parameters. You must explicitly specify the names of the resources you want to create. 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. BA NOT ALLOWED FOR MRQ PSB CREATE command failed for MRQ PSB because an attribute was specified that is not supported for the MRQ PSB: BMPTYPE(N), DOPT(Y), GPSB(Y), FP(E), RESIDENT(Y), SCHDTYPE(SERIAL) B8 NO PSB IN ACBLIB The DFSINSX0 exit attempted specified that the create should fail if no PSB for the program exists in ACBLIB. Examples The following are examples of the CREATE PGM command: Example 1 for CREATE PGM command TSO SPOC input: CREATE PGM NAME(PGM00001) SET(BMPTYPE(Y)) TSO SPOC output: PgmName MbrName PGM00001 IMS1 CC 0 OM API input: CMD(CREATE PGM NAME(PGM00001) SET(BMPTYPE(Y))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> Chapter 19. CREATE commands 223 <xmlvsn>20 </xmlvsn> <statime>2006.254 22:20:06.531446</statime> <stotime>2006.254 22:20:06.542510</stotime> <staseq>BF6453E8EAD76197</staseq> <stoseq>BF6453E8ED8AE98C</stoseq> <rqsttkn1>USRT011 10152006</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>PGM </kwd> <input>CREATE PGM NAME(PGM00001) SET(BMPTYPE(Y)) </input> </cmd> <cmdrsphdr> <hdr slbl="PGM" llbl="PgmName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>PGM(PGM00001) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> TSO SPOC input: QRY PGM NAME(PGM00001) SHOW(MODEL,BMPTYPE,DEFNTYPE) TSO SPOC output: PgmName MbrName PGM00001 IMS1 CC RgnType BMPType ModelName ModelType DefnType 0 BMP Y DFSDSPG1 DESC CREATE Explanation: Create a batch program called PGM00001. Attributes not specified on the command are assigned the defaults from the program default descriptor. The QRY PGM command shows the model name DFSDSPG1 and model type DESC for the program default descriptor. Example 2 for CREATE PGM command TSO SPOC input: CREATE PGM NAME(DFSSAM02,PLAPJK02,PGM00002,WTOR,PGM*) TSO SPOC output: PgmName DFSSAM02 PGM* PGM00002 PLAPJK02 WTOR MbrName IMS1 IMS1 IMS1 IMS1 IMS1 CC 11 8A 0 11 93 CCText RESOURCE ALREADY EXISTS WILDCARD PARAMETER NOT SUPPORTED RESOURCE ALREADY EXISTS RESERVED NAME OM API input: CMD(CREATE PGM NAME(DFSSAM02,PLAPJK02,PGM00002,WTOR,PGM*)) OM API output: 224 Commands, Volume 1: IMS Commands A - M <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.254 23:05:22.692697</statime> <stotime>2006.254 23:05:22.738636</stotime> <staseq>BF645E0740259287</staseq> <stoseq>BF645E074B5CC902</stoseq> <rqsttkn1>USRT011 10160522</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one rqst successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>PGM </kwd> <input>CREATE PGM NAME(DFSSAM02,PLAPJK02,PGM00002,WTOR,PGM*) </input> </cmd> <cmdrsphdr> <hdr slbl="PGM" llbl="PgmName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>PGM(DFSSAM02) MBR(IMS1) CC( 11) CCTXT(RESOURCE ALREADY EXISTS) </rsp> <rsp>PGM(PLAPJK02) MBR(IMS1) CC( 11) CCTXT(RESOURCE ALREADY EXISTS) </rsp> <rsp>PGM(PGM00002) MBR(IMS1) CC( 0) </rsp> <rsp>PGM(WTOR ) MBR(IMS1) CC( 93) CCTXT(RESERVED NAME) </rsp> <rsp>PGM(PGM* ) MBR(IMS1) CC( 8A) CCTXT(WILDCARD PARAMETER NOT SUPPORTED) </rsp> </cmdrspdata> </imsout> Explanation: Several programs fail to be created because of different error conditions. The CREATE commands that fail return a nonzero completion code (CC) and completion code text (CCText) that briefly describes the completion code. The CREATE command fails for programs DFSSAM02 and PLAPJK02, because they already exist. The CREATE command succeeds for program PGM00002. The CREATE command fails for program WTOR, because WTOR is a reserved name that cannot be used as a resource name. The CREATE command fails for program PGM*, because an asterisk is an invalid character that cannot be used in a resource name. Related concepts: Chapter 19. CREATE commands 225 How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 CREATE PGMDESC command Use the CREATE PGMDESC command to create program descriptors. A descriptor is a model that can be used to create descriptors or resources. A descriptor is created with a value set for every attribute. Attributes not explicitly specified on the CREATE command take the default value. Any program resource or descriptor can be created using this descriptor as a model, by specifying the CREATE command with LIKE(DESC(descriptor_name)). Subsections: v “Environment” v “Syntax” v “Keywords” on page 227 v “Usage notes” on page 231 v “Output fields” on page 231 v “Return, reason, and completion codes” on page 232 v “Examples” on page 234 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 137. Valid environments for the CREATE PGMDESC command and keywords Command / Keywords DB/DC DBCTL DCCTL CREATE PGMDESC X X X LIKE X X X NAME X X X SET X X X Syntax , CREATE CRE PGMDESC NAME( name LIKE( 226 ) DESC(descriptor_name) RSC(resource_name) Commands, Volume 1: IMS Commands A - M ) , SET( BMPTYPE( N Y N Y ) DEFAULT( ) N DOPT( Y ) N FP( E ) N GPSB( Y ) LANG( ASSEM ) COBOL JAVA PASCAL PLI N RESIDENT( Y ) PARALLEL SCHDTYPE( SERIAL N TRANSTAT( Y ) ) ) Default values shown in this syntax diagram reflect the default values that are defined in the IMS program descriptor, DFSDSPG1. If you define another descriptor as the default with a CREATE or UPDATE PGMDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE PGMDESC command: LIKE Specifies that the descriptor is created using an existing resource or descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DFSDSPG1, or user-defined. The model type can either be a descriptor (DESC), or a resource (RSC). The descriptor is created with all the same attributes as the model, except for the DEFAULT(Y) value. Attributes set explicitly by the CREATE command override the model attributes. DEFAULT(Y) must be specified explicitly to make a descriptor the default descriptor. Later changes to the model are not propagated to resources or descriptors that were created from it. The QUERY commands can be used to display the model name and model type used to create the descriptor or resource. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition including the model name and model type to the definition member. The IMPORT command imports a resource definition including the model name and model type from the definition member. An IMPORT command that creates a resource saves the model name and model type, but does not use the models attributes. Chapter 19. CREATE commands 227 DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this descriptor. RSC(resource_name) Specifies the name of the resource to use as a model to define this descriptor. NAME Specifies the 1-8 character name of the descriptor. Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). All program names must begin with an alphabetic character (A through Z, #, $, and @) followed by 0 - 7 alphanumeric characters. Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin with DFS, except for DFSIVPxx and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBF#FPU0, DBRC, ISCEDT, MSDB, SDB, or WTOR. Each local program name must be unique. If the descriptor is defined with BMPTYPE(N) and FP(N), the program name and associated PSB name must be the same. A program resource and a program descriptor can have the same name. SET Specifies the attributes of the descriptor to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either IMS descriptor DFSDSPG1 or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. BMPTYPE() BMP type option. Specifies whether the program executes in a BMP type region or not. A BMP type region might be a BMP region or a JBP region. N The program does not execute in a BMP type region. It can execute in an IMS TM MPP, JMP, or IFP region or it can use either the ODBA or DRA interface. This specification should be used for programs running in IMS TM MPP, JMP, and IFP regions, or PSBs scheduled by CICS programs using DBCTL and other users of the DRA interface. This is the default. Y The program executes in a BMP type region. It can execute in an IMS BMP region or a JBP region. Any associated transactions are assigned normal and limit priority values of zero. DEFAULT Specifies whether the descriptor is the default. N The descriptor is not the default. Y The descriptor is the default, which resets the existing default descriptor to DEFAULT(N). When a descriptor or resource is created without the LIKE keyword, any attribute not specified on the CREATE command takes the value defined in the default descriptor. Only one descriptor can be defined as the default for a resource type. IMS defines a default program descriptor called DFSDSPG1, where all attributes are defined with the default value. Defining a user-defined descriptor as the default overrides the IMS-defined descriptor. Since only one program descriptor can be the default at one time, only one program name can be specified with DEFAULT(Y). DOPT Specifies the dynamic option. 228 Commands, Volume 1: IMS Commands A - M N The PSB associated with the program is not to be located dynamically. The PSB must exist in ACBLIB, otherwise the program is set to a NOTINIT status and cannot be scheduled. This is the default. Y The PSB associated with this program is located dynamically. Each time the program associated with this PSB is scheduled, the latest copy of the PSB is loaded from ACBLIB. The PSB does not need to be in any data set defined for ACBLIB until it is actually required to process a transaction. A new version of the PSB can be defined in ACBLIB and is picked up the next time the PSB is scheduled. DOPT PSBs referencing DBDs that are missing from ACBLIB cannot be scheduled. When the program terminates, the PSB is deleted from the PSB pool. Keyword combination rules include the following: v DOPT(Y) and GPSB(Y) are mutually exclusive. v v v v v DOPT(Y) and LANG(JAVA) is a valid combination. LANG is invalid with GPSB(N), except if DOPT(Y) and LANG(JAVA). LANG(JAVA), DOPT(Y), and GPSB(N) is a valid combination. RESIDENT(Y) and DOPT(Y) are mutually exclusive. SCHDTYPE(PARALLEL) and DOPT(Y) are mutually exclusive. FP Specifies the Fast Path option. E The program is a Fast Path-exclusive program. This implicitly defines a wait-for-input (WFI) program. Either a transaction or a routing code that can be assigned by the user Input Edit/Routing exit routine must be defined for the Fast Path-exclusive program, in order for this program to be usable. Fast Path must be defined in the IMS system. N The program is not a Fast Path-exclusive program. This is the default. When FP(N) is specified, any attempt to use Fast Path resources or commands will yield unpredictable results. Keyword combination rules include the following: v FP(E) requires that Fast Path be defined. v LANG(JAVA) and FP(E) are mutually exclusive. v BMPTYPE(N) and FP(E) are mutually exclusive. GPSB Specifies the generated PSB option. N The PSB associated with the program is not generated by IMS. The PSB must exist in ACBLIB, otherwise the program is set to a NOTINIT status and cannot be scheduled. This is the default. Y The PSB associated with the program is generated by IMS. It is not loaded from ACBLIB. The scheduling process of all environments generates a PSB containing an I/O PCB and an alternate modifiable PCB. You do not need to perform the PSBGEN and ACBGEN. The generated PSB contains an I/O PCB named IOPCBbbb and a modifiable, alternate PCB named TPPCB1bb. With an alternate modifiable PCB, an application can use the CHNG call to change the output destination and send output to a destination other than the input destination. Keyword combination rules include the following: Chapter 19. CREATE commands 229 v v v v v DOPT(Y) and GPSB(Y) are mutually exclusive. DOPT(Y) and LANG(JAVA) is a valid combination. GPSB(Y) requires LANG. LANG is invalid with GPSB(N), except if DOPT(Y) and LANG(JAVA). LANG(JAVA), DOPT(Y), and GPSB(N) is a valid combination. v RESIDENT(Y) and GPSB(Y) are mutually exclusive. LANG Specifies the language interface of the program for a GPSB. LANG parameter Meaning ASSEM Assembler COBOL COBOL JAVA Java PASCAL Pascal PLI PL/I Keyword combination rules include the following: v LANG is invalid with GPSB(N), except if DOPT(Y) and LANG(JAVA). v DOPT(Y) and LANG(JAVA) is a valid combination. v LANG(JAVA), DOPT(Y), and GPSB(N) is a valid combination. v LANG(JAVA) and FP(E) are mutually exclusive. RESIDENT Specifies the resident option. N The PSB associated with the program is not made resident in storage. The PSB is loaded at scheduling time. This is the default. Y The PSB associated with the program is made resident in storage immediately. IMS loads the PSB and initializes it. A resident PSB is accessed in local storage, which avoids I/O to the ACBLIB. In an online environment, the PSB control blocks are stored in the ACBLIB. Resident PSBs are loaded by IMS restart, a CREATE PGM or an UPDATE PGM command that defines the PSB as resident. Keyword combination rules include the following: v DOPT(Y) and RESIDENT(Y) are mutually exclusive. v GPSB(Y) and RESIDENT(Y) are mutually exclusive. SCHDTYPE Specifies whether this program can be scheduled into more than one message region or batch message region simultaneously. PARALLEL The program can be scheduled in multiple regions simultaneously. This is the default. SERIAL The program can only be scheduled in one region at a time. Keyword combination rules include the following: v DOPT(Y) and SCHDTYPE(PARALLEL) are mutually exclusive. 230 Commands, Volume 1: IMS Commands A - M TRANSTAT Specifies whether transaction level statistics should be logged. The value specified has meaning only if the descriptor is a JBP or a non-message driven BMP. If Y is specified, transaction level statistics are written to the log in a X'56FA' log record. N Transaction level statistics should not be logged. Y Transaction level statistics should be logged. The TRANSTAT keyword is optional. If a value is not specified for the TRANSTAT keyword, the system default is used. The system default for the transaction level statistics parameter is set with the TRANSTAT parameter in the DFSDFxxx PROCLIB member. If a value is not specified for the TRANSTAT parameter, the system default is set to N. The TRANSTAT keyword on the CREATE PGM or CREATE PGMDESC command gives the user the ability to override the system default when creating a program or program descriptor. Usage notes Descriptors exist for the life of the IMS unless they are deleted using a DELETE command. The resources and descriptors are recoverable across an IMS warm start or emergency restart. Resources and descriptors are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE PGMDESC command can be issued only through the Operations Manager API. This command applies to DB/DC, DBCTL and DCCTL systems. This command is not valid on the XRF alternate, RSR tracker, or FDBR region. The CREATE command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). Output fields The following table shows the CREATE PGMDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 138. Output fields for the CREATE PGMDESC command Short label Keyword Meaning CC N/A Completion code. CCTXT error Completion code text that briefly explains the meaning of the nonzero completion code. DESC PGMDESC Program descriptor name. MBR N/A IMSplex member that built the output line. Chapter 19. CREATE commands 231 Table 138. Output fields for the CREATE PGMDESC command (continued) Short label Keyword Meaning OLDDEF PGMDESC Old default descriptor name, if this descriptor is made the default by specifying DEFAULT(Y). The old default descriptor is no longer the default. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 139. Return and reason codes for CREATE PGMDESC 232 Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000008' X'00002048' Invalid SET attribute. X'00000008' X'00002106' DOPT(Y) mutually exclusive with RESIDENT(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002107' DOPT(Y) mutually exclusive with SCHDTYPE(PARALLEL). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000210B' FP(E) mutually exclusive with BMPTYPE(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000210D' FP(E) mutually exclusive with LANG(JAVA). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002113' GPSB(Y) mutually exclusive with DOPT(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002114' GPSB(N) mutually exclusive with LANG. X'00000008' X'00002115' GPSB(Y) mutually exclusive with RESIDENT(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. X'00000008' X'00002131' GPSB(Y) requires LANG to be specified. X'00000008' X'00002132' DOPT(Y) not supported with LANG except for LANG(JAVA). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. Commands, Volume 1: IMS Commands A - M Table 139. Return and reason codes for CREATE PGMDESC (continued) | | | | | | | Return code Reason code Meaning X'00000008' X'00002133' Multiple name parameters were specified with DEFAULT(Y). Only one descriptor can be the default at one time. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No FP defined, so FP(E) invalid. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004204' Model is quiesced. Cannot quiesce model. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. X'00000014' X'00005010' Unable to obtain latch. X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 140. Completion codes for the CREATE PGMDESC command Completion code Completion code text 0 Meaning Command completed successfully for program descriptor. 11 RESOURCE ALREADY EXISTS Program descriptor already exists. 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 61 DFSBCB STORAGE ERROR Request to get BCB storage for PDIR control block failed. Chapter 19. CREATE commands 233 Table 140. Completion codes for the CREATE PGMDESC command (continued) Completion code Completion code text Meaning 8A WILDCARD PARAMETER NOT SUPPORTED The CREATE command does not support wildcard parameters. You must explicitly specify the names of the descriptors you want to create. 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. Examples The following are examples of the CREATE PGMDESC command: Example 1 for CREATE PGMDESC command TSO SPOC input: CREATE PGMDESC NAME(FPEDESC) SET(DOPT(Y) FP(E) BMPTYPE(N),SCHDTYPE(SERIAL)) TSO SPOC output: DescName FPEDESC MbrName IMS1 CC 0 OM API input: CMD(CREATE PGMDESC NAME(FPEDESC) SET(DOPT(Y) FP(E) BMPTYPE(N),SCHDTYPE(SERIAL))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.254 22:51:06.632728</statime> <stotime>2006.254 22:51:06.633257</stotime> <staseq>BF645AD6D921890E</staseq> <stoseq>BF645AD6D9429A8E</stoseq> <rqsttkn1>USRT011 10155106</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>PGMDESC </kwd> <input>CREATE PGMDESC NAME(FPEDESC) SET(DOPT(Y) FP(E) BMPTYPE(N),SCHDTYPE(SERIAL)) </input> </cmd> <cmdrsphdr> <hdr slbl="DESC" llbl="DescName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" 234 Commands, Volume 1: IMS Commands A - M scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>DESC(FPEDESC ) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> Explanation: Creates a descriptor with attributes appropriate for a Fast Path exclusive program. Subsequent Fast Path exclusive programs can be created more easily by using this descriptor. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 CREATE RTC command Use the CREATE RTC command to create a Fast Path routing code that can be used by the Fast Path Input Edit/Routing Exit Routine (DBFHAGU0) to route a transaction to a different application program within the same load balancing group for processing. Subsections: v “Environment” v v v v v “Syntax” “Keywords” on page 236 “Usage notes” on page 237 “Output fields” on page 237 “Return, reason, and completion codes” on page 238 v “Examples” on page 240 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 141. Valid environments for the CREATE RTC command and keywords Command / Keywords DB/DC DBCTL DCCTL CREATE RTC X X LIKE X X NAME X X SET X X Syntax , CREATE CRE RTC NAME( name ) LIKE( DESC(descriptor_name) RSC(resource_name) ) Chapter 19. CREATE commands 235 , SET( INQ( N Y ) (1) ) PGM(name) Notes: 1 The PGM() keyword is required if the default descriptor or other descriptor from which the resource is being created does not already have a program defined. Default values shown in this syntax diagram reflect the default values that are defined in the IMS routing code descriptor, DBFDSRT1. If you define another descriptor as the default with a CREATE or UPDATE RTCDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE RTC command: LIKE Specifies that the resource is created using an existing resource or descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DBFDSRT1, or user-defined. The model type can either be a descriptor (DESC), or a resource (RSC). The new resource is created with all the same attributes as the model, except for the DEFAULT(Y) value. Attributes set explicitly by the CREATE command override the model attributes. Later changes to the model are not propagated to resources or descriptors that were created from it. QUERY commands can be used to display the model name and model type used to create the resource. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition, including the model name and model type, to the definition member. The IMPORT command imports a resource definition, including the model name and model type, from the definition member. An IMPORT command that creates a resource saves the model name and model type, but does not use the models attributes. When LIKE is used on a CREATE command, the models current attributes are used to set the attributes of the newly created resource. DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this resource. RSC(resource_name) Specifies the name of the resource to use as a model to define this resource. NAME Specifies the one- to eight-character alphanumeric routing code. Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin 236 Commands, Volume 1: IMS Commands A - M with DFS, except for DFSIVPxx and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBFDSRT1, DBRC, ISCEDT, MSDB, SDB, or WTOR. Routing codes can be duplicates of either transaction names or logical terminal names, but each must be unique within the set of routing codes. A set of routing codes is the group of all routing codes associated with the same program. A routing code resource and a routing code descriptor can have the same name. SET Specifies the attributes of the routing code to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either IMS descriptor DBFDSRT1 or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. INQ N This is not an inquiry transaction. This is the default. Y This is an inquiry transaction. Any message associated with the routing code is an inquiry transaction. This should be specified only for transactions that do not cause a change to a database. Programs are prohibited from issuing Insert, Delete, or Replace calls to a database when processing a transaction defined as INQ(Y). PGM Specifies the name of the program associated with the routing code. For a CREATE RTC command, the program must exist and be defined with a BMPTYPE(N). The PGM() keyword is required if the default descriptor or other descriptor from which the resource is being created does not already have a program defined. Usage notes Resources exist for the life of the IMS unless they are deleted using a DELETE command. The resources are recoverable across an IMS warm start or emergency restart. Resources are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE RTC command is similar to local online change (using a /MODIFY command) or global online change (INITIATE OLC) for routing code resources in the MODBLKS data set, except that routing codes are added dynamically. The CREATE RTC command can be issued only through the Operations Manager API. Fast Path must be installed on the system. This command applies to DB/DC and DCCTL systems. This command is not valid on the XRF alternate, RSR tracker, or FDBR region. The CREATE command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). Output fields The following table shows the CREATE RTC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. Chapter 19. CREATE commands 237 N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 142. Output fields for the CREATE RTC command Short label Keyword Meaning CC N/A Completion code. CCTXT error Completion code text that briefly explains the meaning of the non-zero completion code. MBR N/A IMSplex member that built the output line. RTC RTC Routing code name. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 143. Return and reason codes for CREATE RTC 238 Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000008' X'00002048' Invalid SET attribute. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. X'00000008' X'00002120' No PGM() defined. X'00000008' X'00002123' Invalid PGM name. PGM was specified explicitly, or gotten from the model. If the IMS-defined descriptor DBFDSRT1 was used, the command failed because DBFDSRT1 defines no program name. X'00000008' X'00002133' Multiple name parameters were specified with DEFAULT(Y). Only one descriptor can be the default at one time. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No Fast Path defined. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004204' Model is quiesced. Cannot quiesce model. Commands, Volume 1: IMS Commands A - M Table 143. Return and reason codes for CREATE RTC (continued) | | | | | | | Return code Reason code Meaning X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000010' X'0000431C' Program is quiesced. Cannot quiesce program. X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. X'00000014' X'00005010' Unable to obtain latch. X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 144. Completion codes for the CREATE RTC command Completion code Completion code text 0 Meaning Command completed successfully for routing code. 11 RESOURCE ALREADY EXISTS Routing code already exists. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE PGM or UPDATE PGM) is in progress for the program referenced by this routing code. 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 61 DFSBCB STORAGE ERROR Request to get BCB storage for RCTE control block failed. 7A RTC/FP(N) PGM CONFLICT Routing code to be created conflicts with program defined as non-Fast Path FP(N). 8A WILDCARD PARAMETER NOT SUPPORTED The CREATE command does not support wildcard parameters. You must explicitly specify the names of the resources you want to create. 90 INTERNAL ERROR Internal error. 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. Chapter 19. CREATE commands 239 Examples The following are examples of the CREATE RTC command: Example 1 for CREATE RTC command TSO SPOC input: CRE RTC (NAME(RTC00001)) LIKE(RSC(TXCDRN14)) TSO SPOC output: RtcName MbrName RTC00001 IMS1 CC 0 OM API input: CMD(CRE RTC (NAME(RTC00001)) LIKE(RSC(TXCDRN14))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.254 23:36:59.043090</statime> <stotime>2006.254 23:36:59.043761</stotime> <staseq>BF646517C0512E05</staseq> <stoseq>BF646517C07B1705</stoseq> <rqsttkn1>USRT011 10163658</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>RTC </kwd> <input>CRE RTC (NAME(RTC00001)) LIKE(RSC(TXCDRN14)) </input> </cmd> <cmdrsphdr> <hdr slbl="RTC" llbl="RtcName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" /> </cmdrsphdr> <cmdrspdata> <rsp>RTC(RTC00001) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> TSO SPOC input: QRY RTC (NAME(RTC0*)) SHOW(MODEL,INQ,PGM,DEFNTYPE) TSO SPOC output: Rtcode MbrName RTC00001 IMS1 CC PgmName Inq ModelName ModelType DefnType 0 DDLTRN14 N TXCDRN14 RSC CREATE Explanation: A CREATE RTC command is issued to create routing code RTC00001 like an already existing routing code called TXCDRN14. The QRY RTC command 240 Commands, Volume 1: IMS Commands A - M shows the model name TXCDRN14, specified by the LIKE keyword, and model type RSC, for routing code TXCDRN14. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 CREATE RTCDESC command Use the CREATE RTCDESC command to create Fast Path routing code descriptors. A descriptor is a model that can be used to create routing code descriptors or resources. A descriptor is created with a value set for every attribute. Attributes not explicitly specified on the CREATE command take the default value. Any routing code resource or descriptor can be created using this descriptor as a model, by specifying the CREATE command with LIKE(DESC(descriptor_name)). Subsections: v v v v “Environment” “Syntax” “Keywords” on page 242 “Usage notes” on page 243 v “Output fields” on page 244 v “Return, reason, and completion codes” on page 244 v “Examples” on page 246 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 145. Valid environments for the CREATE RTCDESC command and keywords Command / Keywords DB/DC DBCTL DCCTL CREATE RTCDESC X X LIKE X X NAME X X SET X X Syntax , CREATE CRE RTCDESC NAME( name ) Chapter 19. CREATE commands 241 LIKE( DESC(descriptor_name) RSC(resource_name) ) , SET( N DEFAULT( Y N INQ( Y ) PGM(name) ) ) Default values shown in this syntax diagram reflect the default values that are defined in the IMS routing code descriptor, DBFDSRT1. If you define another descriptor as the default with a CREATE or UPDATE RTCDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE RTCDESC command: LIKE Specifies that the descriptor is created using an existing resource or descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DBFDSRT1, or user-defined. The model type can either be a descriptor (DESC), or a resource (RSC). The descriptor is created with all the same attributes as the model, except for the DEFAULT(Y) value. Attributes set explicitly by the CREATE command override the model attributes. DEFAULT(Y) must be specified explicitly to make a descriptor the default descriptor. Later changes to the model are not propagated to resources or descriptors that were created from it. QUERY commands can be used to display the model name and model type used to create the descriptor or resource. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition including the model name and model type to the definition member. The IMPORT command imports a resource definition including the model name and model type from the definition member. An IMPORT command that creates a resource saves the model name and model type, but does not use the model's attributes. When LIKE is used on a CREATE command, the model's current attributes are used to set the attributes of the newly-created resource or descriptor, except for the default attribute. DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this descriptor. RSC(resource_name) Specifies the name of the resource to use as a model to define this descriptor. NAME Specifies the one- to eight-character alphanumeric routing code descriptor. Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin with DFS, except for DFSIVPxx and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBFDSRT1, DBRC, ISCEDT, MSDB, SDB, or WTOR. 242 Commands, Volume 1: IMS Commands A - M Routing codes can be duplicates of either transaction names or logical terminal names, but each must be unique within the set of routing codes. A set of routing codes is the group of all routing codes associated with the same program. A routing code resource and a routing code descriptor can have the same name. SET Specifies the attributes of the routing code descriptor to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either IMS descriptor DBFDSRT1 or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. DEFAULT Specifies whether the descriptor is the default. N The descriptor is not the default. Y The descriptor is the default, which resets the existing default descriptor to DEFAULT(N). When a descriptor or resource is created without the LIKE keyword, any attribute not specified on the CREATE command takes the value defined in the default descriptor. Only one descriptor can be defined as the default for a resource type. IMS defines a default routing code descriptor called DBFDSRT1, where all attributes are defined with the default value. Defining a user-defined descriptor as the default overrides the IMS-defined descriptor. Since only one routing code descriptor can be the default at one time, only one routing code parameter may be specified with DEFAULT(Y). N This is not an inquiry transaction. This is the default. Y This is an inquiry transaction. Any message associated with the routing code descriptor is an inquiry transaction. This should be specified only for transactions that do not cause a change to a database. Programs are prohibited from issuing Insert, Delete, or Replace calls to a database when processing a transaction defined as INQ(Y). INQ PGM Specifies the name of the program associated with the routing code descriptor. Usage notes Descriptors exist for the life of the IMS unless they are deleted using a DELETE command. The resources and descriptors are recoverable across an IMS warm start or emergency restart. Descriptors are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE RTCDESC command can only be issued through the Operations Manager API. Fast Path must be installed on the system. This command applies to DB/DC and DCCTL systems. This command is not valid on the XRF alternate, RSR tracker, or FDBR region. The CREATE command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). Chapter 19. CREATE commands 243 Output fields The following table shows the CREATE RTCDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 146. Output fields for the CREATE RTCDESC command Short label Keyword Meaning CC N/A Completion code. CCTXT error Completion code text that briefly explains the meaning of the non-zero completion code. DESC RTCDESC Routing code descriptor name. MBR N/A IMSplex member that built the output line. OLDDEF RTCDESC Old default descriptor name, if this descriptor is made the default by specifying DEFAULT(Y). The old default descriptor is no longer the default. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 147. Return and reason codes for CREATE RTCDESC 244 Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000008' X'00002048' Invalid SET attribute. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. X'00000008' X'00002123' Invalid PGM name. PGM was specified explicitly, or gotten from the model. If the IMS-defined descriptor DBFDSRT1 was used, the command failed because DBFDSRT1 defines no program name. X'00000008' X'00002137' Multiple name parameters specified with DEFAULT(Y) is invalid. Only one descriptor can be the default at one time. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. Commands, Volume 1: IMS Commands A - M Table 147. Return and reason codes for CREATE RTCDESC (continued) | | | | | | | Return code Reason code Meaning X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No Fast Path defined. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004204' Model is quiesced. Cannot quiesce model. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. X'00000014' X'00005010' Unable to obtain latch. X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 148. Completion codes for the CREATE RTCDESC command Completion code Completion code text 0 Meaning Command completed successfully for routing code descriptor. 11 RESOURCE ALREADY EXISTS Routing code descriptor already exists. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE PGM or UPDATE PGM) is in progress for the program referenced by this routing code descriptor. 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 61 DFSBCB STORAGE ERROR Request to get BCB storage for RCTE control block failed. 7A RTC/FP(N) PGM CONFLICT Routing code to be created conflicts with program defined as non-Fast Path FP(N). Chapter 19. CREATE commands 245 Table 148. Completion codes for the CREATE RTCDESC command (continued) Completion code Completion code text Meaning 8A WILDCARD PARAMETER NOT SUPPORTED CREATE command does not support wildcard parameters. You must explicitly specify the names of the resources you want to create. 90 INTERNAL ERROR Internal error 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. Examples The following are examples of the CREATE RTCDESC command: Example 1 for CREATE RTCDESC command TSO SPOC input: CRE RTCDESC NAME(DRCTRN02,DRCTRN03) LIKE(RSC(FPTRN01)) SET(PGM(FPPSB03)) TSO SPOC output: DescName MbrName CC DRCTRN02 IMS1 0 DRCTRN03 IMS1 0 Explanation: A CREATE RTCDESC command is issued to create two routing code descriptors at IMS1 in an IMSplex. Routing code descriptors DRCTRN02 and DRCTRN03 are defined using the existing routing code resource called FPTRN01. Routing code FPTRN01 is defined with INQ(Y). Descriptors DRCTRN02 and DRCTRN03 are defined using routing code FPTRN01 as a model for the INQ(Y) attribute, but overriding the program name by explicitly specifying PGM(FPPSB03) on the command. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 CREATE TRAN command Use the CREATE TRAN command to create a transaction code that causes the application program associated with the program resource defined by PGM() to be scheduled for execution in an IMS message processing region. The transaction provides IMS with information that influences the application program scheduling algorithm. The program resource defined by PGM() keyword must exist for the CREATE TRAN command to complete successfully. Subsections: v “Environment” on page 247 246 Commands, Volume 1: IMS Commands A - M v v v v v “Syntax” “Keywords” on page 249 “Usage notes” on page 263 “Output fields” on page 263 “Return, reason, and completion codes” on page 264 v “Examples” on page 269 Environment The following table lists the environments (DB/BC, DBCTL, and DCCTL) from which the command keywords can be issued. Table 149. Valid environments for the CREATE TRAN command and keywords Command / Keywords DB/DC DBCTL DCCTL CREATE TRAN X X LIKE X X NAME X X SET X X Syntax , CREATE CRE TRAN NAME( name ) LIKE( DESC(descriptor_name) RSC(resource_name) ) , SET( A ) A: Chapter 19. CREATE commands 247 N CMD ) TRAN Y 1 CLASS( class ) SNGL CMTMODE( MULT ) N CONV( Y ) DCLWA( N ) Y N DIRROUTE( Y ) EDITRTN(name) Y EDITUC( N ) EMHBSZ(size) EXPRTIME(seconds) N FP( E ) P N INQ( Y ) 65535 LCT( value ) 1 LPRI( value ) 0 MAXRGN( number ) MULTSEG MSGTYPE( SNGLSEG ) MSNAME(name) 1 NPRI( value ) 65535 PARLIM( value ) PGM(name) 65535 PLCT( value ) 6553500 PLCTTIME( hundredths of seconds Y RECOVER( N ) N REMOTE( Y ) N RESP( Y ) 0 SEGNO( number ) 0 SEGSZ( size ) N SERIAL( Y ) SIDL(localsysid) SIDR(remotesysid) SPASZ(size) SPATRUNC( R ) S N TRANSTAT( Y ) N WFI( Y ) AOCMD( 248 Commands, Volume 1: IMS Commands A - M ) Default values shown in this syntax diagram reflect the default values that are defined in the IMS transaction descriptor, DFSDSTR1. If you define another descriptor as the default with a CREATE or UPDATE TRANDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE TRAN command: LIKE Specifies that the resource is created using an existing resource or descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DFSDSTR1, or user-defined. The model type can either be a descriptor (DESC), or a resource (RSC). The new resource is created with all the same attributes as the model. Attributes set explicitly by the CREATE command override the model attributes. Later changes to the model are not propagated to resources or descriptors that were created from it. The QUERY commands can be used to display the model name and model type used to create the resource. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition, including the model name and model type, to the definition member. The IMPORT command imports a resource definition, including the model name and model type, from the definition member. An IMPORT command that creates a resource saves the model name and model type, but does not use the models attributes. DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this resource. RSC(resource_name) Specifies the name of the resource to use as a model to define this resource. NAME Specifies the 1-8 character name of the transaction. Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin with DFS, except for DFSCONE, DFSIVPxx, and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBRC, ISCEDT, MSDB, SDB, or WTOR. A transaction resource and a transaction descriptor can have the same name. A transaction cannot have the same name as an lterm. SET Specifies the attributes of the transaction to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either the IMS descriptor DFSDSTR1, or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. A transaction must have the same characteristics in all systems where it is defined when it is shared. These characteristics include: v Nonconversational/conversational v SPA size if conversational v Single-/multi-segment messages v Noninquiry/inquiry Chapter 19. CREATE commands 249 v Recoverable/nonrecoverable v Response mode/non-response mode v Fast Path exclusive/Fast Path potential/non-Fast Path AOCMD Specifies the AOI option that indicates whether the transaction can issue the type-1 AOI CMD call or the type-2 AOI ICMD call. If AOCMD is defined as CMD, TRAN, or Y, and the AOI1 execute parameter is defined as AOI1=N, no authorization checking is done, and the transaction is permitted to issue CMD and ICMD calls. N Indicates that the transaction is not permitted to issue type-1 AOI CMD calls. The transaction is permitted to issue type-2 AOI ICMD calls. CMD Indicates that the transaction is permitted to issue type-1 AOI CMD calls and type-2 AOI ICMD calls. If the AOI1 execute parameter is defined as C, R, or A, authorization checking is based on which transactions can issue a particular command. In this case, the commands (or the first three characters of the commands) need to be defined to RACF or an equivalent product as a user. The type-1 AOI transactions must be defined as profiles under the TIMS class, and for each transaction, the commands it can issue must be specified. Defining AOCMD(CMD) requires you to create fewer user IDs than you need to create for the AOCMD(TRAN) definition. However, defining AOCMD(CMD) requires you to create or modify a larger number of resource profiles. TRAN Indicates that the transaction is permitted to issue type-1 AOI CMD calls and type-2 AOI ICMD calls. If the AOI1 execute parameter is defined as C, R, or A, the transaction code is used for authorization. The first authorization check results in the accessor environment element (ACEE) being built. This environment is kept for use by future authorization checks. The type-1 AOI transaction needs to be defined to RACF or an equivalent product as a user. The transactions will then be specified on RACF PERMIT statements for each command they are allowed to issue from a type-1 AOI transaction. Specifying AOI transactions as users to RACF might conflict with the name of a user already defined to RACF. If this occurs, then either the transaction name or the existing user name needs to be changed. Y Indicates that the transaction is permitted to issue type-1 AOI CMD calls and type-2 AOI ICMD calls. If the AOI1 execute parameter is defined as C, R, or A, the user ID or the program name is used for authorization. For some environments, if a Get Unique call has not yet occurred, the program name is used for authorization. CLASS Specifies the transaction class, which is an attribute used to select a transaction for scheduling. A transaction can be scheduled if there is a message processing region available for that class. The value can be a number from 1 to 999. The default is 1. This value must not exceed the value given (by specification or default) on the MAXCLAS= keyword of the IMSCTRL macro. Define CPI-C transactions with a different message class from that used for non-CPI-C transactions. IMS handles all CPI-C transactions as priority zero within the transaction class. CMTMODE 250 Commands, Volume 1: IMS Commands A - M Specifies when database updates and non-express output messages are committed. This operand affects emergency restart. MULT Database updates and non-express output messages are committed only when the application program terminates normally, when the processing limit count has been reached, or, in the case of a pseudo-WFI dependent region, when there are no more messages on the queue. For example, if five transactions are processed during a single schedule of a program, all five are committed only when the fifth one is completed and the program terminates. Until a transaction has been committed, locks for updated database records are not released and non-express output messages are not queued for output. If an application ends abnormally before committing its messages, emergency restart requeues all the messages that were processed within the commit scope and makes them available for reprocessing. If the transaction results in the application calling an external subsystem, such as DB2, the Commit Verify exit provided by the external subsystem can determine whether CMTMODE(MULT) is supported. See documentation under the Commit Verify exit routine in IMS Version 13 Exit Routines. SNGL Database updates and non-express output messages are committed when the application program completes processing each transaction. IMS invokes commit processing either when the application program requests the next message (issues a GU to the IO-PCB), or when the application program terminates. If an application ends abnormally before committing its message, emergency restart requeues the message that was in process before the abend and makes it available for reprocessing. This is the default. Note: The TRANSACT macro MODE keyword uses a default of MULT. The CREATE TRAN command CMTMODE keyword uses a default of SNGL. Keyword combination rules include the following: v CMTMODE(MULT) and CONV(Y) are mutually exclusive. v CMTMODE(MULT) and WFI(Y) are mutually exclusive. CONV Specifies the conversation option. N The transaction is not conversational. This is the default. Y The transaction is conversational. The transaction message is destined for a conversational program. A conversational program processes transactions made up of several steps. A conversational program receives a message from a terminal, replies to the terminal, but saves the data from the transaction in a scratchpad area (SPA). When the person at the terminal enters more data, the program has the data it saved from the last message in the SPA, so it can continue processing the request without the person at the terminal having to enter the data again. Keyword combination rules include the following: v CMTMODE(MULT) and CONV(Y) are mutually exclusive. v FP(E) and CONV(Y) are mutually exclusive. v CONV(Y) requires SPASZ and SPATRUNC. Chapter 19. CREATE commands 251 v RECOVER(N) and CONV(Y) are mutually exclusive. v SPASZ and CONV(N) are mutually exclusive. v SPATRUNC and CONV(N) are mutually exclusive. DCLWA Specifies the log write-ahead option. If not specified and the default descriptor is the IMS-defined descriptor DFSDSTR1, the value is defined to be the DFSDFxxx PROCLIB member DCLWA parameter at IMS cold start. Changing the DFSDFxxx DCLWA value across a restart has no effect on the default descriptor DCLWA value. If DCLWA is not defined in the DFSDFxxx PROCLIB member, the default is DCLWA=Y. N IMS should not perform log write-ahead. Specify N if input message integrity and the consistency of output messages with associated database updates is not required. DCLWA does not apply to response mode or Fast Path input processing, and is ignored during IMS execution. Y IMS should perform log write-ahead for recoverable, nonresponse input messages and transaction output messages. This ensures the following: v A nonresponse input transaction is made recoverable across IMS failures before IMS acknowledges receipt of the input. v Database changes are made recoverable before IMS sends associated output reply messages. v Information in the log buffers is written to the IMS log, before the associated input acknowledgment or output reply is sent to the terminal. Define DCLWA(Y) for all VTAM terminal types. DIRROUTE Specifies the MSC directed routing option. N The application program processing a transaction is not informed of the system which originated the transaction. The name of the originating LTERM is placed in the I/O PCB. This is the default. Y The application program processing a transaction is informed of the system which originated the transaction, if MSC directed routing is used in a multiple IMS system configuration. An MSNAME corresponding to a logical path back to the originating system is placed in the I/O PCB. EDITRTN Specifies the 1- to 8-character name of your transaction input edit routine that edits messages before the program receives the message. This name must be alphanumeric (A through Z, 0 through 9, #, $, and @). It must begin with an alphabetic character (A through Z, #, $, @). It cannot include a blank, comma, period, hyphen, or equal. It cannot include the wildcard characters * or %. The specified edit routine can either be an edit routine defined during the system definition process with the EDIT= parameter on the TRANSACT macro or it can be a new routine. If the routine is a new routine, the routine must reside in one of the RESLIB concatenated data sets. A maximum of 255 input edit routines are supported. If the edit routine specified on the command is new to IMS, IMS attempts to load the routine from RESLIB. If the load fails, the command is rejected. If the edit routine specified is already defined to IMS, a decision is made whether to load a new copy of the routine or to use the existing copy. If the routine was 252 Commands, Volume 1: IMS Commands A - M generated into the system, but there are no transactions referencing the routine, IMS first attempts to load a new copy of the module from RESLIB. If the load is successful, the dynamic copy of the edit routine is used. The generated copy cannot be used again unless IMS is cold started. If the load of the dynamic routine fails, the generated copy is used. If the edit routine was generated into the system and other transactions reference it, the generated copy of the module is used. EDITRTN is used for a Fast Path potential transaction when the transaction is routed to IMS. For input from LU 6.2 devices, the user edit exit routine DFSLUEE0 is called instead of the transaction input edit routine specified in EDITRTN. Keyword combination rules include the following: v FP(E) and EDITRTN are mutually exclusive. EDITUC Specifies the edit to uppercase option. N The input data is not translated to uppercase. It can consist of upper and lowercase characters as entered from the terminal. Y The input data is to be translated to uppercase before it is presented to the processing program. If FP(E) or FP(P), the transaction is to be translated to uppercase before being presented to the edit/routing exit routine. This is the default. Specifying EDITUC(Y) for VTAM terminals prevents the transmission of embedded device control characters. EMHBSZ Specifies the EMH buffer size required to run the Fast Path transaction. This overrides the EMHL execution parameter. If EMHBSZ is not specified, the EMHL execution parameter value is used. The value can be a number from 0 to 30 720. Keyword combination rules include the following: v EMHBSZ>0 requires Fast Path to be defined. v FP(N) and EMHBSZ>0 are mutually exclusive. EXPRTIME Specifies the elapsed time in seconds that IMS can use to cancel the input transaction. After a transaction is submitted to IMS, the transaction could be delayed for processing because of a stopped transaction or a potential system slow down. In that case, the user or client application could time out before the transaction is processed. When IMS eventually schedules and processes the transaction, the response message is no longer wanted. With the elapsed time specified for the transaction, IMS can flag the input transaction as expired so that the system does not waste CPU cycles to process the unwanted transaction. The value can be a number, in seconds, which can range from 0 to 65535. The default is 0, which means that no expiration time is set for this transaction. The transaction expiration attribute is supported by all of the IMS TM interfaces. Restriction: The transaction expiration checking is not performed at the GU time for Fast Path transactions, IMS conversational transactions, and program-to-program switch transactions. FP Specifies the Fast Path option. Chapter 19. CREATE commands 253 E The transaction is processed exclusively as Fast Path. A Fast Path routing code by the same name is created. The program must be defined as Fast Path exclusive. N The transaction is not a candidate for Fast Path processing. The program identified by PGM() must be defined as not Fast Path. This is the default. P The transaction is a potential candidate for Fast Path processing. Fast Path-potential transactions must be able to run under two programs: a Fast Path exclusive program a non-Fast Path program. This CREATE TRAN command defines the non-Fast Path program with PGM(). A Fast Path exclusive program should be defined to which this transaction can be routed. Fast Path-potential transactions must be processed by a user edit/routing exit to determine whether the transaction is actually to be processed by IMS Fast Path. If it is to be processed by IMS Fast Path, the edit/routing exit routine associates the transaction with a routing code. This routing code identifies which Fast Path program is to process the transaction. The program defined by PGM() must not be defined as Fast Path exclusive. Keyword combination rules include the following: v EDITRTN and FP(E) are mutually exclusive. v FP(P) and FP(E) require Fast Path to be defined. v CONV(Y) and FP(E) are mutually exclusive. v v v v v v MSGTYPE(MULTSEG) and FP(E) are mutually exclusive. MSGTYPE(MULTSEG) and FP(P) are mutually exclusive. MSNAME and FP(E) are mutually exclusive. MSNAME and FP(P) are mutually exclusive. RECOVER(N) and FP(E) are mutually exclusive. RECOVER(N) and FP(E) are mutually exclusive. v RESP(N) and FP(E) are mutually exclusive. v RESP(N) and FP(P) are mutually exclusive. v SIDL and FP(E) are mutually exclusive. v SIDL and FP(P) are mutually exclusive. v SIDR and FP(E) are mutually exclusive. v SIDR and FP(P) are mutually exclusive. INQ Specifies the inquiry option. N This is not an inquiry transaction. This is the default. Y This is an inquiry transaction. If INQ(Y) is specified, you can also specify whether this transaction should be recovered during an IMS emergency or normal restart using the RECOVER() parameter. This option should be specified only for those transactions that, when entered, do not cause a change in any database. Programs are prohibited from issuing ISRT, DLET, or REPL calls to a database when scheduled to process a transaction defined as INQ(Y). An application program cannot do an SQL INSERT, DELETE, or UPDATE when the IMS transaction is defined with INQ(Y). Keyword combination rules include the following: 254 Commands, Volume 1: IMS Commands A - M v RECOVER(N) and INQ(N) are mutually exclusive. LCT Specifies the limit count. This 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. The value can be a number from 1 to 65535. The default is 65535. The limit count value is ignored for a transaction processed by a BMP. The limit count value is ignored in a shared-queues environment. The limit count value does not apply to FP exclusive transactions and is ignored. LPRI Specifies the limit priority. This is the scheduling 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. The scheduling priority is an attribute used to select a transaction for scheduling. A transaction of higher priority is scheduled before a lower priority one, if they are defined with the same class. The value can be a number from 0 through 14. The default is 1. When the limit priority is used and the scheduling priority is raised to the limit priority, the priority is not reduced to the normal priority until all messages enqueued for this transaction name are processed. If you do not want the limit priority for this transaction, define equal values for the normal priority and limit priority, and a limit count of 65535. When a transaction is processed exclusively by a batch message program (BMP), define the limit priority as 0. If the program specified by PGM() is defined with a program type of batch, the current priority is forced to be 0. However, a batch message processing region (BMP) can process transactions with current scheduling priorities other than 0. This priority also controls the priority of messages created by this transaction and sent to a destination in a remote system. See also the discussion on MSC priorities under the NPRI definition. The limit priority value is ignored for a transaction processed by a BMP. Scheduling ignores the limit priority value for batch programs. If the transaction refers to a batch program and a non-zero LPRI value is specified, it is set to 0. The limit priority value is ignored in a shared queues environment. MAXRGN | | | | | | | Specifies the maximum region count. This count value limits the number of message processing program (MPP) regions that can be concurrently scheduled to process a transaction. When the number of MPP regions is not limited, one transaction might monopolize all available regions. The value can be a number between 0 and the value specified on the MAXPST= control region parameter. MAXRGN(0) means that no limit is imposed. If you define the program with a scheduling type of SERIAL, omit the MAXRGN parameter or define it as 0. Keyword combination rules include the following: v PARLIM(65535) and MAXRGN>0 are mutually exclusive. v SERIAL(Y) and MAXRGN>0 are mutually exclusive. Chapter 19. CREATE commands 255 MSGTYPE Specifies the message type (single segment or multiple segment). It specifies the time at which an incoming message is considered complete and available to be routed to an application program for subsequent processing. If MSC-directed routing is used in a multiple IMS system configuration, IMS does not ensure that both the message and the transaction destined to process that message are either single segment or multiple segments. MULTSEG The incoming message can be more than one segment in length. It is not eligible for scheduling to an application program until an end-of-message indication is received, or a complete message is created by MFS. This is the default. SNGLSEG The incoming message is one segment in length. It becomes eligible for scheduling when the terminal operator indicates end-of-segment. Keyword combination rules include the following: v FP(E) and MSGTYPE(MULTSEG) are mutually exclusive. v FP(P) and MSGTYPE(MULTSEG) are mutually exclusive. MSNAME Specifies the one- to eight-character name of the logical link path in a multiple IMS system configuration (MSC). A logical link path is a path between any two IMS systems. The IMS systems are identified by the remote system ID and the local system ID associated with the logical link path. The remote system ID identifies the system in which messages using this path are to be processed. The local system ID identifies this system. If this transaction is exported, the local and remote system IDs are exported, not the msname. For a CREATE TRAN command adding a remote transaction, the MSNAME must already be defined. Keyword combination rules include the following: v FP(E) and MSNAME are mutually exclusive. v FP(P) and MSNAME are mutually exclusive. v SIDL and MSNAME are mutually exclusive. v SIDR and MSNAME are mutually exclusive. NPRI Specifies the normal scheduling priority. The scheduling priority is an attribute used to select a transaction for scheduling. A transaction of higher priority is scheduled before a lower priority one, if they are defined with the same class. When a transaction resource is created, the current priority (CPRI), or the scheduling priority, is initialized to the normal priority (NPRI). The normal priority is also assigned to a transaction as the current priority when the number of input transactions enqueued and waiting to be processed is less than the limit count value. The value can be a number from 0 through 14. The default is 1. This priority also controls the priority of messages created by this transaction and sent to a destination in a remote system. When a transaction is processed exclusively by a batch message program (BMP), code the normal priority as 0. 256 Commands, Volume 1: IMS Commands A - M When a transaction is processed exclusively by a batch message program (BMP), define the limit priority as 0. If the program specified by PGM() is defined with a program type of batch, the current priority is forced to be 0. However, a batch message processing region (BMP) can process transactions with current scheduling priorities other than 0. For remote transactions, the priority used to send the transaction to the processing system, which is termed the MSC link message priority. The three MSC link message priority groups are: v Low v Medium v High The low priority group consists of primary requests in the input terminal system. This group is assigned remote transaction priorities from 0 to 6. The medium group consists of secondary requests, responses, primary requests in an intermediate system, and primary requests in the input terminal system. This group is assigned a remote transaction priority of 7. The high group consists of primary requests in the input terminal system. Messages in this group are assigned remote transaction priorities from 8 to 14. Within each group, messages have a priority based on the current priority value of the transaction or remote transaction in the input terminal system for primary requests, and on the latest processing system for secondary requests and responses. In an MSC configuration, the transaction priority determines the priority used to send messages inserted by this transaction across an MSC link. If the transaction inserts multiple messages to the same destination (for example, pages to a printer) and these messages must be sent in the order inserted, the normal and limit priority values should be the same. If the normal and limit priority values are not identical, messages inserted at a higher priority than previously inserted messages could arrive at their destination first. (This restriction does not apply to multiple segments of the same message.) The normal priority value is ignored for a transaction processed by a BMP. Scheduling ignores the normal priority value for batch programs. If the transaction refers to a batch program and a non-zero NPRI value is specified, it is set to 0. PARLIM Specifies the parallel processing limit count. This 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. This is the threshold value to be used when the associated program is defined with a scheduling type of parallel. An additional region is scheduled whenever the current transaction enqueue count exceeds the PARLIM value multiplied by the number of regions currently scheduled for this transaction. The value can be a number from 0 to 32767 or 65535. PARLIM(0) indicates that any input message can cause a new region to be scheduled because the scheduling condition is always being met (the number of messages are greater than zero). If you specify PARLIM(0), you should specify a MAXRGN value to limit the number of regions that can be scheduled to process a particular transaction. PARLIM(65535) means that parallel processing is disabled and IMS allows the transaction to be scheduled in only one region at a time. PARLIM(65535) is the default. Chapter 19. CREATE commands 257 The value specified for PARLIM applies to message processing programs (MPPs) only; it is not supported for batch message processing programs (BMPs). If you define the transaction as serial or the program with a scheduling type as SERIAL, define PARLIM(65535). In a shared-queues environment (when the scheduling type is PARALLEL), any PARLIM value other than 65535 causes a new region to be scheduled whenever the successful consecutive GU count exceeds the PARLIM value multiplied by the number of regions currently scheduled for this transaction. For shared-queues environments, the successful consecutive GU count is used instead of the queue count. New regions continue to be scheduled up to the maximum number of regions specified on MAXRGN. The PARLIM keyword is not applicable to FPE transactions and should be allowed to default to 65535. A PARLIM value can be specified for FPE transactions, but it is ignored by scheduling. Specifying a PARLIM value that is not the default will result in a BAL status shown for an FPE transaction on commands such as /DISPLAY TRAN or QUERY TRAN. The PARLIM and BAL status can be ignored for FPE transactions. Keyword combination rules include the following: v MAXRGN>0 and PARLIM(65535) are mutually exclusive. v SERIAL(Y) and PARLIM value 0 - 32767 are mutually exclusive. PGM Specifies the name of the program associated with the transaction. For a CREATE TRAN command specified with REMOTE(N), the program must exist. PGM() is required, except for remote transactions defined with REMOTE(Y). PLCT Specifies the processing limit count. This is maximum number of messages sent to the application program by IMS for processing without reloading the application program. The value must be a number from 0 through 65535. PLCT(0) means the maximum number of messages sent to the application is one and the application program is reloaded before receiving a subsequent message. PLCT(65535) means that no limit is to be placed upon the number of messages processed at a single program load. Values 1 through 65535 are eligible for quick reschedule processing. The default is 65535. The value is used to determine how many messages an application program is allowed to process in a single scheduling cycle. When the application program requests, and receives, the number of messages indicated, any subsequent requests result in one of two actions. v IMS indicates “no more messages exist” if any of the following conditions is true: – The region is not an MPP. – The currently scheduled mode is not CMTMODE(SNGL). – Equal or higher priority transactions are enqueued for the region. IMS might have other messages enqueued for the application program. It is the responsibility of the application program to terminate when it receives an indicator that no more messages are available. Termination of the application program makes the region it occupied available for rescheduling. This feature makes it possible for IMS to enable scheduling of higher priority transactions that entered the system while the previous transactions 258 Commands, Volume 1: IMS Commands A - M were in process. In addition, if any equal-priority transactions are enqueued, they become eligible for scheduling on a first-in, first-out (FIFO) basis. v The region goes through quick reschedule and returns the next message to the application if all of the following conditions are true: – The region is an MPP. – The transaction is CMTMODE(SNGL). – No equal or higher transactions are enqueued. – Messages are still enqueued for the application program. PLCTTIME Specifies the processing limit count time. This is the amount of time (in hundredths of seconds) allowable to process a single transaction (or message). The number specifies the maximum CPU time allowed for each message to be processed in the message processing region. Batch Message Programs (BMPs) are not affected by this setting. The value can be a number, in hundredths of seconds, that can range from 1 to 6553500. A value of 6553500 means no time limit is placed on the application program. The default is 6553500. If Fast Path is used, this keyword specifies, for a given transaction name, the amount of time (in hundredths of seconds) the program is allowed to process a single transaction message. The time represents real time that elapses during transaction processing (not accumulated task time). Real time is used because the input terminal is in response mode and cannot enter another transaction until the response is sent. In this case PLCT() is ignored. The value controls application program looping. You are not required to optimize the value for program-transaction execution time. However, the time value assigned should not be less than the expected per-transaction execution time. If the scheduled application program exceeds the product of PLCTTIME() and PLCT(), the application program ends abnormally. If an IMS STIMER value of 2 is specified on the DFSMPR procedure, the region does not abend until completion of the DL/I call. The application program must not use STIMER timer services. IMS uses STIMER timer services to time the execution of transactions. If an application program issues an MVS STIMER macro, it cancels the STIMER timer services set by IMS. Use the STIMERM macro instead for application program timer requests. RECOVER Specifies the recovery option. Y The transaction is recovered during IMS emergency or normal restart. This is the default. N The transaction is not recovered. Keyword combination rules include the following: v CONV(Y) and RECOVER(N) are mutually exclusive. v FP(E) and RECOVER(N) are mutually exclusive. v FP(P) and RECOVER(N) are mutually exclusive. v INQ(N) and RECOVER(N) are mutually exclusive. REMOTE Specifies the remote option. Chapter 19. CREATE commands 259 N The transaction is not remote. The transaction is local and runs on the local system. This is the default. Y The transaction is remote. The transaction runs on a remote system. Keyword combination rules include the following: v REMOTE(Y) requires MSNAME or SIDR and SIDL. RESP Specifies the response-mode option. N The transaction is not response mode. For terminals specifying or accepting a default of OPTIONS=TRANRESP, input should not stop after this transaction is entered. This is the default. Y The transaction is response mode. The terminal from which the transaction is entered is held and prevents further input until a response is received. For terminals specifying or accepting a default of OPTIONS=TRANRESP, no additional messages are to be allowed after this transaction is entered until this transaction sends a response message back to the terminal. Response mode can be forced or negated by individual terminal definition. RESP(Y) is ignored during online processing for all terminals that do not operate in response mode. Keyword combination rules include the following: v FP(E) and RESP(N) are mutually exclusive. v FP(P) and RESP(N) are mutually exclusive. SEGNO Specifies the segment number. This is the maximum number of application program output segments that are allowed into the message queues per Get Unique (GU) call from the application program. The value can be a number from 0 through 65535. The default is 0. If SEGNO(0) is defined, the number of segments is not checked by the online system at execution time. SEGSZ Specifies the segment size. This is the maximum number of bytes allowed in any one output segment. The value can be a number from 0 through 65535. The default is 0. If SEGSZ(0) is defined, the segment size is not checked by the online system at execution time. The maximum output message segment to an LU 6.2 device is 32767. If a transaction is expected to send output to an LU 6.2 device, the SEGSIZE parameter should be no greater than 32767. However, this is not enforced during processing of the command, because IMS cannot determine the device type for the message destination until output time. SERIAL Specifies the serial option. 260 N Messages for the transaction are not processed serially. Message processing can be processed in parallel. Messages are placed on the suspend queue after a U3303 pseudoabend. Scheduling continues until repeated failures result in the transaction being stopped with a USTOP. This is the default. Y Messages for the transaction are processed serially. U3303 pseudoabends do not cause the message to be placed on the suspend queue but rather on the front of the transaction message queue, and the transaction is stopped Commands, Volume 1: IMS Commands A - M with a USTOP. The USTOP of the transaction is removed when the transaction or the class is started with a /START or UPD TRAN command. Keyword combination rules include the following: v MAXRGN>0 and SERIAL(Y) are mutually exclusive. v PARLIM value 0 - 32767 and SERIAL(Y) are mutually exclusive. SIDL Specifies the system identification (SYSID) of the local system in a multiple-IMS system (MSC) configuration. The local system is the originating system to which responses are returned. The value can be a number from 1 to 2036, if MSC is enabled, or 0, if MSC is not enabled. The local SYSID can be defined in any or all of the MSNAMEs or transactions. For a local transaction where SIDL is not specified, SIDL is defined with a value of the lowest system ID when MSC is enabled on this system, or SIDL is defined with a value of 0 when MSC is not enabled on this system. The local system ID (SIDL) and the remote system ID (SIDR) are the same for local transactions. When creating a local transaction, if the SIDL and SIDR values are not defined as local to this IMS, the lowest system ID is used for the SIDL and SIDR values. The SIDL parameter is independent of the link type (CTC, MTM, TCP/IP, VTAM) specified on the TYPE= keyword of the MSPLINK macro statement. Keyword combination rules include the following: v FP(E) and SIDL are mutually exclusive, unless SIDL and SIDR are specified as a pair and are equal to the local system ID of this IMS. v FP(P) and SIDL are mutually exclusive. v MSNAME and SIDL are mutually exclusive. v SIDL value must be defined to this IMS. SIDR Specifies the system identification (SYSID) of the remote system in a multiple-IMS system (MSC) configuration. The remote system is the system on which the application program executes. The value can be a number from 1 to 2036 if MSC is enabled, or 0 if MSC is not enabled. The remote SYSID specified must also be defined for an MSNAME. Local transactions must have the SIDR value set equal to the SIDL value. Both values must be set to the same local SYSID. The SIDR parameter is independent of the link type (CTC, MTM, TCP/IP, VTAM) specified on the TYPE= keyword of the MSPLINK macro statement. Keyword combination rules include the following: v FP(E) and SIDR are mutually exclusive, unless SIDL and SIDR are specified as a pair and are equal to the local system ID of this IMS. v FP(P) and SIDR are mutually exclusive. v MSNAME and SIDR are mutually exclusive. v SIDR value must be defined to this IMS. SPASZ Specifies the scratchpad area (SPA) size, in bytes, for a conversational transaction. The value can be a number from 16 and 32767. Chapter 19. CREATE commands 261 Keyword combination rules include the following: v CONV(N) and SPASZ are mutually exclusive. v FP(E) and SPASZ are mutually exclusive. SPATRUNC Specifies the scratchpad area (SPA) truncation option of a conversational transaction. This keyword defines whether the SPA data should be truncated or preserved across a program switch to a transaction that is defined with a smaller SPA. If this keyword is not specified for a conversational transaction, the value is obtained from the model (RSC, DESC, or default descriptor). If the SPATRUNC value is not specified or set in the model, the SPATRUNC value is set based on the value specified for the TRUNC parameter in the DFSDCxxx PROCLIB member at IMS cold start. Changing the DFSDCxxx TRUNC value across a restart has no effect on the default descriptor SPATRUNC value. When a conversation initially starts, and when a program is switched, the SPATRUNC option is checked and set or reset as specified. When the option is set, it remains set for the life of the conversation, or until a program switch occurs to a transaction that specifies the option is to be reset. When a program switch occurs, the truncated data option for the new transaction is first checked, and that specification is set for the conversation and is used for the SPA inserted into the output message. If the option is not specified for the new transaction, the option currently in effect for the conversation is used. S IMS preserves all of the data in the SPA, even when a program switch is made to a transaction that is defined with a smaller SPA. The transaction with the smaller SPA does not see the truncated data, but when the transaction switches to a transaction with a larger SPA, the truncated data is used. R The truncated data is not preserved. Keyword combination rules include the following: v CONV(N) and SPATRUNC are mutually exclusive. v FP(E) and SPATRUNC are mutually exclusive. TRANSTAT Specifies whether transaction level statistics are to be logged for message driven programs. If Y is specified, transaction level statistics are written to the log in a X'56FA' log record. N Transaction level statistics are not logged. Y Transaction level statistics are logged. The TRANSTAT keyword is optional. If not specified and the default descriptor is the IMS-defined descriptor DFSDSTR1, the value is defined to be the DFSDFxxx PROCLIB member TRANSTAT parameter at IMS cold start. Changing the DFSDFxxx TRANSTAT value across a restart has no effect on the default descriptor TRANSTAT value. You can use the TRANSTAT keyword on the CREATE TRAN command or the CREATE TRANDESC command to override the system default when you create a transaction or transaction descriptor. WFI Specifies the wait-for-input option. This attribute does not apply to Fast Path transactions, which always behave as wait-for-input transactions. 262 Commands, Volume 1: IMS Commands A - M N This is not a wait-for-input transaction. This is the default. Y This is a wait-for-input transaction. A message processing or batch processing application program that processes WFI transactions is scheduled and invoked normally. If the transaction to be processed is defined as WFI, the program is allowed to remain in main storage after it has processed the available input messages. The QC status code (no more messages) is returned to the program if the processing limit count (PLCT) is reached; a command is entered to change the status of the scheduled transaction, database, program, or class; commands relating to the databases used by the transaction are entered, or IMS is terminated with a checkpoint shutdown. Keyword combination rules include the following: v CMTMODE(MULT) and WFI(Y) are mutually exclusive. Usage notes In an IMSplex where an RM and a resource structure are defined, the transaction names are saved in the resource structure. Resources exist for the life of the IMS unless they are deleted using a DELETE command. Resources are recoverable across an IMS warm start or emergency restart. Resources are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE TRAN command is similar to local online change (using a /MODIFY command) or global online change (using an INITIATE OLC command) for transaction resources in the MODBLKS data set, except that transactions are added dynamically. The CREATE TRAN command can be issued only through the Operations Manager API. These commands apply to DB/DC and DCCTL systems. This command is not valid on the XRF alternate, RSR tracker, or FDBR region. The CREATE command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). Output fields The following table shows the CREATE TRAN output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. The value error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 150. Output fields for the CREATE TRAN command Short label Keyword Meaning CC N/A Completion code. Chapter 19. CREATE commands 263 Table 150. Output fields for the CREATE TRAN command (continued) Short label Keyword Meaning CCTXT error Completion code text that briefly explains the meaning of the non-zero completion code. MBR N/A IMSplex member that built the output line. TRAN TRAN Transaction name. Return, reason, and completion codes An IMS return and reason code is returned to OM by the CREATE TRAN command. The OM return and reason codes that might be returned as a result of the CREATE TRAN command are standard for all commands entered through the OM. The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 151. Return and reason codes for the CREATE TRAN command 264 Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000008' X'00002009' Multiple values specified for the same attribute are invalid. For example, you cannot specify both RESP(Y) and RESP(N). This reason code is applicable only when you create a transaction using the DFSINSX0 user exit. X'00000008' X'0000204C' The class value is invalid. X'00000008' X'00002050' The current priority CPRI value is invalid. X'00000008' X'00002054' The limit count LCT value is invalid. X'00000008' X'00002058' The limit priority LPRI is invalid. X'00000008' X'0000205C' The maximum region MAXRGN is invalid. X'00000008' X'00002060' The normal priority NPRI value is invalid. X'00000008' X'00002064' The parallel limit count PARLIM value is invalid. X'00000008' X'00002068' The processing limit count PLCT is invalid. X'00000008' X'0000206C' The segment number SEGNO value is invalid. X'00000008' X'00002070' The segment size SEGSZ value is invalid. X'00000008' X'00002100' CMTMODE(MULT) mutually exclusive with WFI(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002101' CONV(Y) mutually exclusive with CMTMODE(MULT). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. Commands, Volume 1: IMS Commands A - M Table 151. Return and reason codes for the CREATE TRAN command (continued) Return code Reason code Meaning X'00000008' X'00002103' CONV(N) mutually exclusive with SPASZ>0 or SPATRUNC. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002104' CONV(Y) mutually exclusive with RECOVER(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002105' CONV(Y) requires SPASZ and SPATRUNC. Either SPASZ was not explicitly specified or defined in the model, or SPATRUNC was not explicitly specified or defined in the model. CONV(Y) was either explicitly specified or defined in the model. X'00000008' X'00002108' Invalid EDITRTN name. EDITRTN was specified explicitly or obtained from the model. X'00000008' X'00002109' Maximum 255 edit routines exceeded. EDITRTN was specified explicitly or obtained from the model. X'00000008' X'0000210A' Invalid EMHBSZ. One of the following situations occurred: v The EMHB size specified is either greater than the maximum size, which is 30720 v The EMHB size specified plus the length of the X'5901' log record prefix is greater than the log buffer size X'00000008' X'0000210C' FP(E) mutually exclusive with EDITRTN. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000210E' FP(E) or FP(P) mutually exclusive with MSC keyword, either MSNAME or SIDR and SIDL. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000210F' FP(E) or FP(P) mutually exclusive with MSGTYPE(MULTSEG). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002110' FP(N) mutually exclusive with EMHBSZ > 0. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002111' FP(E) or FP(P) mutually exclusive with RECOVER(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002112' FP(E) or FP(P) mutually exclusive with RESP(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. Chapter 19. CREATE commands 265 Table 151. Return and reason codes for the CREATE TRAN command (continued) 266 Return code Reason code Meaning X'00000008' X'00002116' INQ(N) mutually exclusive with RECOVER(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. X'00000008' X'00002119' MSC keyword MSNAME or SIDR and SIDL are mutually exclusive with application program defined as Fast Path exclusive (FP(E)) associated with this transaction. X'00000008' X'0000211A' Invalid MSNAME name. X'00000008' X'0000211B' MSNAME mutually exclusive with SIDR and SIDL. X'00000008' X'0000211D' MAXRGN>0 mutually exclusive with PARLIM(65535). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000211E' MAXRGN>0 mutually exclusive with SERIAL(Y). Either keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002120' PGM() definition missing. PGM must be defined for local transactions either explicitly or in the model. X'00000008' X'00002121' PARLIM value mutually exclusive with SERIAL(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002123' Invalid PGM name. PGM was specified explicitly, or obtained from the model. If the IMS-defined descriptor DFSDSTR1 was used, the command failed because DFSDSTR1 defines no program name. X'00000008' X'00002125' If REMOTE(Y) is specified, the SIDR value must be a remote SYSID and the SIDL value must be a local SYSID. If neither the MSNAME keyword nor the SIDR and SIDL keywords are specified explicitly, the SIDR and SIDL values are obtained from the model. If REMOTE(N) is specified, the SIDR value must be equal to the SIDL value. The SIDR and SIDL values can be specified explicitly or obtained from the model. The MSNAME keyword is not allowed with REMOTE(N). The REMOTE value can be specified explicitly or obtained from the model. X'00000008' X'00002126' Invalid SIDL value. X'00000008' X'00002127' SIDL/SIDR must be specified as a pair. Either SIDL was specified alone or SIDR was specified alone. X'00000008' X'00002128' Invalid SIDR value. X'00000008' X'0000212A' The CREATE TRAN command is rejected for the transaction, because it specifies a batch program and an attribute value that is not allowed for a batch program such as a PARLIM value other than 65535. Commands, Volume 1: IMS Commands A - M Table 151. Return and reason codes for the CREATE TRAN command (continued) | | | | | | | Return code Reason code Meaning X'00000008' X'00002135' Parlim/schdtype(serial) conflict. If PARLIM is specified and defined with a value other than 65535 and the program is defined as schdtype(serial), the command is rejected. X'00000008' X'00002140' Fast Path exclusive FP(E) is mutually exclusive with any conversation keyword, including CONV(Y), SPASZ, and SPATRUNC. An FP exclusive transaction cannot be defined as conversational. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No Fast Path defined, so FP(E), FP(P), or EMHBSZ > 0 is invalid. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004204' Model is quiesced. Cannot quiesce model. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000010' X'00004310' Storage could not be obtained for the Transaction Input edit routine table. A cold start is required to fix this error. X'00000010' X'00004314' The Transaction Input edit routine could not be loaded. X'00000010' X'00004318' A new Transaction Input edit routine could not be added. The maximum of 255 routines has already been reached. X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. X'00000014' X'00005010' Unable to obtain latch. X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. The following table includes an explanation of the completion codes. Chapter 19. CREATE commands 267 Table 152. Completion codes for the CREATE TRAN command Completion code Completion code text 0 268 Meaning Command completed successfully for transaction. 11 RESOURCE ALREADY EXISTS Transaction already exists. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE PGM or UPDATE PGM) is in progress for the program referenced by this transaction. 22 CPIC TRAN ALREADY EXISTS CPI-C transaction already exists by that name. 36 FP(E)/FP(N) PGM CONFLICT Transaction to be created as Fast Path exclusive FP(E) conflicts with program already defined as non-Fast Path FP(N). 3E FP(N)/FP(E) PGM CONFLICT Transaction to be created as non-Fast Path FP(N) conflicts with program already defined as Fast Path exclusive FP(E). 3F FP(P)/BMPTYPE(Y) CONFLICT Transaction to be created as Fast Path potential FP(P) conflicts with the program defined as batch BMPTYPE(Y). 4E LTERM ALREADY EXISTS LTERM already exists by that name. 5B MSNAME ALREADY EXISTS MSNAME already exists by that name. 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 61 DFSBCB STORAGE ERROR Request to get BCB storage for SMB control block failed. 6A FP(P)/FP(E) PGM CONFLICT Transaction to be created as Fast Path potential FP(P) conflicts with program already defined as Fast Path exclusive FP(E). 78 RM CONFLICT LTERM, CPIC transaction, MSNAME, or descriptor already exists in RM by that name. 8A WILDCARD PARAMETER NOT SUPPORTED The CREATE command does not support wildcard parameters. You must explicitly specify the names of the resources you want to create. 90 INTERNAL ERROR An IMS system service failure. 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. Commands, Volume 1: IMS Commands A - M Table 152. Completion codes for the CREATE TRAN command (continued) Completion code Completion code text Meaning B5 ROUTING CODE ALREADY EXISTS Transaction creation failed for a Fast Path exclusive FP(E) transaction. The routing code could not be created, because one already exists with the same name as the transaction to be created. B6 LATCH ERROR Unable to obtain latch. Examples The following are examples of the CREATE TRAN command: Example 1 for CREATE TRAN command TSO SPOC input: CREATE TRAN NAME(TRN00001,TRN00002) LIKE(RSC(APOL18)) SET(NPRI(6),LPRI(10),TRANSTAT(Y),CLASS(2))) TSO SPOC output: Response Trancode TRN00001 TRN00002 for: CREATE TRAN NAME(TRN00001,TRN00002) LIKE(RSC(APO... MbrName CC IMS1 0 IMS1 0 OM API input: CMD(CRE TRAN NAME(TRN00001,TRN00002) LIKE(RSC(APOL18)) SET(NPRI(6),LPRI(10),TRANSTAT(Y),CLASS(2))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.307 19:23:15.095304</statime> <stotime>2006.307 19:23:15.096942</stotime> <staseq>BFA6CF3A7E308C1C</staseq> <stoseq>BFA6CF3A7E96EA52</stoseq> <rqsttkn1>USRT011 10112315</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> <kwd>TRAN </kwd> <input>CREATE TRAN NAME(TRN00001,TRN00002) LIKE(RSC(APOL18)) SET(NPRI(6),LPRI(10),TRANSTAT(Y),CLASS(2)) </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="2" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" Chapter 19. CREATE commands 269 len="4" dtype="INT" align="right" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>TRAN(TRN00001) MBR(IMS1) CC( 0) </rsp> <rsp>TRAN(TRN00002) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> Explanation: Transactions named TRN00001 and TRN00002 are created like transaction APOL18, with several attributes specified with the SET keyword to override those attributes obtained from transaction APOL18. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 Commit Verify exit routine (Exit Routines) CREATE TRANDESC command Use the CREATE TRANDESC command to create transaction descriptors. A descriptor is a model that can be used to create descriptors or resources. A descriptor is created with a value set for every attribute. Attributes not explicitly specified on the CREATE command take the default value. Any transaction descriptor can be created using this descriptor as a model, by specifying the CREATE command with LIKE(DESC(descriptor_name)). Subsections: v “Environment” v “Syntax” on page 271 v v v v v “Keywords” on page 272 “Usage notes” on page 286 “Output fields” on page 286 “Return, reason, and completion codes” on page 287 “Examples” on page 291 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 153. Valid environments for the CREATE TRANDESC command and keywords 270 Command / Keywords DB/DC CREATE TRANDESC X X LIKE X X NAME X X SET X X Commands, Volume 1: IMS Commands A - M DBCTL DCCTL Syntax , CREATE CRE TRANDESC NAME( name ) LIKE( DESC(descriptor_name) RSC(resource_name) ) , SET( A B ) A: N CMD ) TRAN Y 1 CLASS( class ) SNGL CMTMODE( MULT ) N CONV( Y ) DCLWA( N ) Y DEFAULT( N ) Y N DIRROUTE( Y ) EDITRTN(name) Y EDITUC( N ) EMHBSZ(size) EXPRTIME(seconds) N FP( E ) P N INQ( Y ) 65535 LCT( value ) 1 LPRI( value ) 0 MAXRGN( number ) MULTSEG MSGTYPE( SNGLSEG ) MSNAME(name) AOCMD( B: Chapter 19. CREATE commands 271 1 value ) 65535 PARLIM( value ) PGM(name) 65535 PLCT( value ) 6553500 PLCTTIME( hundredths of seconds Y RECOVER( N ) N REMOTE( Y ) N RESP( Y ) 0 SEGNO( number ) 0 SEGSZ( size ) N SERIAL( Y ) SIDL(localsysid) SIDR(remotesysid) SPASZ(size) SPATRUNC( R ) S N TRANSTAT( Y ) N WFI( Y ) NPRI( ) Default values shown in this syntax diagram reflect the default values that are defined in the IMS transaction descriptor, DFSDSTR1. If you define another descriptor as the default with a CREATE or UPDATE TRANDESC command, the default values shown in this syntax diagram might not match the value defined in the current default descriptor. Keywords The following keywords are valid for the CREATE TRANDESC command: LIKE Specifies that the descriptor is created using an existing descriptor as a model, instead of the default descriptor. The default descriptor is either the IMS descriptor DFSDSTR1, or user-defined. The model type can either be a descriptor (DESC), or a resource (RSC). The descriptor is created with all the same attributes as the model, except for the DEFAULT(Y) value and the CPRI value, which is a runtime scheduling value that does not apply to transaction descriptors. Attributes set explicitly by the CREATE command override the model attributes. DEFAULT(Y) must be specified explicitly to make a descriptor the default descriptor. Later changes to the model are not propagated to resources or descriptors that were created from it. The QUERY commands can be used to display the model name and model type used to create the descriptor or resource. The model name and type returned from the QUERY command are provided for informational purposes only. The EXPORT command exports a resource definition including the model name and model type to the definition member. The IMPORT command imports a resource definition including the model name and model type from 272 Commands, Volume 1: IMS Commands A - M the definition member. An IMPORT command that creates a resource saves the model name and model type, but does not use the models attributes. DESC(descriptor_name) Specifies the name of the descriptor to use as a model to define this descriptor. RSC(resource_name) Specifies the name of the resource to use as a model to define this descriptor. NAME Specifies the 1-8 character name of the transaction. Names must be alphanumeric (A through Z, 0 through 9, #, $, and @). Names cannot include a blank, comma, period, hyphen, or equal sign. Names cannot begin with DFS, except for DFSIVPxx and DFSSAMxx. Names cannot be BASICEDT, DBCDM, DBRC, ISCEDT, MSDB, SDB, or WTOR. A transaction resource and a transaction descriptor can have the same name. A transaction cannot have the same name as a logical terminal. SET Specifies the attributes of the transaction to be created. If the LIKE keyword is omitted, attributes not specified take the value defined in the default descriptor, which is either the IMS descriptor DFSDSTR1, or user-defined. If the LIKE keyword is specified, attributes not specified take the value defined in the model. A transaction must have the same characteristics in all systems where it is defined when it is shared. These characteristics include: v Nonconversational or conversational v SPA size if conversational v Single- or multi-segment messages v Noninquiry or inquiry v Recoverable or nonrecoverable v Response mode or non-response mode v Fast Path exclusive, Fast Path potential, or non-Fast Path AOCMD Specifies the AOI option indicating whether the transaction can issue the type-1 AOI CMD call or the type-2 AOI ICMD call. If AOCMD is defined as CMD, TRAN, or Y, and the AOI1 execute parameter is defined as AOI1=N, no authorization checking is done, and the transaction is permitted to issue CMD and ICMD calls. N Indicates that the transaction is not permitted to issue type-1 AOI CMD calls. The transaction is permitted to issue type-2 AOI ICMD calls. CMD Indicates that the transaction is permitted to issue type-1 AOI CMD calls and type-2 AOI ICMD calls. If the AOI1 execute parameter is defined as C, R, or A, authorization checking is based on which transactions can issue a particular command. In this case, the commands (or the first three characters of the commands) need to be defined to RACF or an equivalent product as a user. The type-1 AOI transactions must be defined as profiles under the TIMS class, and for each transaction, the commands it can issue must be specified. Defining AOCMD(CMD) requires you to create fewer Chapter 19. CREATE commands 273 user IDs than you need to create for the AOCMD(TRAN) definition. However, defining AOCMD(CMD) requires you to create or modify a larger number of resource profiles. TRAN Indicates that the transaction is permitted to issue type-1 AOI CMD calls and type-2 AOI ICMD calls. If the AOI1 execute parameter is defined as C, R, or A, the transaction code is used for authorization. The first authorization check results in the accessor environment element (ACEE) being built. This environment is kept for use by future authorization checks. The type-1 AOI transaction needs to be defined to RACF or an equivalent product as a user. The transactions will then be specified on RACF PERMIT statements for each command they are allowed to issue from a type-1 AOI transaction. Specifying AOI transactions as users to RACF might conflict with the name of a user already defined to RACF. If this occurs, then either the transaction name or the existing user name needs to be changed. Y Indicates that the transaction is permitted to issue type-1 AOI CMD calls and type-2 AOI ICMD calls. If the AOI1 execute parameter is defined as C, R, or A, the user ID or the program name is used for authorization. For some environments, if a Get Unique call has not yet occurred, the program name is used for authorization. CLASS Specifies the transaction class, which is an attribute used to select a transaction for scheduling. A transaction can be scheduled if there is a message processing region available for that class. The value can be a number from 1 to 999. The default is 1. This value must not exceed the value given (by specification or default) on the MAXCLAS= keyword of the IMSCTRL macro. Define CPI-C transactions with a different message class from that used for non-CPI-C transactions. IMS handles all CPI-C transactions as priority zero within the transaction class. CMTMODE Specifies when database updates and non-express output messages are committed. This operand affects emergency restart. MULT Database updates and non-express output messages are committed only when the application program terminates normally, when the processing limit count has been reached, or, in the case of a pseudo-WFI dependent region, when there are no more messages on the queue. For example, if five transactions are processed during a single schedule of a program, all five are committed only when the fifth one is completed and the program terminates. Until a transaction has been committed, locks for updated database records are not released and non-express output messages are not queued for output. If an application ends abnormally before committing its messages, emergency restart requeues all the messages that were processed within the commit scope and makes them available for reprocessing. If the transaction results in the application calling an external subsystem, such as DB2, the Commit Verify exit provided by the external subsystem can determine whether CMTMODE(MULT) is supported. See documentation under the Commit Verify exit routine in IMS Version 13 Exit Routines. 274 Commands, Volume 1: IMS Commands A - M SNGL Database updates and non-express output messages are committed when the application program completes processing each transaction. IMS invokes commit processing either when the application program requests the next message (issues a GU to the IO-PCB), or when the application program terminates. If an application ends abnormally before committing its message, emergency restart requeues the message that was in process before the abend and makes it available for reprocessing. This is the default. The TRANSACT macro MODE keyword uses a default of MULT. The CRE TRAN command CMTMODE keyword uses a default of SNGL. Keyword combination rules include the following: v CONV(Y) and CMTMODE(MULT) are mutually exclusive. v CMTMODE(MULT) and WFI(Y) are mutually exclusive. CONV Specifies the conversation option. N The transaction is not conversational. This is the default. Y The transaction is conversational. The transaction message is destined for a conversational program. A conversational program processes transactions made up of several steps. A conversational program receives a message from a terminal, replies to the terminal, but saves the data from the transaction in a scratchpad area (SPA). When the person at the terminal enters more data, the program has the data it saved from the last message in the SPA, so it can continue processing the request without the person at the terminal having to enter the data again. Keyword combination rules include the following: v v v v CMTMODE(MULT) and CONV(Y) are mutually exclusive. CONV(Y) requires SPASZ and SPATRUNC. INQ(Y) and CONV(Y) are mutually exclusive. RECOVER(N) and CONV(Y) are mutually exclusive. v SPASZ and CONV(N) are mutually exclusive. v SPATRUNC and CONV(N) are mutually exclusive. DCLWA Specifies the log write-ahead option. If not specified, the value is defined to be the DCLWA parameter in the DFSDFxxx PROCLIB member. If DCLWA is not defined in the DFSDFxxx PROCLIB member, the default is DCLWA=Y. N IMS should not perform log write-ahead. Specify N if input message integrity and the consistency of output messages with associated database updates is not required. DCLWA does not apply to response mode or Fast Path input processing, and is ignored during IMS execution. Y IMS should perform log write-ahead for recoverable, nonresponse input messages and transaction output messages. This ensures the following: v A nonresponse input transaction is made recoverable across IMS failures before IMS acknowledges receipt of the input. v Database changes are made recoverable before IMS sends associated output reply messages. Chapter 19. CREATE commands 275 v Information in the log buffers is written to the IMS log, before the associated input acknowledgment or output reply is sent to the terminal. Define DCLWA(Y) for all VTAM terminal types. DEFAULT Specifies whether the descriptor is the default. N The descriptor is not the default. Y The descriptor is the default, which resets the existing default descriptor to DEFAULT(N). When a descriptor or resource is created without the LIKE keyword, any attribute not specified on the CREATE command takes the value defined in the default descriptor. Only one descriptor can be defined as the default for a resource type. IMS defines a default transaction descriptor called DFSDSTR1, where all attributes are defined with the default value. Defining a user-defined descriptor as the default overrides the IMS-defined descriptor. Since only one transaction descriptor can be the default at one time, only one transaction name can be specified with DEFAULT(Y). DIRROUTE Specifies the MSC directed routing option. N The application program processing a transaction is not informed of the system which originated the transaction. The name of the originating LTERM is placed in the I/O PCB. This is the default. Y The application program processing a transaction is informed of the system which originated the transaction, if MSC directed routing is used in a multiple IMS system configuration. An MSNAME corresponding to a logical path back to the originating system is placed in the I/O PCB. EDITRTN Specifies the one- to eight-character name of your transaction input edit routine that edits messages before the program receives the message. This name must begin with an alphabetic character. The specified edit routine (load module) must reside on the USERLIB data set. This routine cannot be the same as the one defined by the system definition TYPE EDIT= parameter. A maximum of 255 input edit routines are supported. EDITRTN is used for a Fast Path potential transaction when the transaction is routed to IMS. For input from LU 6.2 devices, the user edit exit routine DFSLUEE0 is called instead of the transaction input edit routine specified in EDITRTN. Keyword combination rules include the following: v FP(E) and EDITRTN are mutually exclusive. EDITUC Specifies the edit to uppercase option. N The input data is not translated to uppercase. It can consist of upper and lowercase characters as entered from the terminal. Y The input data is to be translated to uppercase before it is presented to the processing program. If FP(E) or FP(P), the transaction is to be translated to uppercase before being presented to the edit/routing exit routine. This is the default. Specifying EDITUC(Y) for VTAM terminals prevents the transmission of embedded device control characters. 276 Commands, Volume 1: IMS Commands A - M EMHBSZ Specifies the EMH buffer size required to run the Fast Path transaction. This overrides the EMHL execution parameter. If EMHBSZ is not specified, the EMHL execution parameter value is used. The value can be a number from 12 to 30720. Keyword combination rules include the following: v EMHBSZ>0 requires Fast Path to be defined. v FP(N) and EMHBSZ>0 are mutually exclusive. EXPRTIME Specifies the elapse time in seconds that IMS can use to cancel the input transaction. After a transaction is submitted to IMS, the transaction could be delayed for processing because of a stopped transaction or a potential system slow down. In that case, the user or client application could time out before the transaction is processed. When IMS eventually schedules and processes the transaction, the response message is no longer wanted. With the elapse time specified for the transaction, IMS can flag the input transaction as expired so that the system does not waste CPU cycles to process the unwanted transaction. The value can be a number, in seconds, which can range from 0 to 65535. The default is 0, which means that no expiration time is set for this transaction. The transaction expiration attribute is supported by all of the IMS TM interfaces. Restriction: The transaction expiration checking is not performed at the GU time for Fast Path transactions, IMS conversational transactions, and program-to-program switch transactions. FP Specifies the Fast Path option. E The transaction is processed exclusively as Fast Path. A Fast Path routing code by the same name is created. The program must be defined as Fast Path exclusive. N The transaction is not a candidate for Fast Path processing. The program identified by PGM() must be defined as not Fast Path. This is the default. P The transaction is a potential candidate for Fast Path processing. Fast Path-potential transactions must be able to run under two programs: a Fast Path exclusive program a non-Fast Path program. This CREATE TRAN command defines the non-Fast Path program with PGM(). A Fast Path exclusive program should be defined to which this transaction can be routed. Fast Path–potential transactions must be processed by a user edit/routing exit to determine whether the transaction is actually to be processed by IMS Fast Path. If it is to be processed by IMS Fast Path, the edit/routing exit routine associates the transaction with a routing code. This routing code identifies which Fast Path program is to process the transaction. The program defined by PGM() must not be defined as Fast Path exclusive. Keyword combination rules include the following: v EDITRTN and FP(E) are mutually exclusive. v FP(P) and FP(E) require Fast Path to be defined. v MSGTYPE(MULTSEG) and FP(E) are mutually exclusive. v MSGTYPE(MULTSEG) and FP(P) are mutually exclusive. v MSNAME and FP(E) are mutually exclusive. Chapter 19. CREATE commands 277 v v v v v MSNAME and FP(P) are mutually exclusive. RECOVER(N) and FP(E) are mutually exclusive. RECOVER(N) and FP(E) are mutually exclusive. RESP(N) and FP(E) are mutually exclusive. RESP(N) and FP(P) are mutually exclusive. v v v v SIDL and FP(E) are mutually exclusive. SIDL and FP(P) are mutually exclusive. SIDR and FP(E) are mutually exclusive. SIDR and FP(P) are mutually exclusive. INQ Specifies the inquiry option. N This is not an inquiry transaction. This is the default. Y This is an inquiry transaction. If INQ(Y) is specified, you can also specify whether this transaction should be recovered during an IMS emergency or normal restart using the RECOVER() parameter. This should be specified only for those transactions that, when entered, do not cause a change in any database. Programs are prohibited from issuing ISRT, DLET, or REPL calls to a database when scheduled to process a transaction defined as INQ(Y). An application program cannot do an SQL INSERT, DELETE, or UPDATE when the IMS transaction is defined with INQ(Y). Keyword combination rules include the following: v CONV(Y) and INQ(Y) are mutually exclusive. v RECOVER(N) and INQ(N) are mutually exclusive. LCT Specifies the limit count. This 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. The value can be a number from 1 to 65535. The default is 65535. The limit count value is ignored for a transaction processed by a BMP. The limit count value is ignored in a shared queues environment. LPRI Specifies the limit priority. This is the scheduling 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. The scheduling priority is an attribute used to select a transaction for scheduling. A transaction of higher priority is scheduled before a lower priority one, if they are defined with the same class. The value can be a number from 0 through 14. The default is 1. When the limit priority is used and the scheduling priority is raised to the limit priority, the priority is not reduced to the normal priority until all messages enqueued for this transaction name are processed. If you do not want the limit priority for this transaction, define equal values for the normal priority and limit priority, and a limit count of 65535. When a transaction is processed exclusively by a batch message program (BMP), define the limit priority as 0. If the program specified by PGM() is 278 Commands, Volume 1: IMS Commands A - M defined with a program type of batch, the current priority is forced to be 0. However, a batch message processing region (BMP) can process transactions with current scheduling priorities other than 0. This priority also controls the priority of messages created by this transaction and sent to a destination in a remote system. See also the discussion on MSC priorities under the NPRI definition. The limit priority value is ignored for a transaction processed by a BMP. The limit priority value is ignored in a shared-queues environment. MAXRGN | | | | | | Specifies the maximum region count. This count value limits the number of message processing program (MPP) regions that can be concurrently scheduled to process a transaction. When the number of MPP regions is not limited, one transaction might monopolize all available regions. The value can be a number from 0 to the value specified on the MAXPST= control region parameter. The default of MAXRGN(0) means that no limit is imposed. | | If you define the program with a scheduling type of SERIAL, omit the MAXRGN keyword or define it as 0. The following keyword combinations are mutually exclusive: v PARLIM(65535) and MAXRGN value greater than 0 v SERIAL(Y) and MAXRGN value greater than 0 MSGTYPE Specifies the message type (single segment or multiple segment). It specifies the time at which an incoming message is considered complete and available to be routed to an application program for subsequent processing. If MSC-directed routing is used in a multiple IMS system configuration, IMS does not ensure that both the message and the transaction destined to process that message are either single segment or multiple segments. MULTSEG The incoming message can be more than one segment in length. It is not eligible for scheduling to an application program until an end-of-message indication is received, or a complete message is created by MFS. This is the default. SNGLSEG The incoming message is one segment in length. It becomes eligible for scheduling when the terminal operator indicates end-of-segment. Keyword combination rules include the following: v FP(E) and MSGTYPE(MULTSEG) are mutually exclusive. v FP(P) and MSGTYPE(MULTSEG) are mutually exclusive. MSNAME Specifies the one- to eight-character name of the logical link path in a multiple IMS system configuration (MSC). A logical link path is a path between any two IMS systems. The IMS systems are identified by the remote system ID and the local system ID associated with the logical link path. The remote system ID identifies the system in which messages using this path are to be processed. The local system ID identifies this system. If this transaction is exported, the Chapter 19. CREATE commands 279 local and remote system IDs are exported, not the msname. For a CREATE TRAN command adding a remote transaction, the MSNAME must already be defined. Keyword combination rules include the following: v FP(E) and MSNAME are mutually exclusive. v FP(P) and MSNAME are mutually exclusive. v SIDL and MSNAME are mutually exclusive. v SIDR and MSNAME are mutually exclusive. NPRI Specifies the normal scheduling priority. The scheduling priority is an attribute used to select a transaction for scheduling. A transaction of higher priority is scheduled before a lower priority one, if they are defined with the same class. When a transaction resource is created, the current priority (CPRI), or the scheduling priority, is initialized to the normal priority (NPRI). The normal priority is also assigned to a transaction as the current priority when the number of input transactions enqueued and waiting to be processed is less than the limit count value. The value can be a number from 0 through 14. The default is 1. This priority also controls the priority of messages created by this transaction and sent to a destination in a remote system. When a transaction is processed exclusively by a batch message program (BMP), code the normal priority as 0. When a transaction is processed exclusively by a batch message program (BMP), define the limit priority as 0. If the program specified by PGM() is defined with a program type of batch, the current priority is forced to be 0. However, a batch message processing region (BMP) can process transactions with current scheduling priorities other than 0. For remote transactions, the priority used to send the transaction to the processing system, which is termed the MSC link message priority. The three MSC link message priority groups are: v Low v Medium v High The low priority group consists of primary requests in the input terminal system. This group is assigned remote transaction priorities from 0 to 6. The medium group consists of secondary requests, responses, primary requests in an intermediate system, and primary requests in the input terminal system. This group is assigned a remote transaction priority of 7. The high group consists of primary requests in the input terminal system. Messages in this group are assigned remote transaction priorities from 8 to 14. Within each group, messages have a priority based on the current priority value of the transaction or remote transaction in the input terminal system for primary requests, and on the latest processing system for secondary requests and responses. In an MSC configuration, the transaction priority determines the priority used to send messages inserted by this transaction across an MSC link. If the transaction inserts multiple messages to the same destination (for example, pages to a printer) and these messages must be sent in the order inserted, the normal and limit priority values should be the same. If the normal and limit priority values are not identical, messages inserted at a higher priority than 280 Commands, Volume 1: IMS Commands A - M previously inserted messages could arrive at their destination first. (This restriction does not apply to multiple segments of the same message.) The normal priority value is ignored for a transaction processed by a BMP. PARLIM Specifies the parallel processing limit count. This 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. This is the threshold value to be used when the associated program is defined with a scheduling type of parallel. An additional region is scheduled whenever the current transaction enqueue count exceeds the PARLIM value multiplied by the number of regions currently scheduled for this transaction. The value can be a number from 0 to 32767 or 65535. PARLIM(0) indicates that any input message can cause a new region to be scheduled because the scheduling condition is always being met (the number of messages are greater than zero). If you specify PARLIM(0), you should specify a MAXRGN value to limit the number of regions that can be scheduled to process a particular transaction. PARLIM(65535) means that parallel processing is disabled and IMS allows the transaction to be scheduled in only one region at a time. PARLIM(65535) is the default. The value specified for PARLIM applies to message processing programs (MPPs) only; it is not supported for batch message processing programs (BMPs). If you define the transaction as serial or the program with a scheduling type as SERIAL, define PARLIM(65535). In a shared-queues environment (when the scheduling type is PARALLEL), any PARLIM value other than 65535 causes a new region to be scheduled whenever the successful consecutive GU count exceeds the PARLIM value multiplied by the number of regions currently scheduled for this transaction. For shared-queues environments, the successful consecutive GU count is used instead of the queue count. New regions continue to be scheduled up to the maximum number of regions specified on MAXRGN. Keyword combination rules include the following: v MAXRGN>0 and PARLIM(65535) are mutually exclusive. v SERIAL(Y) and PARLIM value 0 - 32767 are mutually exclusive. PGM Specifies the name of the program associated with the transaction. For a CREATE TRANDESC command, the program does not need to exist until a CREATE TRAN command creates a transaction using the transaction descriptor. PLCT Specifies the processing limit count. This is maximum number of messages sent to the application program by IMS for processing without reloading the application program. The value must be a number from 0 through 65535. PLCT(0) means the maximum number of messages sent to the application is one and the application program is reloaded before receiving a subsequent message. PLCT(65535) means that no limit is to be placed upon the number of messages processed at a single program load. Values 1 through 65535 are eligible for quick reschedule processing. The default is 65535. Chapter 19. CREATE commands 281 The value is used to determine how many messages an application program is allowed to process in a single scheduling cycle. When the application program requests, and receives, the number of messages indicated, any subsequent requests result in one of two actions. v IMS indicates “no more messages exist” if any of the following conditions is true: – The region is not an MPP. – The currently scheduled mode is not CMTMODE(SNGL). – Equal or higher priority transactions are enqueued for the region. IMS might have other messages enqueued for the application program. It is the responsibility of the application program to terminate when it receives an indicator that no more messages are available. Termination of the application program makes the region it occupied available for rescheduling. This feature makes it possible for IMS to enable scheduling of higher priority transactions that entered the system while the previous transactions were in process. In addition, if any equal-priority transactions are enqueued, they become eligible for scheduling on a first-in, first-out (FIFO) basis. v The region goes through quick reschedule and returns the next message to the application if all of the following conditions are true: – The region is an MPP. – The transaction is CMTMODE(SNGL). – No equal or higher transactions are enqueued. – Messages are still enqueued for the application program. PLCTTIME Specifies the processing limit count time. This is the amount of time (in hundredths of seconds) allowable to process a single transaction (or message). The number specifies the maximum CPU time allowed for each message to be processed in the message processing region. Batch Message Programs (BMPs) are not affected by this setting. The value can be a number, in hundredths of seconds, that can range from 1 to 6553500. A value of 6553500 means no time limit is placed on the application program. The default is 6553500. If Fast Path is used this specifies, for a given transaction name, the amount of time (in hundredths of seconds) the program is allowed to process a single transaction message. The time represents real time that elapses during transaction processing (not accumulated task time). Real time is used because the input terminal is in response mode and cannot enter another transaction until the response is sent. In this case PLCT() is ignored. The value controls application program looping. You are not required to optimize the value for program-transaction execution time. However, the time value assigned should not be less than the expected per-transaction execution time. If the scheduled application program exceeds the product of PLCTTIME() and PLCT(), the application program ends abnormally. If an IMS STIMER value of 2 is specified on the DFSMPR procedure, the region does not abend until completion of the DL/I call. Important: The application program must not use STIMER timer services. IMS uses STIMER timer services to time the execution of transactions. If an 282 Commands, Volume 1: IMS Commands A - M application program issues an MVS STIMER macro, it cancels the STIMER timer services set by IMS. Use the STIMERM macro instead for application program timer requests. RECOVER Specifies the recovery option. N The transaction should not be recovered. Y The transaction should be recovered during IMS emergency or normal restart. This is the default. Keyword combination rules include the following: v CONV(Y) and RECOVER(N) are mutually exclusive. v FP(E) and RECOVER(N) are mutually exclusive. v FP(P) and RECOVER(N) are mutually exclusive. v INQ(N) and RECOVER(N) are mutually exclusive. REMOTE Specifies the remote option. N The transaction is not remote. The transaction is local and runs on the local system. This is the default. Y The transaction is remote. The transaction runs on a remote system. Keyword combination rules include the following: v REMOTE(Y) requires MSNAME or SIDR and SIDL. RESP Specifies the response-mode option. N The transaction is not response mode. For terminals specifying or accepting a default of OPTIONS=TRANRESP, input should not stop after this transaction is entered. This is the default. Y The transaction is response mode. The terminal from which the transaction is entered is held and prevents further input until a response is received. For terminals specifying or accepting a default of OPTIONS=TRANRESP, no additional messages are to be allowed after this transaction is entered until this transaction sends a response message back to the terminal. Response mode can be forced or negated by individual terminal definition. RESP(Y) is ignored during online processing for all terminals that do not operate in response mode. Keyword combination rules include the following: v FP(E) and RESP(N) are mutually exclusive. v FP(P) and RESP(N) are mutually exclusive. SEGNO Specifies the segment number. This is the maximum number of application program output segments that are allowed into the message queues per Get Unique (GU) call from the application program. The value can be a number from 0 through 65535. The default is 0. If SEGNO(0) is defined, the number of segments is not checked by the online system at execution time. SEGSZ Chapter 19. CREATE commands 283 Specifies the segment size. This is the maximum number of bytes allowed in any one output segment. The value can be a number from 0 through 65535. The default is 0. If SEGSZ(0) is defined, the segment size is not checked by the online system at execution time. The maximum output message segment to an LU 6.2 device is 32767. If a transaction is expected to send output to an LU 6.2 device, the SEGSIZE parameter should be no greater than 32767. However, this is not enforced during processing of the command, because IMS cannot determine the device type for the message destination until output time. SERIAL Specifies the serial option. N Messages for the transaction are not processed serially. Message processing can be processed in parallel. Messages are placed on the suspend queue after a U3303 pseudoabend. Scheduling continues until repeated failures result in the transaction being stopped with a USTOP. This is the default. Y Messages for the transaction are processed serially. U3303 pseudoabends do not cause the message to be placed on the suspend queue but rather on the front of the transaction message queue, and the transaction is stopped with a USTOP. The USTOP of the transaction is removed when the transaction or the class is started with a /START or UPD TRAN command. Keyword combination rules include the following: v MAXRGN>0 and SERIAL(Y) are mutually exclusive. v PARLIM value 0 - 32767 and SERIAL(Y) are mutually exclusive. SIDL Specifies the system identification (SYSID) of the local system in a multiple-IMS system (MSC) configuration. The local system is the originating system to which responses are returned. The value can be a number from 1 to 2036. The local SYSID can be defined in any or all of the MSNAMEs or transactions. For a local transaction where SIDL is not specified, SIDL is defined with a value of the lowest system ID when MSC is enabled on this system, or SIDL is defined with a value of 0 when MSC is not enabled on this system. The local system ID and remote system ID are the same for local transactions. The SIDL parameter is independent of the link type (CTC, MTM, TCP/IP, VTAM) specified on the TYPE= keyword of the MSPLINK macro statement. Keyword combination rules include the following: v FP(E) and SIDL are mutually exclusive, unless SIDL and SIDR are specified as a pair and are equal to the local system ID of this IMS. v FP(P) and SIDL are mutually exclusive. v MSNAME and SIDL are mutually exclusive. v SIDL value must be defined to this IMS. SIDR Specifies the system identification (SYSID) of the remote system in a multiple-IMS system (MSC) configuration. The remote system is the system on which the application program executes. The value can be a number from 1 to 2036. The remote SYSID specified must also be defined for an MSNAME. 284 Commands, Volume 1: IMS Commands A - M For a local transaction where SIDR is not specified, SIDR is defined to be the same value as SIDL. The SIDR parameter is independent of the link type (CTC, MTM, TCP/IP, VTAM) specified on the TYPE= keyword of the MSPLINK macro statement. Keyword combination rules include the following: v FP(E) and SIDR are mutually exclusive, unless SIDL and SIDR are specified as a pair and are equal to the local system ID of this IMS. v FP(P) and SIDR are mutually exclusive. v MSNAME and SIDR are mutually exclusive. v SIDR value must be defined to this IMS. SPASZ Specifies the scratchpad area (SPA) size, in bytes, for a conversational transaction. The value can be a number from 16 and 32767. CONV(N) and SPASZ are mutually exclusive. SPATRUNC Specifies the scratchpad area (SPA) truncation option of a conversational transaction. This defines whether the SPA data should be truncated or preserved across a program switch to a transaction that is defined with a smaller SPA. If not specified for a conversational transaction, the value is defined to be the TRUNC parameter in DFSDCxxx. When a conversation initially starts, and when a program is switched, the SPATRUNC option is checked and set or reset as specified. When the option is set, it remains set for the life of the conversation, or until a program switch occurs to a transaction that specifies the option is to be reset. When a program switch occurs, the truncated data option for the new transaction is first checked, and that specification is set for the conversation and is used for the SPA inserted into the output message. If the option is not specified for the new transaction, the option currently in effect for the conversation is used. S IMS preserves all of the data in the SPA, even when a program switch is made to a transaction that is defined with a smaller SPA. The transaction with the smaller SPA does not see the truncated data, but when the transaction switches to a transaction with a larger SPA, the truncated data is used. R The truncated data is not preserved. Keyword combination rules include the following: v CONV(N) and SPATRUNC are mutually exclusive. TRANSTAT Specifies whether transaction level statistics should be logged for message driven programs. If Y is specified, transaction level statistics are written to the log in a X'56FA' log record. N Transaction level statistics should not be logged. Y Transaction level statistics should be logged. The TRANSTAT keyword is optional. If a value is not specified for the TRANSTAT keyword, the system default is used. The system default for the transaction level statistics parameter is set with the TRANSTAT parameter in Chapter 19. CREATE commands 285 the DFSDFxxx PROCLIB member. If a value is not specified for the TRANSTAT parameter, the system default is set to N. The TRANSTAT keyword on the CREATE TRAN or CREATE TRANDESC command gives the user the ability to override the system default when creating a transaction or transaction descriptor. WFI Specifies the wait-for input option. This attribute does not apply to Fast Path transactions, which always behave as wait-for-input transactions. N This is not a wait-for-input transaction. This is the default. Y This is a wait-for-input transaction. A message processing or batch processing application program that processes WFI transactions is scheduled and invoked normally. If the transaction to be processed is defined as WFI, the program is allowed to remain in main storage after it has processed the available input messages. The QC status code (no more messages) is returned to the program if the processing limit count (PLCT) is reached; a command is entered to change the status of the scheduled transaction, database, program, or class; commands relating to the databases used by the transaction are entered, or IMS is terminated with a checkpoint shutdown. CMTMODE(MULT) and WFI(Y) are mutually exclusive. Usage notes Descriptors exist for the life of the IMS unless they are deleted using a DELETE command. Descriptors are recoverable across an IMS warm start or emergency restart. Descriptors are lost if IMS is cold started, unless cold start imports definitions that were exported while IMS was up. The CREATE TRANDESC command is similar to local online change (using a /MODIFY command) or global online change (using an INITIATE OLC command) for transaction resources in the MODBLKS data set, except that transactions are added dynamically. The CREATE TRANDESC command can be issued only through the Operations Manager API. These commands apply to DB/DC and DCCTL systems. These commands are not valid on the XRF alternate, RSR tracker, or FDBR region. The CREATE command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). Output fields The following table shows the CREATE TRANDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. The value error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. 286 Commands, Volume 1: IMS Commands A - M Table 154. Output fields for the CREATE TRANDESC command Short label Keyword Meaning CC N/A Completion code. CCTXT error Completion code text that briefly explains the meaning of the non-zero completion code. DESC TRANDESC Transaction descriptor name. MBR N/A IMSplex member that built the output line. OLDDEF TRANDESC Old default descriptor name, if this descriptor is made the default by specifying DEFAULT(Y). The old default descriptor is no longer the default. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 155. Return and reason codes for the CREATE TRANDESC command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000008' X'0000204C' The class value is invalid. X'00000008' X'00002050' The current priority CPRI value is invalid. X'00000008' X'00002054' The limit count LCT value is invalid. X'00000008' X'00002058' The limit priority LPRI is invalid. X'00000008' X'0000205C' The maximum region MAXRGN is invalid. X'00000008' X'00002060' The normal priority NPRI value is invalid. X'00000008' X'00002064' The parallel limit count PARLIM value is invalid. X'00000008' X'00002068' The processing limit count PLCT is invalid. X'00000008' X'0000206C' The segment number SEGNO value is invalid. X'00000008' X'00002070' The segment size SEGSZ value is invalid. X'00000008' X'00002100' CMTMODE(MULT) mutually exclusive with WFI(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002101' CONV(Y) mutually exclusive with CMTMODE(MULT). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002102' CONV(Y) mutually exclusive with INQ(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. Chapter 19. CREATE commands 287 Table 155. Return and reason codes for the CREATE TRANDESC command (continued) 288 Return code Reason code Meaning X'00000008' X'00002103' CONV(N) mutually exclusive with SPASZ>0 or SPATRUNC. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002104' CONV(Y) mutually exclusive with RECOVER(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002105' CONV(Y) requires SPASZ and SPATRUNC. Either SPASZ was not explicitly specified or defined in the model, or SPATRUNC was not explicitly specified or defined in the model. CONV(Y) was either explicitly specified or defined in the model. X'00000008' X'00002108' Invalid EDITRTN name. EDITRTN was specified explicitly or obtained from the model. X'00000008' X'00002109' Maximum 255 edit routines exceeded. EDITRTN was specified explicitly or obtained from the model. X'00000008' X'0000210C' FP(E) mutually exclusive with EDITRTN. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000210E' FP(E) or FP(P) mutually exclusive with MSC keyword, either MSNAME or SIDR and SIDL. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000210F' FP(E) or FP(P) mutually exclusive with MSGTYPE(MULTSEG). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002110' FP(N) mutually exclusive with EMHBSZ > 0. Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002111' FP(E) or FP(P) mutually exclusive with RECOVER(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002112' FP(E) or FP(P) mutually exclusive with RESP(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002116' INQ(N) mutually exclusive with RECOVER(N). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002117' Invalid LIKE descriptor name. X'00000008' X'00002118' Invalid LIKE resource name. Commands, Volume 1: IMS Commands A - M Table 155. Return and reason codes for the CREATE TRANDESC command (continued) Return code Reason code Meaning X'00000008' X'00002119' MSC keyword MSNAME or SIDR and SIDL are mutually exclusive with application program defined as Fast Path exclusive (FP(E)) associated with this transaction. X'00000008' X'0000211A' Invalid MSNAME name. X'00000008' X'0000211B' MSNAME mutually exclusive with SIDR and SIDL. X'00000008' X'0000211D' MAXRGN>0 mutually exclusive with PARLIM(65535). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'0000211E' MAXRGN>0 mutually exclusive with SERIAL(Y). Either keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002120' PGM() definition missing. PGM must be defined for local transactions either explicitly or in the model. X'00000008' X'00002121' PARLIM value mutually exclusive with SERIAL(Y). Either both keywords were explicitly specified, or one keyword was explicitly specified and the other attribute was obtained from the model. X'00000008' X'00002123' Invalid PGM name. PGM was specified explicitly, or obtained from the model. If the IMS-defined descriptor DFSDSTR1 was used, the command failed because DFSDSTR1 defines no program name. X'00000008' X'00002125' REMOTE(Y) requires MSC keyword MSNAME or SIDR and SIDL. Either MSNAME or SIDR and SIDL were not explicitly specified or defined in the model. REMOTE(Y) was either explicitly specified or defined in the model. X'00000008' X'00002126' Invalid SIDL value. X'00000008' X'00002127' SIDL/SIDR must be specified as a pair. Either SIDL was specified alone or SIDR was specified alone. X'00000008' X'00002128' Invalid SIDR value. X'00000008' X'00002133' Multiple name parameters were specified with DEFAULT(Y). Only one descriptor can be the default at one time. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No Fast Path defined, so FP(E), FP(P), or EMHBSZ > 0 is invalid. Chapter 19. CREATE commands 289 Table 155. Return and reason codes for the CREATE TRANDESC command (continued) | | | | | | | Return code Reason code Meaning X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004204' Model is quiesced. Cannot quiesce model. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000010' X'00004310' Storage could not be obtained for the Transaction Input edit routine table. A cold start is required to fix this error. X'00000010' X'00004314' The Transaction Input edit routine could not be loaded. X'00000010' X'00004318' A new Transaction Input edit routine could not be added. The maximum of 255 routines has already been reached. X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. X'00000014' X'00005010' Unable to obtain latch. X'00000014' X'00005114' Resource or descriptor that is specified as a model is in the process of being imported from the change list in the IMSRSC repository or was not imported successfully from the change list at the end of IMS restart. This resource or descriptor cannot be referenced as a model on a CREATE command until it is successfully imported from the repository. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 156. Completion codes for the CREATE TRANDESC command Completion code Completion code text 0 290 Meaning Command completed successfully for transaction descriptor. 11 RESOURCE ALREADY EXISTS Transaction descriptor already exists. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE PGM or UPDATE PGM) is in progress for the program referenced by this transaction. 36 FP(E)/FP(N) PGM CONFLICT Transaction to be created as Fast Path exclusive FP(E) conflicts with program already defined as non-Fast Path FP(N). 3E FP(N)/FP(E) PGM CONFLICT Transaction to be created as non-Fast Path FP(N) conflicts with program already defined as Fast Path exclusive FP(E). Commands, Volume 1: IMS Commands A - M Table 156. Completion codes for the CREATE TRANDESC command (continued) Completion code Completion code text Meaning 3F FP(P)/BMPTYPE(Y) CONFLICT Transaction to be created as Fast Path potential FP(P) conflicts with the program defined as batch BMPTYPE(Y). 5F INVALID CHARACTERS IN NAME Name is invalid because it contains an invalid character. 61 DFSBCB STORAGE ERROR Request to get BCB storage for SMB control block failed. 8A WILDCARD PARAMETER NOT SUPPORTED The CREATE command does not support wildcard parameters. You must explicitly specify the names of the descriptors you want to create. 93 RESERVED NAME Name is reserved. For example, name starts with DFS (except for DFSSAMxx or DFSIVPxx), or is an IMS reserved name such as BASICEDT or WTOR. Examples The following are examples of the CREATE TRANDESC command: Example 1 for CREATE TRANDESC command TSO SPOC input: CRE TRANDESC NAME(CONVDESC) LIKE(RSC(CDEBTRNA)) SET(CONV(Y),SPASZ(128),SPATRUNC(R),PGM(DFSSAM04),DEFAULT(Y)) TSO SPOC output: DescName MbrName CONVDESC IMS1 CC OldDefault 0 DFSDSTR1 OM API input: CMD(CRE TRANDESC NAME(CONVDESC) LIKE(RSC(CDEBTRNA)) SET(CONV(Y),SPASZ(128),SPATRUNC(R),PGM(DFSSAM04),DEFAULT(Y))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.307 18:52:58.805900</statime> <stotime>2006.307 18:52:58.806677</stotime> <staseq>BFA6C8765828C44A</staseq> <stoseq>BFA6C8765859584A</stoseq> <rqsttkn1>USRT011 10105258</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>CRE </verb> Chapter 19. CREATE commands 291 <kwd>TRANDESC </kwd> <input>CRE TRANDESC NAME(CONVDESC) LIKE(RSC(CDEBTRNA)) SET(CONV(Y),SPASZ(128),SPATRUNC(R),PGM(DFSSAM04),DEFAULT(Y)) </input> </cmd> <cmdrsphdr> <hdr slbl="DESC" llbl="DescName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="OLDDEF" llbl="OldDefault" scope="LCL" sort="a" key="2" scroll="no" len="8" dtype="CHAR" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>DESC(CONVDESC) MBR(IMS1) CC( 0) OLDDEF(DFSDSTR1) </rsp> </cmdrspdata> </imsout> Explanation: A CREATE TRANDESC command is issued to create a transaction descriptor for conversational transactions. Descriptor CONVDESC takes the same attributes as transaction CDEBTRNA except for the conversation attribute, SPA size, SPA truncate option, and program name. It is also made the default descriptor, so that if no LIKE keyword is specified on a CREATE TRAN or CREATE TRANDESC command, the transaction or descriptor is defined with the attributes in descriptor CONVDESC. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 Commit Verify exit routine (Exit Routines) 292 Commands, Volume 1: IMS Commands A - M Chapter 20. /DBDUMP command Use the /DBDUMP command to prevent transactions or programs from updating DL/I databases. It also can be used to dump all MSDBs to the MSDB dump data set. /DBDUMP does not apply to DEDBs. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 295 v “Equivalent IMS type-2 commands” on page 296 v “Examples” on page 297 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 157. Valid environments for the /DBDUMP command and keywords Command / Keywords DB/DC DBCTL /DBDUMP X X DB X X GLOBAL X X LOCAL X X NOFEOV X X NOPFA X X DCCTL Syntax LOCAL /DBDUMP /DBD DB dbname GLOBAL NOFEOV NOPFA MSDB ALL LOCAL Keywords The following keywords are valid for the /DBDUMP command: DB Specifies the databases to which the /DBDUMP command applies. When the /DBDUMP command is entered, the message processing regions using the specified databases are terminated at the conclusion of processing their current transactions, in preparation to close the database and enable it to be opened for input only. © Copyright IBM Corp. 1974, 2014 293 If a DL/I database specified in the command is being used by a batch message processing region, an error message is returned to the master terminal. When this message is issued, the command is ignored for the database named in the message; processing continues for the other databases specified in the command. The master terminal operator must wait until the batch message processing concludes processing before reentering the command. As the message processing regions terminate programs, the data sets of the named databases in the command are closed. The IMS log switches to the next OLDS. This switch to the next OLDS is marked as a recovery point for log archiving purposes. IMS issues a simple checkpoint. The scheduling of transactions is then resumed, although no transactions will be allowed to update the specified databases. Programs with update intent will be scheduled, but update calls to the database will result in a 3303 pseudoabend or a BA status if the INIT call was issued. /DBDUMP can be used to dump all the MSDBs to the MSDB dump data set by specifying the reserved parameter MSDB with the DB keyword when entering the /DBDUMP DB command or by entering the /DBDUMP DB ALL command. The MSDBs dumped to the MSDB dump data set can be used as input to the MSDB Dump Recovery utility. A specific MSDB cannot be a parameter of the DB keyword. The /START DB command resets the effect of the /DBDUMP command. The /START command is not required for MSDBs, because the data for these databases resides in processor storage, and the databases are never closed. For DBCTL, when CCTL schedules a PSB, the DBCTL thread SCHED request defines the thread as LONG or SHORT. If the database is currently scheduled to a LONG thread, the command is rejected; otherwise, the thread is allowed to “complete” before the database is acted upon. This results in either a commit point or transaction termination. GLOBAL Applies when an IRLM is active and specifies that the command applies to all online subsystems sharing the database. The /DBDUMP command with the GLOBAL keyword puts the database in read status and prevents transactions from updating the database in all online subsystems that share the database. The /DBDUMP GLOBAL command is processed by the IMS system where the command was initiated. The systems will process the command locally and then request IRLM NOTIFY to route and process the command on sharing IMS systems. If global database status is maintained, the global status maintained in RM is also updated. The global status is set to STOUPDS. If the command is entered from OM API, the global status is updated by the command master IMS. If the command is not entered from OM API, the IMS that initiated the GLOBAL command updates the global status in RM. If global status in RM is successfully updated, message DFS0988I for RSRCTYPE=DB is issued. If global status is not successfully updated, message DFS3308I is issued, indicating RM failure, and no command response lines are generated. Any RM error is traced to the OCMD trace table. Users can issue a QRY DB STATUS(GLOBAL) command to set the global status of the resources in RM. The X'4C' log record for databases is updated to include both the global status and global command time stamp. 294 Commands, Volume 1: IMS Commands A - M The GLOBAL keyword is mutually exclusive with the ALL parameter or the MSDB parameter and causes the command to be rejected if both parameters are specified. The GLOBAL keyword requires that IRLM be active and will cause the command to be rejected if IRLM is not active. If the command with GLOBAL is entered from OM API, the command master IMS becomes the initiating system. The command IMS will process the command locally first and then make DBRC calls to update the RECON with GLOBAL status. It will also request IRLM NOTIFY to route and process the command on sharing IMS systems. Messages produced on the NOTIFIED systems will appear only on the system console and will not be routed back to the OM API which originally entered the command. If the command is routed to multiple IMS systems, the non-master IMS systems to which OM routes the command, will reject the command with the return and reason codes shown in the following table. Table 158. Return and reason code for the GLOBAL keyword issued from the OM API Return code Reason code Meaning X'00000004' X'00001000' The command contained the GLOBAL keyword and was routed to more than one IMS system in the IMSPLEX. The non-master IMS systems will reject this command when OM routes the command to them. The master IMS system will process this command and use IRLM NOTIFY to route and process the command on the non-master IMS systems. See the discussion under the GLOBAL keyword. LOCAL Specifies that the command only applies to the subsystem in which the command is entered. This command does not affect any other subsystem sharing the database. The LOCAL keyword can be used to restrict concurrent updates. LOCAL is the default. NOFEOV Specifies that there is no forced end of volume, so that the IMS log does not switch to the next OLDS. If NOFEOV is specified without the MSDB keyword, a simple checkpoint is not taken. NOPFA Specifies that the call to DBRC that sets the Read Only flag in the RECON data set for the database or partition is to be skipped. You can use this keyword when you need to authorize the database for update after the command has been processed. By using this keyword, DBRC does not prevent authorizations for update for the database or partition. NOPFA can be specified only with the GLOBAL keyword. Usage notes The /DBDUMP command can be used on HALDB databases. In an IMSplex, the output of the /DBD command is changed when the command is entered through the OM API. In this case, the DFS058I message is not returned to OM. The command response returned to OM contains one or more of the following messages as appropriate to the database type and the command completion. Chapter 20. /DBDUMP command 295 This command can be issued to an IMSplex using the Batch SPOC utility. Full Function Database messages: DFS132, DFS160, DFS216, DFS0488I, DFS1407, DFS2026, DFS3318I, DFS3320I, DFS3321I, DFS3325I, DFS3462I, DFS3463I, DFS3466I When you enter this command, the database name can be an existing non-HALDB, a HALDB master, or a HALDB partition. A command against a HALDB partition operates exactly like a command against a non-HALDB with the exception of the /START DATABASE and the UPDATE DB START(ACCESS) command. A HALDB partition is not allocated during the command unless it was previously authorized but not allocated, the OPEN keyword was specified, or the partition has EEQEs. The partition is allocated at first reference. | | | | | | | The HALDB partition reflects conditions such as STOPPED (shown as STOACC or STOSCHD or STOUPDS on QUERY DB), LOCKED, or NOTOPEN. When a HALDB partition is stopped, it must be explicitly started again. The type-1 commands with the keyword ALL, type-2 commands with NAME(*), and commands against a HALDB master do not change the STOPPED (shown as STOACC, STOSCHD or STOUPDS on QUERY DB) and LOCKED indicators in each HALDB partition. | | | | | | | | When the command target is a HALDB master, processing acts on all HALDB partitions. For example, if the IMS command is /DBR on the HALDB master, all of the HALDB partitions are closed, deallocated, and deauthorized. On a /DISPLAY DB command, only the HALDB master displays STOPPED (each HALDB partition does not display STOPPED unless it was itself stopped). If a /DBR command was issued against a HALDB master, the display output of a /DISPLAY DB command shows the HALDB master (as STOPPED), but does not display the status of the partitions. Each partition inherits the access limitations of its HALDB master. If the /DBD command is issued against a HALDB master, all of its partitions close. A subsequent reference to any of the partitions results in the partition opening for input, although the partition's access might be UPDATE or EXCLUSIVE. The DBRC authorization state reflects the limited access. Restrictions: v The /DBDUMP DB command cannot be processed against a HALDB partition on an IMS system while HALDB Online Reorganization (OLR) is running against that partition on the same IMS system. v The /DBDUMP DB command cannot be issued against a HALDB master while OLR is reorganizing any of its partitions. v While the database is being quiesced, this command cannot be processed successfully. The /DBDUMP DB command is not allowed for a database that is marked bad with the NOTINIT-48-REPOCHGLIST reason code because the IMS change list processing is not complete for the database or the change list processing failed. | | | Equivalent IMS type-2 commands The following table shows variations of the /DBDUMP command and the IMS type-2 commands that perform similar functions. 296 Commands, Volume 1: IMS Commands A - M Table 159. Type-2 equivalents for the /DBDUMP command. Task /DBDUMP command Similar IMS type-2 command Stops updates to a database. /DBDUMP DB dbname UPDATE DB NAME(dbname) STOP(UPDATES) OPTION(FEOV)1 1 This command does not automatically issue checkpoints unless OPTION(FEOV) is specified. Examples The following are examples of the /DBDUMP command: Example 1 for /DBDUMP command Entry ET: /DBDUMP DATABASE PAYROLL Response ET: DFS058I (time stamp) DBDUMP COMMAND IN PROGRESS Explanation: Currently executing application programs are being terminated. When the termination completes, the databases are stopped for update and the output log is switched to the next OLDS. Response ET: DFS0488I DBD COMMAND COMPLETED. DBN=PAYROLL RC=0 DFS3257I ONLINE LOG NOW SWITCHED FROM DFSOLP( ) TO DFSOLP( ) DFS994I *CHKPT 82080/111213**SIMPLE* Explanation: The new OLDS is used to record a simple checkpoint at 111213 (time) on 82080 (Julian date). The checkpoint number is 82080/111213. All /DBDUMP command functions are complete. The /START DATABASE command must be used to start the database after the dump job completes. Example 2 for /DBDUMP command Entry ET: /DBDUMP DATABASE MSDB Response ET: DFS058I (time stamp) DBDUMP COMMAND IN PROGRESS Explanation: All MSDBs are dumped to the MSDB dump data set because MSDB was specified as the parameter of the database keyword. Response ET: DFS994I CHKPT 82069/123624**SIMPLE* Explanation: A simple checkpoint is recorded on the new system log at 123624 (time) on 82069 (Julian date). The checkpoint number is 82069/123624. All MSDBs are dumped. Related concepts: Maintaining global information for databases, DEDB areas, and transactions (System Administration) Chapter 20. /DBDUMP command 297 Related reference: UPDATE DB command (Commands) 298 Commands, Volume 1: IMS Commands A - M Chapter 21. /DBRECOVERY command Use the /DBRECOVERY command to prevent transactions or programs from accessing DL/I databases, DEDBs, or DEDB areas. Subsections: v “Environment” v “Syntax” v v v v “Keywords” on page 300 “Usage notes” on page 303 “Equivalent IMS type-2 commands” on page 304 “Examples” on page 305 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 160. Valid environments for the /DBRECOVERY command and keywords Command / Keywords DB/DC DBCTL /DBRECOVERY X X AREA X X DB X X DATAGRP X X GLOBAL X X LOCAL X X NOFEOV X X NOPFA X X DCCTL Syntax LOCAL /DBRECOVERY /DBR areaname AREA GLOBAL NOPFA ALL LOCAL LOCAL DB dbname GLOBAL NOPFA ALL LOCAL LOCAL DATAGRP © Copyright IBM Corp. 1974, 2014 datagroupname 299 NOFEOV Keywords The following keywords are valid for the /DBRECOVERY command: AREA Specifies the DEDB areas (but not DEDBs) to be processed by the /DBRECOVERY command. The /DBRECOVERY AREA command stops the accessing and updating of specified DEDB areas and closes them. The /START AREA command can be used to reopen and reallocate the areas closed by /DBRECOVERY AREA command. The /DBRECOVERY command for Fast Path Virtual Storage Option (VSO) areas in a z/OS data space removes the areas from the data space and forces updates to be written back to DASD. While the database is being quiesced, this command cannot be processed successfully. DATAGRP Specifies a group of DL/I databases and Fast Path DEDBs to be processed by the /DBRECOVERY command. Use the INIT.DBDSGRP command with the GRPNAME and DBGRP keywords to define the data group in the RECON data set. DATAGRP is valid on active and RSR tracking subsystems. Recommendation: Although you can use DBDS groups as well as database groups for this command, you should use database groups whenever possible to eliminate the overhead of converting the DBDS group to a database group. DB Specifies the DL/I databases and Fast Path DEDBs (and inclusive areas) to be processed by the /DBRECOVERY command. MSDBs cannot be specified with /DBRECOVERY. The /DBRECOVERY DB command allows scheduling of transactions or programs that use the database to continue after successful completion of the command. However, calls to DEDB databases will receive an FH status code. If the application program is prepared to accept status codes regarding data unavailability through the INIT STATUS GROUPA or GROUPB call, calls to DL/I databases will result in either a 3303 pseudoabend, a BA, or BB status code. When the /DBRECOVERY DB command is entered, the data sets of the databases named in the command are closed. The /DBRECOVERY DB command dynamically deallocates the IMS databases. For DEDBs, the randomizer is unloaded and removed from storage. You can use the UPD DB STOP(ACCESS) OPTION(NORAND) command to prevent the randomizer from being unloaded. If a DL/I database is in use by a batch message processing region when the /DBRECOVERY command is issued, a DFS0565I message is returned to the master terminal, the command is ignored for the database named in the message, and processing continues for any other databases specified in the command. The master terminal operator must wait until the BMP ends before reissuing the /DBRECOVERY command to close the databases named in any DFS0565I messages. DEDB databases will accept the /DBRECOVERY command 300 Commands, Volume 1: IMS Commands A - M while actively being used by a batch message processing region. However, all further calls to the database will receive an FH status code. The region identified in the DFS0565I message can also be an MPP region. The error message can be issued in order to break a potential deadlock condition between Online Change, a /DBR, or /STA command against a database being used by the MPP, and an application running in the MPP issuing an ICMD or CMD call. The /START DB command is used to reallocate the databases closed by the /DBRECOVERY DB command except for HALDB partitions. A HALDB partition can be reallocated if the partition has EEQEs, the partition was previously authorized but not allocated, or the OPEN keyword on the /START DB command was used. HALDB partitions are allocated at first reference. For DEDBs, a /START DB command also causes a reload of the randomizer. For DBCTL, when CCTL schedules a PSB, the DBCTL thread SCHED request defines the thread as LONG or SHORT. If the database is currently scheduled to a LONG thread, the command is rejected; otherwise, the thread is allowed to “complete” before the database is acted upon. This results in either a commit point or transaction termination. On an RSR tracking subsystem, /DBRECOVERY DB for a DEDB is not permitted. While the database is being quiesced, this command cannot be processed successfully. | | | | The /DBRECOVERY DB command is not allowed for a database that is marked bad with the NOTINIT-48-REPOCHGLIST reason code because the IMS change list processing is not complete for the database or the change list processing failed. GLOBAL Applies when the database is registered to DBRC and specifies that the command applies to all sharing online subsystems. You can use the /DBRECOVERY GLOBAL command to close the database so that it can be taken offline when this command successfully completes in all online subsystems. If the database is registered in the RECON data set, the prohibit authorization flag will be set (PROHIBIT AUTH = ON), and DBRC will prevent any further authorization of the database. This is equivalent to the CHANGE.DB DBD(xxx) NOAUTH DBRC command. The /DBRECOVERY GLOBAL command is processed by the IMS system where the command was initiated. This system will process the command locally and then request IRLM NOTIFY to route and process the command on sharing IMS systems. If global DB or AREA status is maintained, the global status maintained in RM is also updated. The global status is set to STOACC. If the command is entered from OM API, the global status is updated by the command master IMS. If the command is not entered from OM API, the IMS that initiated the GLOBAL command updates the global status in RM. If global status in RM is successfully updated, message DFS0988I for RSRCTYPE=DB is issued. If global status is not successfully updated, message DFS3308I is issued, indicating RM failure, and no command response lines are generated. Any RM error is traced to the OCMD trace table. Users can issue a QRY DB STATUS(GLOBAL) or QUERY AREA STATUS(GLOBAL) to obtain the global status of the resources in RM. Chapter 21. /DBRECOVERY command 301 The X'4C' log record for databases is updated to include both global status and global command time stamp. A new log record for DEDB areas, X'594C', includes both global status and global command time stamp. The GLOBAL keyword and the ALL parameter are mutually exclusive. The /DBRECOVERY command will be rejected if both GLOBAL and ALL are specified. The IRLM must be active when the GLOBAL keyword is used. If IRLM is not active, the command is rejected. If the command with GLOBAL is entered from OM API, the command master IMS becomes the initiating system. The command IMS will process the command locally first and then make DBRC calls to update the RECON with GLOBAL status. It will also request IRLM NOTIFY to route and process the command on sharing IMS systems. Messages produced on the NOTIFIED systems will appear only on the system console and will not be routed back to the OM API that originally entered the command. If the command is routed to multiple IMS systems, the non-master IMS systems to which OM routes the command, will reject the command with the return and reason codes shown in the following table. Table 161. Return and reason code for GLOBAL keyword issued from the OM API Return code Reason code Meaning X'00000004' X'00001000' The command contained the GLOBAL keyword and was routed to more than one IMS system in the IMSplex. The non-master IMS systems will reject this command when OM routes the command to them. The master IMS system will process this command and use IRLM NOTIFY to route and process the command on the non-master IMS systems. See the discussion under the GLOBAL keyword. Restriction: When the GLOBAL keyword is specified, the command is performed for the named database only. If the command is to be performed for a HIDAM database and its index, both must be named. The GLOBAL keyword is not supported for an RSR tracking subsystem. The GLOBAL keyword cannot be combined with the DATAGRP keyword. LOCAL Specifies that the command applies only to the subsystem in which the command is entered. This command does not affect any other subsystem sharing the database or area. Use the LOCAL keyword to increase usability for the other system sharing the database or area. LOCAL is the default. NOFEOV Specifies that there is no forced end of volume, so that the log does not switch to the next OLDS and simple checkpoint is not taken. The NOFEOV keyword is the default for an RSR tracking subsystem so that the OLDS is not switched, nor is a simple checkpoint taken. NOPFA Specifies to skip the call to DBRC that sets the Prohibit Authorization flag in the RECON data set for the database or area. You can use this keyword when you need to authorize the database for use after it is offline, for example, for offline utilities. By using this keyword, DBRC does not prevent further authorizations for the database or area. 302 Commands, Volume 1: IMS Commands A - M NOPFA can be specified only with the GLOBAL keyword. Usage notes The /DBRECOVERY command can be used on HALDB databases. Use of the ALL parameter indicates that the command applies to all databases, even those not opened. The /DBRECOVERY command closes and deallocates the databases, and deauthorizes them with DBRC. Once the database or area referenced by /DBRECOVERY is closed, the IMS log switches to the next OLDS (unless you specify the NOFEOV keyword). This switch to the next OLDS is marked as a recovery point for log archiving purposes. IMS issues a simple checkpoint. The /DBRECOVERY command deletes the randomizer routine from memory. /DBRECOVERY is supported on an RSR tracking subsystem, but only for a database readiness level (DLT) subsystem. The /DBRECOVERY command is used on an RSR tracking subsystem to take shadow areas and databases offline for image copy and recovery. The /DBRECOVERY command also stops online forward recovery (OFR) if it is in progress for the specified database or area. IMS databases, DEDBs, and DEDB areas closed by the master terminal operator with the /DBRECOVERY command can be used as input to the offline IMS Database Recovery utility. The Database Recovery utility runs in a batch region. If the /DBRECOVERY command does not deallocate a data set because a VSAM data set hardware error occurred, use the VARY nnn,OFFLINE,FORCE command to deallocate the data set (where nnn is the number of the device). In an IMSplex, the output of the /DBR command is different when the command is entered through the OM API. In this case, the DFS058I message is not returned to OM. The command response returned to OM contains one or more of the following messages as appropriate to the database type and the command completion. v For /DBR AREA commands that specify GLOBAL, only the command master returns the asynchronous messages to OM. When a command is processed with the LOCAL keyword, all IMS systems are able to return the asynchronous messages to OM. v Full-function database messages for /DBR DB: DFS132, DFS160, DFS216, DFS0488I, DFS0565I, DFS1407, DFS2026, DFS3318I, DFS3320I, DFS3321I, DFS3464I, DFS3466I. v Fast Path database messages for /DBR DB: DFS140I, DFS0666I, DFS3062I, DFS3320I. v Fast Path database messages for /DBR AREA: DFS140I, DFS0488I, DFS0666I, DFS1407I, DFS3060I, DFS3062I, DFS3320I, DFS3325I, DFS3342I, DFS3720I. This command can be issued to an IMSplex using the Batch SPOC utility. When you enter this command, the database name can be an existing non-HALDB, a HALDB master, or a HALDB partition. A command against a HALDB partition operates exactly like a command against a non-HALDB except for the /START DB and the UPDATE DB START(ACCESS) commands. A HALDB partition is not Chapter 21. /DBRECOVERY command 303 allocated during the command unless it was previously authorized but not allocated, the OPEN keyword was specified, or the partition has EEQEs. The partition is allocated at first reference. | | | | | | | The HALDB partition reflects conditions such as STOPPED (shown as STOACC or STOSCHD or STOUPDS on QUERY DB), LOCKED, or NOTOPEN. When a HALDB partition is stopped, it must be explicitly started again. The type-1 commands with the keyword ALL, type-2 commands with NAME(*), and commands against a HALDB master do not change the STOPPED (shown as STOACC, STOSCHD or STOUPDS on QUERY DB) and LOCKED indicators in each HALDB partition. | | | | | | | | When the command target is a HALDB master, processing acts on all HALDB partitions. For example, if the IMS command is /DBR on the HALDB master, all of the HALDB partitions are closed, deallocated, and deauthorized. On a /DISPLAY DB command, only the HALDB master displays STOPPED (each HALDB partition does not display STOPPED unless it was itself stopped). If a /DBR command was issued against a HALDB master, the display output of a /DISPLAY DB command shows the HALDB master (as STOPPED), but does not display the status of the partitions. Each partition inherits the access limitations of its HALDB master. If the /DBD command is issued against a HALDB master, all of its partitions close. A subsequent reference to any of the partitions results in the partition opening for input, although the partition's access might be UPDATE or EXCLUSIVE. The DBRC authorization state reflects the limited access. Restrictions: v The /DBRECOVERY DB command cannot be processed against a HALDB partition on an IMS system while HALDB Online Reorganization (OLR) is running against that partition on the same IMS system. v The /DBRECOVERY DB command cannot be issued against a HALDB master while OLR is reorganizing any of its partitions. The NODBR keyword can be specified in the DFSVSMxx member of the IMS PROCLIB data set to prevent a /DBRECOVERY command from processing against a database that has in-doubt EEQEs. NODBR does not apply to Fast Path databases. Equivalent IMS type-2 commands The following table shows variations of the /DBRECOVERY command and the IMS type-2 commands that perform similar functions. Table 162. Type-2 equivalents for the /DBRECOVERY command. Task /DBRECOVERY command Similar IMS type-2 command Stops the accessing and updating of an area. /DBRECOVERY AREA areaname UPDATE AREA NAME(areaname) STOP(ACCESS) Stops the accessing and updating of all areas and databases of the data group. /DBRECOVERY DATAGRP datagrpname UPDATE DATAGRP NAME(datagrpname) STOP(ACCESS) Stops access to the database and take it offline. /DBRECOVERY DB dbname UPDATE DB NAME(dbname) STOP(ACCESS) OPTION(FEOV)1 1 This command does not automatically issue checkpoints unless OPTION(FEOV) is specified. 304 Commands, Volume 1: IMS Commands A - M Examples The following are examples of the /DBRECOVERY command: Example 1 for /DBRECOVERY command Entry ET: /DBRECOVERY AREA ALL Response ET: DFS058I DFS0488I DFS0488I DBRECOVERY COMMAND IN PROGRESS DBRECOVERY COMMAND COMPLETED. AREA=DBAREA0 DBRECOVERY COMMAND COMPLETED. AREA=DBAREA1 Explanation: DEDB areas are being stopped for inquiry and update, closed, and deallocated; the output log is switched to the next OLDS. Example 2 for /DBRECOVERY command Entry ET: /DBRECOVERY DATABASE SKILL Response ET: DFS058I DBRECOVERY COMMAND IN PROGRESS DFS2500I DATABASE SKILL SUCCESSFULLY DEALLOCATED DFS0488I DBRECOVERY COMMAND COMPLETED. DBN=SKILL RC=0 DFS3257I ONLINE LOG NOW SWITCHED FROM DFSOLP( ) TO DFSOLP( ) DFS944I *CHKPT 82123/121314**SIMPLE** Explanation: The new OLDS is used to record a simple checkpoint at 121314 (time) on 82123 (Julian date). The checkpoint number is 82123/121314. All /DBRECOVERY command functions are complete. The Database Recovery utility can be executed after archiving. Currently executing application programs are being terminated. When the termination completes, the SKILL database is stopped for inquiry and update, closed, and deallocated; the output log is switched to the next OLDS. The /START DATABASE command must be used to start the database after the recovery job completes. Example 3 for /DBRECOVERY command This example shows how to stop an online forward recovery (OFR) at the RSR tracking site with a /DBRECOVERY command. Entry ET (on tracking subsystem): /DISPLAY DATABASE OFR Response ET (to tracking subsystem): DATABASE TYPE TOTAL UNUSED BE2PCUST DL/I BE3ORDER DL/I BE3ORDRX DL/I BE3PARTS DL/I BE3PSID1 DL/I *91240/132406* SYS3 TOTAL UNUSED ACC EX EX EX EX EX CONDITIONS ALLOCS OFR ALLOCS OFR ALLOCS OFR ALLOCS OFR ALLOCS OFR Entry ET (on tracking subsystem): /DBRECOVERY DATABASE BE3ORDER BE3PSID1 Chapter 21. /DBRECOVERY command 305 Response ET (to tracking subsystem): DFS058I DBRECOVERY COMMAND IN PROGRESS DFS0488I DBR COMMAND COMPLETED. DBN=BE3ORDER. RC=0 DFS0488I DBR COMMAND COMPLETED. DBN=BE3PSID1. RC=0 Explanation: Databases BE3ORDER and BE3PSID1 are closed, unallocated, and deauthorized with DBRC. Online forward recovery for the databases is also stopped. Example 4 for /DBRECOVERY command This example shows how the /DBRECOVERY command might look when entered from the SPOC. TSO SPOC input: DBR DB BANKATMS BANKTERM BANKLDGR BE3ORDER TSO SPOC output: SYS3 SYS3 SYS3 SYS3 IMS3 IMS3 IMS3 IMS3 DFS0488I DFS0488I DFS0488I DFS0488I DFS0488I DFS0488I DFS0488I DFS0488I DBR DBR DBR DBR DBR DBR DBR DBR COMMAND COMMAND COMMAND COMMAND COMMAND COMMAND COMMAND COMMAND COMPLETED. COMPLETED. COMPLETED. COMPLETED. COMPLETED. COMPLETED. COMPLETED. COMPLETED. DBN= DBN= DBN= DBN= DBN= DBN= DBN= DBN= BANKATMS BANKTERM BANKLDGR BE3ORDER BANKATMS BANKTERM BANKLDGR BE3ORDER OM API input: CMD (DBR DB BANKATMS BANKTERM BANKLDGR BE3ORDER) OM API output: <?xml version="1.0"?> <!DOCTYPE imsout SYSTEM "imsout.dtd"> <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.1.0</omvsn> <xmlvsn>1 </xmlvsn> <statime>2002.197 21:52:02.730359</statime> <stotime>2002.197 21:52:03.383199</stotime> <staseq>B7EFBE716A9770A4</staseq> <stoseq>B7EFBE7209F9FD2F</stoseq> <rqsttkn1>USRT005 10145202</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> </ctl> <cmderr> <mbr name="SYS3 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>00000014</rc> <rsn>00005050</rsn> <rsntext>Command processing error</rsntext> </mbr> <mbr name="IMS3 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>00000014</rc> <rsn>00005050</rsn> <rsntext>Command processing error</rsntext> </mbr> </cmderr> 306 Commands, Volume 1: IMS Commands A - M RC=04 RC=04 RC=04 RC= 0 RC=04 RC=04 RC=04 RC= 0 <cmd> <master>SYS3 </master> <userid>USRT005 </userid> <verb>DBR </verb> <kwd>DB </kwd> <input>/DBR DB BANKATMS BANKTERM BANKLDGR BE3ORDER </cmd> <msgdata> <mbr name="SYS3 "> <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BANKATMS <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BANKTERM <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BANKLDGR <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BE3ORDER </mbr> <mbr name="IMS3 "> <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BANKATMS <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BANKTERM <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BANKLDGR <msg>DFS0488I DBR COMMAND COMPLETED. DBN= BE3ORDER </mbr> </msgdata> </imsout> </input> RC=04</msg> RC=04</msg> RC=04</msg> RC= 0</msg> RC=04</msg> RC=04</msg> RC=04</msg> RC= 0</msg> Explanation: The DBR command is routed from OM to the two active IMS systems -- SYS3 and IMS3. The response from both IMS systems is returned to OM. The databases BANKATMS, BANKTERM, BANKLDGR, and BE3ORDER are taken offline at both IMS systems. Related concepts: Maintaining global information for databases, DEDB areas, and transactions (System Administration) Related reference: “IMS type-1 command format” on page 16 Recovering VSAM data sets DFSVSMxx member of the IMS PROCLIB data set (System Definition) UPDATE AREA command (Commands) UPDATE DATAGRP command (Commands) UPDATE DB command (Commands) Related information: DFS2406I (Messages and Codes) DFS2838I (Messages and Codes) Chapter 21. /DBRECOVERY command 307 308 Commands, Volume 1: IMS Commands A - M Chapter 22. /DELETE command Use the /DELETE command to delete LU 6.2 descriptors, password security authorizations for a given transaction code, logical terminal, relative physical terminal, database, node, or program, and terminal and logical link security for a given transaction code. This command can be issued to an IMSplex using the Batch SPOC utility. Subsections: v “Environment” v “Syntax” v “Keywords” Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 163. Valid environments for the /DELETE command and keywords Command / Keywords DB/DC DBCTL DCCTL /DELETE X X X DESC X X Syntax /DELETE /DEL DESC descriptorname Keywords The following keyword is valid for the /DELETE command: DESC descriptorname Specifies the LU62 descriptor to be deleted. Note that this will not delete the descriptor in the PROCLIB member. It is necessary to remove the descriptor from the PROCLIB member; otherwise, the descriptor will be defined at the next IMS restart. © Copyright IBM Corp. 1974, 2014 309 310 Commands, Volume 1: IMS Commands A - M Chapter 23. DELETE commands Use the IMS DELETE commands to delete Language Environment (LE) runtime options, resources, and resource descriptors. These commands can be issued through TSO SPOC or the Manage Resources options in the IMS Applications menu. These commands can also be issued to an IMSplex using the Batch SPOC utility. Subsections: v “DELETE DB command” v “DELETE DBDESC command” on page 319 v “DELETE DEFN command” on page 325 v “DELETE LE command” on page 339 v “DELETE OTMADESC command” on page 346 v “DELETE PGM command” on page 349 v v v v v “DELETE “DELETE “DELETE “DELETE “DELETE PGMDESC command” on page 355 RTC command” on page 360 RTCDESC command” on page 365 TRAN command” on page 370 TRANDESC command” on page 376 DELETE DB command Use the DELETE DB command to delete database resources. Subsections: v “Environment” v “Syntax” on page 312 v “Keywords” on page 312 v “Usage notes” on page 312 v “Output fields” on page 313 v “Return, reason, and completion codes” on page 313 v “Examples” on page 317 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 164. Valid environments for the DELETE DB command and keywords Command / Keywords DB/DC DBCTL DELETE DB X X NAME X X OPTION X X © Copyright IBM Corp. 1974, 2014 DCCTL 311 Syntax , DELETE DEL DB NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE DB command: NAME Specifies the 1-8 character name of the database. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the resource names that are processed. For NAME(*), command responses are returned only for the resource names that resulted in an error. For a DEL DB command when the database contains Fast Path areas, if all areas are successfully deleted, no area names are displayed. If the delete fails for any area, then all area names are displayed to show which deletes were successful and which were not. OPTION Specifies additional functions to be performed along with the command. ALLRSP Indicates that the response lines are to be returned for all resources that are processed on the command. The default action is to return response lines only for the resources that resulted in an error. The ALLRSP keyword is valid only if NAME(*) is specified. Usage notes This command can only be issued through the Operations Manager API. This command applies to DB/DC systems, DBCTL systems, and DCCTL systems. The DELETE DB command is not valid on the XRF alternate, RSR tracker, or FDBR region. This command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each database is deleted individually, unlike the online change process where either all databases are deleted or no databases are deleted. The runtime resource definition for a database can only be deleted if the database is not in use. If the database is in use, the delete fails. In a sysplex environment with multiple IMS subsystems, the delete might succeed on some IMS subsystems and fail on others. The DELETE DB command removes ACB members from the 31-bit nonresident pool as well as the 64-bit storage pool. The resources remain deleted across an IMS warm start or emergency restart. To ensure that the resources remain deleted across a cold start, the existing resource definitions must be exported to a system RDDS and then imported from the RDDS at cold start. Or, if the IMSRSC repository is enabled, the DELETE DEFN command must be issued to delete the definition from the repository. If the resource definitions are to be imported from the MODBLKS data set at cold start instead of from an RDDS or the repository, the resource definitions must be deleted from system definition and a new MODBLKS data set must be generated. 312 Commands, Volume 1: IMS Commands A - M The database can be HSAM, HISAM, HDAM, HIDAM, DEDB, or a HALDB master database. The database cannot be a HALDB partition. If a database is logically related to another database, you need to consider whether the logically related databases should also be deleted. For example, if the database is a HIDAM database, both the primary database and the index database must be deleted. To delete a HALDB master database, a /DBRECOVERY command must be issued. The /DBRECOVERY command removes this IMS subsystem's knowledge of the HALDB partitions and stops the HALDB master database so that it can be deleted. Output fields The following table shows the DELETE DB output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 165. Output fields for the DELETE DB command Short label Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the meaning of the nonzero completion code. DB DBName N/A Database name being deleted. ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a nonzero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. TYPE Type DB Resource type, which can be AREA, DEDB, DL/I, or blank (unknown). Resource type is returned only if areas are returned. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Chapter 23. DELETE commands 313 Table 166. Return and reason codes for the DELETE DB command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only resources with nonzero completion codes are returned. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004200' The DELETE DB command is not processed because IMS shutdown is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000010' X'00004301' Command is not allowed because the database has a logical relationship with another database. X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 167. Completion codes for the DELETE DB command Completion code Completion code text 0 314 Meaning Command completed successfully for database. 8 COMMAND Command completed for COMPLETE FOR SOME some of the areas. Area names are returned with a completion code. C COMMAND Command failed for all COMPLETE FOR NONE of the areas. Area names are returned with completion codes. Commands, Volume 1: IMS Commands A - M Error text Table 167. Completion codes for the DELETE DB command (continued) Completion code Completion code text Meaning Error text 10 NO RESOURCES FOUND Database name is invalid, or the wildcard parameter specified does not match any database names. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this database. This could also mean this command, if the resource is specified by more than one specific or wildcard parameter. 23 DB STOP ACCESS IN PROGRESS A /DBRECOVERY or UPDATE DB STOP(ACCESS) command to stop database access is in progress. This takes the database offline. 25 DB STOP UPDATES IN PROGRESS A /DBDUMP or UPDATE DB STOP(UPDATES) command to stop database updates is in progress for the database. 26 DEDB STOP IN PROGRESS A /DBRECOVERY, /STOP, or UPDATE DB STOP(SCHD) command to stop database scheduling is in progress for a DEDB. 27 REJECTED FOR DELETE command not DEFAULT DESCRIPTOR allowed for user-defined default descriptor. You must issue an UPDATE command to set another descriptor as the default before deleting this descriptor. 60 GETMAIN STORAGE ERROR A GETMAIN request for storage was unsuccessful. 61 DFSBCB STORAGE ERROR A storage request for a DDIR block failed. 65 DMB POOL STORAGE ERROR During a DELETE command for a DB resource, there was an error in the DMB pool processing of a resident DMB. Chapter 23. DELETE commands 315 Table 167. Completion codes for the DELETE DB command (continued) Completion code 316 Completion code text Meaning 6C NOT ALLOWED FOR HALDB PARTITION DELETE is not allowed for a HALDB partition. 6F REFERENCED BY PROGRAM pgmname (8 Program references the characters) database to be deleted. The program name that references this database to be deleted is returned as error text. Suggested actions: Use online change for ACBLIB to change the PSB to no longer reference the database to be deleted or delete the PSB or issue DELETE PGM. 76 RECOVER CMD ACTIVE RECOVER START command is in progress to recover one or more databases with the database recovery services. 77 DEPENDENT REGIONS One or more active ACTIVE dependent regions reference the database. 90 INTERNAL ERROR An IMS system service failure. DE ACBLIB READ FAILURE A read request for a member in ACBLIB failed. E1 DB MUST BE STOPPED AND OFFLINE The database must be stopped and taken offline in order for the database to be deleted. You might need to issue a /DBR DB command or an UPDATE DB STOP(ACCESS) command to stop the database and take it offline before issuing the DELETE DB command. E2 PARALLEL DB OPEN NOT COMPLETE The DELETE DB command was rejected because DB parallel open is in progress. Commands, Volume 1: IMS Commands A - M Error text Table 167. Completion codes for the DELETE DB command (continued) Completion code | | | | | | | | | | 1D7 Completion code text Meaning Error text IMPORT CHANGE LIST Resource or descriptor is ERROR in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The resource cannot be deleted until it is successfully imported. Examples The following are examples of the DELETE DB command: Example 1 for DELETE DB command TSO SPOC input: DEL DB NAME(DBHIDO*,BADNAME,DEDBJ%%1,IPODB) TSO SPOC output: Response for: DEL DB NAME(DBHIDO*,BADNAME,DEDBJ%%1,IPODB) DBName MbrName CC CCText ErrorText BADNAME IMS1 10 NO RESOURCES FOUND DBHIDOK2 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DBHIDOK8 IMS1 6F REFERENCED BY PROGRAM PBODSAGM DBHIDOK8 IMS1 6F REFERENCED BY PROGRAM PBODSAGR DBHIDOK8 IMS1 6F REFERENCED BY PROGRAM PBODSALU DEDBJN01 IMS1 6F REFERENCED BY PROGRAM DDLTLM02 DEDBJN21 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ001 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ011 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ021 IMS1 0 DEDBJ031 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ041 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ051 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ061 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ071 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ081 IMS1 E1 DATABASE HAS NOT BEEN DBR"D DEDBJ091 IMS1 E1 DATABASE HAS NOT BEEN DBR"D IPODB IMS1 E1 DATABASE HAS NOT BEEN DBR"D OM API input: CMD(DEL DB NAME(DBHIDO*,BADNAME,DEDBJ%%1,IPODB)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.310 23:26:32.420713</statime> <stotime>2006.310 23:26:32.422399</stotime> <staseq>BFAACB33F8569D5C</staseq> <stoseq>BFAACB33F8BFFD5C</stoseq> <rqsttkn1>USRT011 10152632</rqsttkn1> Chapter 23. DELETE commands 317 <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>DB </kwd> <input>DEL DB NAME(DBHIDO*,BADNAME,DEDBJ%%1,IPODB) </input> </cmd> <cmdrsphdr> <hdr slbl="DB" llbl="DBName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>DB( DBHIDOK2) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( BADNAME ) MBR(IMS1) CC( 10) CCTXT(NO RESOURCES FOUND) </rsp> <rsp>DB( DEDBJN01) MBR(IMS1) CC( 6F) CCTXT(REFERENCED BY PROGRAM) ERRT(DDLTLM02) </rsp> <rsp>DB( IPODB ) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DBHIDOK8) MBR(IMS1) CC( 6F) CCTXT(REFERENCED BY PROGRAM) ERRT(PBODSAGM) </rsp> <rsp>DB( DEDBJN21) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ001) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ011) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ021) MBR(IMS1) CC( 0) </rsp> <rsp>DB( DEDBJ031) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ041) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ051) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ061) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ071) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ081) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DEDBJ091) MBR(IMS1) CC( E1) CCTXT(DATABASE HAS NOT BEEN DBR"D) </rsp> <rsp>DB( DBHIDOK8) MBR(IMS1) CC( 6F) CCTXT(REFERENCED BY PROGRAM) ERRT(PBODSAGR) </rsp> 318 Commands, Volume 1: IMS Commands A - M <rsp>DB( DBHIDOK8) MBR(IMS1) CC( ERRT(PBODSALU) </rsp> </cmdrspdata> </imsout> 6F) CCTXT(REFERENCED BY PROGRAM) Explanation: A DELETE DB command was issued for several databases. The DELETE DB worked for one database, DEDBJ021, as shown by completion code 0. The DELETE DB command failed for several databases with completion code E1, because the databases need to be taken offline by use of the /DBRECOVERY command first. The DELETE DB command failed for databases DBHIDOK8 and DEDBJN01 with completion code 6F, because the databases are referenced by one or more programs. Each program name is displayed as error text. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related tasks: Deleting runtime database resource and descriptor definitions with the DELETE command (System Definition) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 DELETE DBDESC command Use the DELETE DBDESC command to delete database descriptors. Subsections: v “Environment” v “Syntax” on page 320 v v v v v “Keywords” on page 320 “Usage notes” on page 320 “Output fields” on page 321 “Return, reason, and completion codes” on page 321 “Examples” on page 323 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) from which the command keywords can be issued. Table 168. Valid environments for the DELETE DBDESC command and keywords Command / Keywords DB/DC DBCTL DELETE DBDESC X X NAME X X OPTION X X DCCTL Chapter 23. DELETE commands 319 Syntax , DELETE DEL DBDESC NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE DBDESC command: NAME Specifies the 1-8 character name of the database descriptor. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the descriptor names that are processed. For NAME(*), command responses are returned only for the descriptor names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the descriptor names that are processed. OPTION Specifies additional functions to be performed along with the command. ALLRSP Indicates that the response lines are to be returned for all descriptors that are processed on the command. The default action is to return response lines only for the descriptors that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values. Usage notes This command can only be issued through the Operations Manager API. This command applies to DB/DC systems, and DBCTL system. The DELETE DBDESC command is not valid on the XRF alternate, RSR tracker, or FDBR region. The DELETE DBDESC command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each descriptor is deleted individually. Individual deletion does not work like online change where either all descriptors are deleted or no descriptors are deleted. Descriptors can be successfully deleted if they are not currently in use. If a descriptor is in use, the delete fails. In a sysplex environment, the delete might succeed on some IMS systems and fail on others. A descriptor is in use if another command is in progress that references the descriptor. The descriptors remain deleted across an IMS warm start or emergency restart. To ensure they remain deleted across a cold start, the existing descriptor definitions must be exported to an RDDS and imported from the RDDS during cold start. The DELETE DBDESC command is not allowed for IMS descriptors that are identified with a definition type of IMS. For DELETE DBDESC commands, this means IMS database descriptor DFSDSDB1. 320 Commands, Volume 1: IMS Commands A - M Output fields The following table shows the DELETE DBDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 169. Output fields for the DELETE DBDESC command Short label Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the meaning of the non-zero completion code. DESC DescName DBDESC Database descriptor name. ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a non-zero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 170. Return and reason codes for the DELETE DBDESC command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only descriptors with non-zero completion codes are returned. See the completion code table for details. Chapter 23. DELETE commands 321 Table 170. Return and reason codes for the DELETE DBDESC command (continued) Return code Reason code Meaning X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004200' The DELETE DBDESC command is not processed because IMS shutdown is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 171. Completion codes for the DELETE DBDESC command Completion code Completion code text 0 322 Meaning Command completed successfully for database descriptor. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this database descriptor. This could also mean this command, if the descriptor is specified by more than one specific or wildcard parameter. 27 REJECTED FOR DEFAULT DESCRIPTOR DELETE command not allowed for user-defined default descriptor. You must issue an UPDATE command to set another descriptor as the default before deleting this descriptor. 48 NOT ALLOWED FOR IMS RESOURCE DELETE command not allowed for IMS defined-descriptor or resource. An IMS descriptor example is DFSDSDB1. Commands, Volume 1: IMS Commands A - M Error text Table 171. Completion codes for the DELETE DBDESC command (continued) Completion code | | | | | | | | Completion code text Meaning 60 GETMAIN STORAGE ERROR A GETMAIN request for storage was unsuccessful. 61 DFSBCB STORAGE ERROR A storage request for a DDIR block failed. 90 INTERNAL ERROR AN IMS system service failure. IMPORT CHANGE LIST ERROR Descriptor is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The descriptor cannot be deleted until it is successfully imported. 1D7 Error text Examples The following are examples of the DELETE DBDESC command: Example 1 for DELETE DBDESC command TSO SPOC input: DEL DBDESC NAME(*) OPTION(ALLRSP) TSO SPOC output: Response DescName BRWSDESC DESC001 DESC002 DESC003 DESC004 DESC005 DFSDSDB1 EXCLDESC RESDESC for: DEL DBDESC NAME(*) OPTION(ALLRSP) MbrName CC CCText IMS1 27 REJECTED FOR DEFAULT DESCRIPTOR IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 48 NOT ALLOWED FOR IMS RESOURCE IMS1 0 IMS1 0 OM API input: CMD(DEL DBDESC NAME(*) OPTION(ALLRSP)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.310 23:15:13.678125</statime> <stotime>2006.310 23:15:13.679097</stotime> <staseq>BFAAC8ACABB2D8DC</staseq> <stoseq>BFAAC8ACABEF9C5C</stoseq> <rqsttkn1>USRT011 10151513</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> Chapter 23. DELETE commands 323 <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>DBDESC </kwd> <input>DEL DBDESC NAME(*) OPTION(ALLRSP) </input> </cmd> <cmdrsphdr> <hdr slbl="DESC" llbl="DescName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>DESC(EXCLDESC) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC004 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC005 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC001 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(RESDESC ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(BRWSDESC) MBR(IMS1) CC( 27) CCTXT(REJECTED FOR DEFAULT DESCRIPTOR) </rsp> <rsp>DESC(DESC002 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC003 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DFSDSDB1) MBR(IMS1) CC( 48) CCTXT(NOT ALLOWED FOR IMS RESOURCE) </rsp> </cmdrspdata> </imsout> Explanation: A DELETE DBDESC command is issued to delete all database descriptors from an active IMS system. Many database descriptors are successfully deleted, as indicated by the completion code 0. Because the DELETE command attempted to delete all of the database descriptors, OPTION(ALLRSP) is specified to display the successfully deleted database descriptors. Database descriptor BRWSDESC fails, because it is the default database descriptor. Database descriptor DFSDSDB1 fails, because it is the IMS-defined database descriptor. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 324 Commands, Volume 1: IMS Commands A - M DELETE DEFN command Use the DELETE DEFN command to delete one or more stored resource definitions from the IMSRSC repository. Subsections: v “Environment” v “Syntax” v v v v v “Keywords” on page 326 “Usage notes” on page 329 “Output fields” on page 330 “Return, reason, and completion codes” on page 331 “Examples” on page 332 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 172. Valid environments for the DELETE DEFN command and keywords Command / Keywords | DB/DC DBCTL DCCTL DELETE DEFN X X X FOR X X X NAME X X X OPTION X X X TARGET X X X TYPE X X X Syntax | TARGET(REPO) DELETE DEL DEFN A B | | A: | | , TYPE( DB DBDESC PGM PGMDESC RTC RTCDESC TRAN TRANDESC ) NAME( name name* ) FOR(IMSID(imsid)) NAME(*) | | Chapter 23. DELETE commands 325 | OPTION(ALLRSP) | B: | | | TYPE(CHGLIST) FOR(IMSID(imsid)) Keywords | The following keywords are valid for the DELETE DEFN command: DEFN Specifies that resource and descriptor definitions are to be deleted. TARGET Indicates where the definitions must be deleted from. TARGET(REPO) is the default. REPO TARGET(REPO) is valid only when IMS is enabled to use the repository. The DELETE DEFN command is defined to OM with ROUTE=ANY. OM routes the command to one command master IMS for processing. All resource definitions are deleted from the repository as a single unit of work (UOW). If the deletion of any of the resource definitions results in an error, none of the resource definitions are deleted. A resource definition not being found in the repository is not treated as an error in the command processing. If one or more resource definitions for the names that are specified on the DELETE DEFN command are not found in the repository, the command is processed for the names that have resource definitions in the repository. If any CSLRPDEL errors are returned for the DELETE command, you must check to see whether there are any in-doubts. If the error is before the UOW is committed, all deletes from the repository are backed out. If the failure is during UOW commit and if the primary data set is updated, the UOW is committed. You must issue the QUERY xxx SHOW(DEFN,IMSID) commands to verify whether the resource definitions exist in the repository. If they still exist, you must reissue the DELETE DEFN command. Recommendation: Avoid issuing the DELETE DEFN TARGET(REPO) NAME(*) FOR(IMSID(*)) command during peak hours because deleting all the resource definitions from the repository can incur a larger than normal command response time. However, while the resource definitions are being deleted from the repository, there is no impact to other work in IMS. TYPE Specifies the type of resource or descriptor definitions to delete. | | | CHGLIST Specifies that any residual IMS change list that could not be deleted by IMS during IMS change list processing is to be deleted. If the IMS system goes down without deleting the change list, another change list cannot be created at the next IMPORT DEFN SOURCE(REPO) | | 326 Commands, Volume 1: IMS Commands A - M | | SCOPE(ALL) command. The IMPORT command will fail because the change list is locked and not accessible. | | | | | Use the CHGLIST keyword under the following situations: v After a DFS4409A message (REPOSITORY CHANGE LIST IS NOT ACCESSIBLE) is issued and you issue an IMPORT DEFN SOURCE(REPO) SCOPE(ALL) command manually to successfully synchronize IMS with the repository. | | | | | | | | Because the IMPORT command is issued manually, the change list is not needed and should be deleted. If the change list is not deleted, it is processed at the next IMS restart. v After a DFS4401E message is issued (RM CSLRPDEL REQUEST FAILED) when IMS could not delete the change list. Because IMS could not delete the change list automatically, you can use the DELETE DEFN command to delete the change list. If this residual change list is not deleted, it is deleted at the next IMS restart. DB Specifies that one or more database definitions are to be deleted from the repository. If TYPE(DB) is specified on a DCCTL system, completion code 1D3 ("REPOSITORY MEMBER NOT FOUND") is returned for each name specified. DBDESC Specifies that one or more database descriptor definitions are to be deleted from the repository. If TYPE(DBDESC) is specified on a DCCTL system, completion code 1D3 ("REPOSITORY MEMBER NOT FOUND") is returned for each name specified. PGM Specifies that one or more program definitions are to be deleted from the repository. PGMDESC Specifies that one or more program descriptor definitions are to be deleted from the repository. RTC Specifies that one or more routing code definitions are to be deleted from the repository. If TYPE(RTC) is specified on a DBCTL system, completion code 1D3 ("REPOSITORY MEMBER NOT FOUND") is returned for each name specified. RTCDESC Specifies that one or more routing code descriptor definitions are to be deleted from the repository. If TYPE(RTCDESC) is specified on a DBCTL system, completion code 1D3 ("REPOSITORY MEMBER NOT FOUND") is returned for each name specified. TRAN Specifies that one or more transaction definitions are to be deleted from the repository. If TYPE(TRAN) is specified on a DBCTL system, completion code 1D3 ("REPOSITORY MEMBER NOT FOUND") is returned for each name specified. When an FP(E) transaction is deleted from the repository by using the DELETE DEFN command, the routing code that is associated with the FP(E) transaction will also be deleted from the repository by RM. TRANDESC Specifies that one or more transaction descriptor definitions are to be Chapter 23. DELETE commands 327 deleted from the repository. If TYPE(TRANDESC) is specified on a DBCTL system, completion code 1D3 ("REPOSITORY MEMBER NOT FOUND") is returned for each name specified. NAME Specifies the 1- to 8-character name of a resource or descriptor. Wildcards can be specified in the name. The name is a repeatable parameter. If the NAME parameter specified is a specific name or a wildcard, command responses are returned for all the resource names that are processed. NAME is a required parameter. For NAME(*), command responses are returned only for the resource and descriptor names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the resource and descriptor names that are deleted. FOR Specifies what actions to be set. IMSID Specifies the list of IMS IDs for which the resource and descriptor definitions are to be deleted. An IMS resource list is a list of resource and descriptor names and types that defines the resources for an IMS system. IMS resource lists exist in the repository and are used during IMS cold start to identify all the resource and descriptor definitions that are to be read during the cold start. The IMSID values specified on the DELETE DEFN command identify the IMS resource lists from which the resources are to be deleted when a stored resource definition is deleted from the repository. The IMSID value can be a specific IMS ID, a list of specific IMS IDs, a wildcard name of *, or a wildcard name with * or %. If the IMSID value specified is a wildcard name other than *, the list of IMS IDs in RM that match the IMS ID wildcard name will be used on the command. The list of IMS IDs that are processed is returned on the command output. IMSID(*) indicates that all IMS resource lists must be updated to remove the resource name being deleted. As a result of the DELETE DEFN command, the resource definition does not belong to any IMS systems that are defined to use the repository. You can specify one or more IMS IDs. When one or more IMS IDs are specified, only the IMS resource lists for the specified IMS IDs are modified to delete the resource names being deleted from the repository. If the resource name belongs to one or more IMS resource lists, and the DELETE DEFN command does not specify deletion from all IMS IDs, the stored resource definition from the repository is not deleted. Only the IMS resource lists for the specified IMS subsystems are modified to delete the resource names that are specified on the command. The IMS ID specified on the FOR(IMSID()) keyword must be an IMS that is defined to RM to use the repository. The IMS specified might be active or down when the command is issued. OPTION Specifies additional functions to be performed along with the command. 328 Commands, Volume 1: IMS Commands A - M ALLRSP Specifies that all response lines must be returned. You can specify OPTION(ALLRSP) only if NAME(*) is also specified. If OPTION(ALLRSP) is not specified, only the response lines for the names in error are returned. OPTION(ALLRSP) is not valid when NAME parameters are specified. A response line is returned for each name that is specified on the NAME keyword. Usage notes The DELETE DEFN command is valid from the Operations Manager (OM) API. This command is defined as ROUTE=ANY to OM and is processed only by the command master IMS. You cannot delete a program definition from the repository if the program is referenced by one or more transaction or routing code definitions in the IMSRSC repository. When you delete definitions from the repository for multiple resource types, delete the definitions in the following order: 1. Transaction and transaction descriptor definitions 2. Routing code and routing code descriptor definitions 3. Program and program descriptor definitions Database and database descriptor definitions can be deleted at any time. | | | | | | | | As a result of the DELETE DEFN command with keyword DB, DBDESC, RTC, RTCDESC, PGM, PGMDESC, TRAN, or TRANDESC, definitions of the specified resource names are deleted from the IMSRSC repository for the specified IMS systems. Additionally, the DELETE DEFN command deletes the resource names from an IMS change list in the repository if a change list exists for one or more IMS systems that are specified on the FOR() keyword. Because the resource definition is being deleted and will not be available to be imported when the IMS system restarts, it is also deleted from the IMS system's change list. | | | | | | | | | The IMS change list in the repository is not created when a DELETE DEFN command is issued and one or more IMS systems that are specified on the FOR() keyword are down. When you delete a resource definition, delete the IMS runtime definition from IMS by using the DELETE command and then delete the stored resource definition from the repository by using the DELETE DEFN command. If the stored resource definition is deleted from the repository for the IMS before the runtime resource definition is deleted from the IMS system, the resource definition still exists in the IMS after restart. In this case, issue the DELETE command to delete the runtime resource definition after IMS restarts. Considerations for Fast Path exclusive transactions and their associated routing codes: When you delete a definition for a Fast Path exclusive transaction from the repository, the definition for its associated routing code is also deleted. If you issue the DELETE DEFN command to delete a routing code definition from the repository and the routing code is associated with a Fast Path exclusive transaction, the deletion fails. To delete the routing code definition, you must first delete the transaction definition. Consideration for an XRF-capable system: When the DELETE DEFN command is used in an XRF environment, and the resource definition exists in the IMSRSC Chapter 23. DELETE commands 329 repository for both the active system and the alternate system, you must issue the DELETE DEFN command with the IMS IDs of both the active system and the alternate system on the FOR(IMSID(imsid)) keyword. Output fields The DELETE DEFN TARGET(REPO) command results in the DFS3406I message, which indicates that the deletion from the repository was successful, or the DFS3407E message, which indicates that the deletion was not successful. These messages include the repository name and repository type. If the deletion from the repository is not successful, the DFS3407E message consists of the CSLRPDEL request return code and reason code. The CSLRPDEL return and reason codes are in the CSLRRR macro. The following table shows the DELETE DEFN output fields. The columns in the table are as follows: Short label Contains the short label that is generated in the XML output. Long label Contains the long label that is generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A indicates output fields that are always returned. error indicates output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 173. Output fields for the DELETE DEFN command Short label | | | | 330 Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the meaning of the nonzero completion code. DTYP DelType N/A The value CHGLIST is returned under DelType if the resource name on the output line was deleted from the IMS change list and the IMS resource list. IMSID IMSid N/A The names of IMS resource lists that are updated or deleted by the DELETE DEFN command. MBR MbrName N/A The IMS identifier of the command master IMS that processed the DELETE DEFN command. NAME Name N/A The name of the resource or descriptor definition that was updated or deleted from the repository, or the name of the IMS resource list that was updated in the repository. TYPE Type N/A The resource or descriptor type, which can be DB, DBDESC, PGM, PGMDESC, RTC, RTCDESC, TRAN, or TRANDESC; or LIST for IMS resource lists. Commands, Volume 1: IMS Commands A - M Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 174. Return and reason codes for the DELETE DEFN command | | | | | | | | | Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. X'0000000C' X'00003004' No requests were successful. X'00000010' X'00004004' No CQS address space. X'00000010' X'00004018' No resource structure, or resource structure not available. X'00000010' X'00004100' Resource structure is full. X'00000010' X'00004104' No RM address space. X'00000010' X'00004108' No SCI address space. X'00000010' X'00004500' IMS is not enabled to use the repository. X'00000010' X'00004501' RM is not enabled with the repository. X'00000010' X'00004502' Repository is not available. X'00000010' X'00004503' Repository is stopped. X'00000010' X'00004504' Repository spare recovery is in progress. X'00000010' X'00004505' No IMS resource list exists, or no resources for the resource type exist in the IMS resource list. X'00000010' X'00004507' Repository access is denied. X'00000010' X'00004508' Repository maximum put length exceeded. X'00000010' X'00004509' RM data version is lower than the IMS data version. X'00000010' X'0000450A' Repository Server is being shut down. X'00000010' X'0000450B' Repository Server is not available. X'00000010' X'0000450C' Repository Server is busy. X'00000010' X'0000450D' RM failed to define some of the internal fields that are related to the IMSRSC repository. X'00000014' X'0000501C' IMODULE GETMAIN error. X'00000014' X'00005100' RM request error. X'00000014' X'00005104' CQS error. X'00000014' X'00005108' SCI request error. X'00000014' X'00005110' Repository error. X'00000014' X'0000551C' A request to update the repository was rejected. Either a corrupted resource list was detected, or the update request was rejected to prevent a corruption of the resource list. Contact IBM Software Support. Send in the output from the command in error, a dump of the local RM address space where the command executed or the dump of all RM address spaces in the IMSplex. Also, send a copy of the IMSRSC repository RID and RMD data sets. Chapter 23. DELETE commands 331 Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 175. Completion codes for the DELETE DEFN command Completion code Completion code text 0 | | | | | | | Meaning Command completed successfully for database. 39 FP(E) TRAN FOR RTC EXISTS A routing code definition is being deleted, but the routing code is associated with a Fast Path exclusive FP(E) transaction. 7B REFERENCED BY RTCODE A program definition is being deleted, but the program is referenced by one or more routing code definitions. 88 REFERENCED BY TRAN A program definition is being deleted, but the program is referenced by one or more transaction definitions. 1D0 NOT DONE DUE TO ERROR An error resulted in the command not being processed for the resource name in the response line. The resource name that had the error will show the error that was encountered. All other resource names will have 1D0 completion code because the deletion was aborted due to one error. All members are deleted as a single unit of work. 1D3 MEMBER NOT FOUND The specified resource name is not found. 1D8 CHANGE LIST IN USE The DELETE DEFN TARGET(REPO) command could not be completed because the change list for an IMS was in use and not accessible to be deleted. Examples The following are examples of the DELETE DEFN command: Example 1 for DELETE DEFN command 332 Commands, Volume 1: IMS Commands A - M Error text TSO SPOC input: DELETE DEFN TARGET(REPO) NAME(*) TYPE(DB) FOR(IMSID(*)) TSO SPOC output: IMSplex . . . . Routing . . . . Start time. . . Stop time . . . Return code . . Reason code . . Reason text . . Command master. . . . . . . . . : : : : : : : : PLEX1 2011.133 12:45:21.34 2011.133 12:45:21.82 00000000 00000000 IMS1 MbrName Messages -------- ----------------------IMS1 DFS3406I DELETE COMMAND COMPLETE FOR ALL, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY OM API input: CMD(DELETE DEFN TARGET(REPO) NAME(*) TYPE(DB) FOR(IMSID(*))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.5.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2011.133 19:45:21.399790</statime> <stotime>2011.133 19:45:21.823791</stotime> <staseq>C7C3DD48D2FEE475</staseq> <stoseq>C7C3DD493A82F2A5</stoseq> <rqsttkn1>USRT011 10124521</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>DEFN </kwd> <input>DEL DEFN TARGET(REPO) NAME(*) TYPE(DB) FOR(IMSID(*)) </input> </cmd> <msgdata> <mbr name="IMS1 "> <msg>DFS3406I DELETE COMMAND COMPLETE FOR ALL, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY </msg> </mbr> </msgdata> </imsout> Explanation: All the stored resource definitions for all the database resources and descriptors are deleted in the repository. This command is processed by the command master IMS. The resource list for all IMS systems that are defined to use the repository is updated. Example 2 for DELETE DEFN command TSO SPOC input: DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3)) TSO SPOC output: Chapter 23. DELETE commands 333 Response for: DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3)) Name Type MbrName CC CCText IMSid IMS2 LIST IMS1 0 IMS3 LIST IMS1 0 EMHTX2 RTC IMS1 0 IMS2 EMHTX2 RTC IMS1 0 IMS3 RTC2 RTC IMS1 1D3 REPOSITORY MEMBER NOT FOUND When the PF4 key is pressed, the following is displayed: Log for . . : DEL DEFN TARGET(REPO) TYPE(RTC) IMSplex . . . . Routing . . . . Start time. . . Stop time . . . Return code . . Reason code . . Reason text . . Command master. MbrName -------IMS1 . . . . . . . . : : : : : : : : NAME(EMHTX2,RTC... More: PLEX1 2011.133 11:41:54.47 2011.133 11:41:54.55 0200000C 00003008 None of the clients were successful. IMS1 Return Code -------0000000C Reason Code -------00003000 Reason text -------------At least one request successful MbrName Messages -------- ----------------------IMS1 DFS3407E DELETE COMMAND COMPLETE FOR SOME, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY OM API input: CMD(DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.5.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2011.133 18:41:54.498030</statime> <stotime>2011.133 18:41:54.547807</stotime> <staseq>C7C3CF1A479EE33C</staseq> <stoseq>C7C3CF1A53C5FFF0</stoseq> <rqsttkn1>USRT011 10114154</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>DEFN </kwd> 334 Commands, Volume 1: IMS Commands A - M <input>DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3)) </input> </cmd> <cmdrsphdr> <hdr slbl="NAME" llbl="Name" scope="LCL" sort="a" key="2" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="TYPE" llbl="Type" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="3" 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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> <hdr slbl="IMSID" llbl="IMSid" scope="LCL" sort="a" key="4" scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>NAME(IMS2 ) TYPE(LIST) MBR(IMS1) CC( 0) </rsp> <rsp>NAME(IMS3 ) TYPE(LIST) MBR(IMS1) CC( 0) </rsp> <rsp>NAME(RTC2 ) TYPE(RTC) MBR(IMS1) CC( 1D3) CCTXT(REPOSITORY MEMBER NOT FOUND) </rsp> <rsp>NAME(EMHTX2 ) TYPE(RTC) MBR(IMS1) CC( 0) IMSID(IMS2 ) </rsp> <rsp>NAME(EMHTX2 ) TYPE(RTC) MBR(IMS1) CC( 0) IMSID(IMS3 ) </rsp> </cmdrspdata> <msgdata> <mbr name="IMS1 "> <msg>DFS3407E DELETE COMMAND COMPLETE FOR SOME, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY </msg> </mbr> </msgdata> </imsout> Explanation: Routing code resource EMHTX2 exists in the IMSRSC repository, and routing code resource RTC2 does not exist in the repository. The DELETE DEFN command completed successfully with some of the resources deleted. IMS1 processed the DELETE DEFN command on behalf of IMS2 and IMS3. Routing code resource EMHTX2 in the repository is deleted for both IMS2 and IMS3. The resource list of IMS2 and the resource list of IMS3 are updated to remove routing code resource EMHTX2 from the resource lists. IMS2 and IMS3 do not have routing code resource RTC2 in the repository. The completion code is 1D3, and the completion code text is REPOSITORY MEMBER NOT FOUND. Example 3 for DELETE DEFN command TSO SPOC input: DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3)) TSO SPOC output: Response for: DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3)) Name Type MbrName CC CCText IMS2 LIST IMS1 1D0 NOT DONE DUE TO ERROR IMS3 LIST IMS1 1D0 NOT DONE DUE TO ERROR EMHTX2 RTC IMS1 1D3 REPOSITORY MEMBER NOT FOUND RTC2 RTC IMS1 1D3 REPOSITORY MEMBER NOT FOUND When the PF4 key is pressed, the following is displayed: Log for . . : DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC... More: +> IMSplex . . . . . : PLEX1 Routing . . . . . : Chapter 23. DELETE commands 335 Start time. . . Stop time . . . Return code . . Reason code . . Reason text . . Command master. MbrName -------IMS1 . . . . . . : : : : : : 2011.133 12:07:41.08 2011.133 12:07:41.14 0200000C 00003008 None of the clients were successful. IMS1 Return Code -------0000000C Reason Code -------00003004 Reason text -------------No requests were successful MbrName Messages -------- ----------------------IMS1 DFS3407E DELETE COMMAND COMPLETE FOR NONE, REQUEST=CSLRPDEL, RC=0300000C, RSN=00003004, ERRORTEXT=, MBR=RSC, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY OM API input: CMD(DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.5.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2011.133 19:07:41.108147</statime> <stotime>2011.133 19:07:41.139772</stotime> <staseq>C7C3D4DD3DFB3522</staseq> <stoseq>C7C3D4DD45B3CC2C</stoseq> <rqsttkn1>USRT011 10120741</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003004</rsn> <rsntxt>No requests were successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>DEFN </kwd> <input>DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMHTX2,RTC2) FOR(IMSID(IMS2,IMS3)) </input> </cmd> <cmdrsphdr> <hdr slbl="NAME" llbl="Name" scope="LCL" sort="a" key="2" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="TYPE" llbl="Type" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="3" 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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> 336 Commands, Volume 1: IMS Commands A - M <hdr slbl="IMSID" llbl="IMSid" scope="LCL" sort="a" key="4" scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>NAME(IMS2 ) TYPE(LIST) MBR(IMS1) CC( 1D0) CCTXT(NOT DONE DUE TO ERROR) </rsp> <rsp>NAME(IMS3 ) TYPE(LIST) MBR(IMS1) CC( 1D0) CCTXT(NOT DONE DUE TO ERROR) </rsp> <rsp>NAME(EMHTX2 ) TYPE(RTC) MBR(IMS1) CC( 1D3) CCTXT(REPOSITORY MEMBER NOT FOUND) </rsp> <rsp>NAME(RTC2 ) TYPE(RTC) MBR(IMS1) CC( 1D3) CCTXT(REPOSITORY MEMBER NOT FOUND) </rsp> </cmdrspdata> <msgdata> <mbr name="IMS1 "> <msg>DFS3407E DELETE COMMAND COMPLETE FOR NONE, REQUEST=CSLRPDEL, RC=0300000C, RSN=00003004, ERRORTEXT=, MBR=RSC, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY </msg> </mbr> </msgdata> </imsout> Explanation: Routing code resources EMHTX2 and RTC2 do not exist in the IMSRSC repository. The DELETE DEFN command completed successfully with none of the resources deleted. IMS1 processed the DELETE DEFN command on behalf of IMS2 and IMS3. IMS2 and IMS3 do not have routing code resources EMHTX2 and RTC2 in the repository. The completion code is 1D3, and the completion code text is REPOSITORY MEMBER NOT FOUND. The resource list of IMS2 and the resource list of IMS3 are not updated due to error. The completion code is 1D0, and the completion code text is NOT DONE DUE TO ERROR. Example 4 for DELETE DEFN command TSO SPOC input: DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMH*,R*) FOR(IMSID(IMS2,IMS3)) TSO SPOC output: Response for: DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMH*,R*) FOR(IMSID(IMS2,IMS3)) Name Type MbrName CC IMSid IMS2 LIST IMS1 0 IMS3 LIST IMS1 0 EMHTX3 RTC IMS1 0 IMS2 EMHTX3 RTC IMS1 0 IMS3 RTC3 RTC IMS1 0 IMS2 RTC3 RTC IMS1 0 IMS3 When the PF4 key is pressed, the following is displayed: Log for . . : DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMH*,R*) FO... IMSplex . . . . Routing . . . . Start time. . . Stop time . . . Return code . . Reason code . . Reason text . . Command master. . . . . . . . . : : : : : : : : More: > PLEX1 2011.133 12:22:50.10 2011.133 12:22:50.17 00000000 00000000 IMS1 Chapter 23. DELETE commands 337 MbrName Messages -------- ----------------------IMS1 DFS3406I DELETE COMMAND COMPLETE FOR ALL, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY OM API input: CMD(DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMH*,R*) FOR(IMSID(IMS2,IMS3))) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.5.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2011.133 19:22:50.121164</statime> <stotime>2011.133 19:22:50.167741</stotime> <staseq>C7C3D84024FCC3A0</staseq> <stoseq>C7C3D840305BDD22</stoseq> <rqsttkn1>USRT011 10122250</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>DEFN </kwd> <input>DEL DEFN TARGET(REPO) TYPE(RTC) NAME(EMH*,R*) FOR(IMSID(IMS2,IMS3)) </input> </cmd> <cmdrsphdr> <hdr slbl="NAME" llbl="Name" scope="LCL" sort="a" key="2" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="TYPE" llbl="Type" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="3" 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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> <hdr slbl="IMSID" llbl="IMSid" scope="LCL" sort="a" key="4" scroll="no" len="8" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>NAME(IMS2 ) TYPE(LIST) MBR(IMS1) CC( 0) </rsp> <rsp>NAME(IMS3 ) TYPE(LIST) MBR(IMS1) CC( 0) </rsp> <rsp>NAME(EMHTX3 ) TYPE(RTC) MBR(IMS1) CC( 0) IMSID(IMS2 ) </rsp> <rsp>NAME(RTC3 ) TYPE(RTC) MBR(IMS1) CC( 0) IMSID(IMS2 ) </rsp> <rsp>NAME(EMHTX3 ) TYPE(RTC) MBR(IMS1) CC( 0) IMSID(IMS3 ) </rsp> <rsp>NAME(RTC3 ) TYPE(RTC) MBR(IMS1) CC( 0) IMSID(IMS3 ) </rsp> </cmdrspdata> <msgdata> <mbr name="IMS1 "> <msg>DFS3406I DELETE COMMAND COMPLETE FOR ALL, REPOTYPE=IMSRSC, REPONAME=IMSRSC_REPOSITORY </msg> </mbr> </msgdata> </imsout> Explanation: Routing code resources EMHTX3 and RTC3 exist in the IMSRSC repository. The DELETE DEFN command completed successfully with all of the resources deleted. IMS1 processed the DELETE DEFN command on behalf of IMS2 and IMS3. Routing code resource EMHTX3 that exists in the repository matched 338 Commands, Volume 1: IMS Commands A - M the wildcard resource name of EMH*. Routing code resource RTC3 that exists in the repository matched the wildcard resource name of R*. Routing code resources EMHTX3 and RTC3 exist in the repository for IMS2 and IMS3. Routing code resources EMHTX3 and RTC3 are deleted from the repository for IMS2 and IMS3. The resource list of IMS2 and the resource list of IMS3 are updated to remove routing code resources EMHTX3 and RTC3 from the resource lists. Related information: DFS3406I (Messages and Codes) DFS3407E (Messages and Codes) DELETE LE command Use the DELETE command (with the LE keyword) to delete Language Environment (LE) runtime options that have previously been defined by the UPDATE command (with the LE keyword). Subsections: v “Environment” v “Syntax” v “Keywords” on page 340 v “Usage notes” on page 340 v “Output fields” on page 341 v “Return, reason, and completion codes” on page 341 v “Examples” on page 342 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 176. Valid environments for the DELETE command and keywords Command / Keywords DB/DC DBCTL DCCTL DELETE LE X X X LTERM X X X PGM X X X TRAN X X X USERID X X X Syntax , DELETE DEL LE LTERM(ltermname) PGM(programname) TRAN(tranname) USERID(userid) Chapter 23. DELETE commands 339 Keywords LTERM() Specifies the 1 - 8 character name of the LTERMs that match the generic or wildcard parameter. PGM() Specifies the 1 - 8 character name of the programs that match the generic or wildcard parameter. TRAN() Specifies the 1 - 8 character name of the transactions that match the generic or wildcard parameter. USERID() Specifies the 1 - 8 character name of the user IDs that match the generic or wildcard parameter. Usage notes The delete can use filters on transaction code, LTERM name, user ID, or program name. Any combination of parameters can be used to qualify the application instance to which the runtime parameters are deleted. All matches found are deleted. The entry is logically deleted. The entry is then immediately available for reuse by the next UPDATE LE command. There is a small window of time where it is possible for an entry to be deleted and reused before LE uses it, that could cause LE to use the wrong set of parameters. 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. OM overrides the routing on the command and routes the command to all IMS systems in the IMSplex. The user-specified route list is ignored. Rules for matching an entry which results in the delete of an entry: v If a filter is specified in the command for a particular resource it must match the resource filter defined in the entry. The resource in the DELETE LE command can be specified with wildcards as defined previously. v A resource filter that is not specified on a DELETE LE command will match on any filter for the specific resource defined in the entry. A non-specified filter is treated as a wildcard. For instance if the LTERM filter is not specified on a DELETE LE command it will match on any LTERM resource defined in an entry, as if LTERM(*) was specified on the command. If an existing set of LE runtime options are found for the specified TRAN, LTERM, USERID, or PGM, the existing parameter string is deleted. The string is deleted only when the specified filters are an exact match for the existing entry. The entry is logically deleted. The entry is available for reuse on the next UPDATE LE command. The following keywords support a generic or wildcard character. A generic parameter is a 1 - 8 character alphanumeric name that includes one or more special characters and 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. 340 Commands, Volume 1: IMS Commands A - M Requirement: At least one of the resource filters (LTERM, PGM, TRAN, or USERID) must be specified on the UPDATE LE command. Output fields The following table shows the output fields for an DELETE LE 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 177. Output fields for the DELETE 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 affected by the DELETE. MBR N/A IMSplex member (IMS identifier) that built the output line. Member name is always returned. PGM PGM Program name affected by the DELETE. TRAN TRAN Transaction name affected by the DELETE. UID USERID Userid affected by the DELETE. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 178. Return and reason codes for the DELETE LE command Return code Reason code Meaning X'00000000' X'00000000' The DELETE LE command completed successfully. X'00000008' X'00002008' No keywords were specified on the command. At least one keyword is required. X'00000008' X'0000200C' No resources found to delete. 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. The following table contains the completion code that can be returned on a DELETE LE command and the meaning of the code. Chapter 23. DELETE commands 341 Table 179. Completion code for the DELETE LE command Completion code 0 Meaning The DELETE LE command completed successfully for the specified resource. Examples The following are examples of the DELETE LE command: Example 1 for DELETE LE command For this example, the following table shows the parameter override table entries prior to any DELETE LE commands being processed. Table 180. Parameter override table entries for DELETE LE example Entry# TRAN 1 PART 2 PART 3 PART LTERM USERID PROGRAM LERUNOPTS DFSSAM02 aaaa BETTY bbbb TERM1 cccc 4 DFSSAM02 dddd 5 PART TERM1 BARBARA eeee 6 PART TERM1 BOB ffff TERM2 BETTY gggg 7 8 PART TERM2 iiii The following table shows the resulting actions when different filters are specified on a DELETE LE command. Table 181. Example filters and resulting actions for DELETE LE command Filters active on command Resulting action TRAN(PART) Deletes entries #1, 2, 3, 5, 6, 8 TRAN(PART) LTERM(TERM1) Deletes entries #3, 5, 6 LTERM(TERM2) USERID(BETTY) Deletes entry #7 TRAN(PART) LTERM(TERM1) USERID(BETTY) Does not delete any entries TRAN(PART) LTERM(TERM*) Deletes entries #3, 5, 6, 8 USERID(B*) Deletes entries #2, 5, 6, 7 Example 2 for DELETE LE command The following TSO SPOC and OM API input and output sets up the scenario for the DELETE LE command examples. The UPDATE commands are used to add entries to the table; the QUERY command shows the resulting entries. TSO SPOC input: UPD UPD UPD QRY 342 LE LE LE LE TRAN(IAPMDI27) USERID(USRT003) SET(LERUNOPTS(cccc)) TRAN(IAPMDI27) USERID(USRT001) SET(LERUNOPTS(bbbb)) TRAN(IAPMDI26) USERID(USRT001) SET(LERUNOPTS(aaaa)) SHOW(ALL) Commands, Volume 1: IMS Commands A - M TSO SPOC output (for QUERY command): MbrName SYS3 SYS3 SYS3 CC 0 0 0 Trancode Lterm IAPMDI26 IAPMDI27 IAPMDI27 Userid Program USRT001 USRT001 USRT003 LERunOpts AAAA BBBB CCCC OM API input: CMD(UPD CMD(UPD CMD(UPD CMD(QRY LE LE LE LE TRAN(IAPMDI27) USERID(USRT003) SET(LERUNOPTS(cccc))) TRAN(IAPMDI27) USERID(USRT001) SET(LERUNOPTS(bbbb))) TRAN(IAPMDI26) USERID(USRT001) SET(LERUNOPTS(aaaa))) SHOW(ALL)) OM API output (for QUERY command): <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.1.0</omvsn> <xmlvsn>1 </xmlvsn> <statime>2002.163 18:10:14.974557</statime> <stotime>2002.163 18:10:14.974985</stotime> <staseq>B7C4CD747AC5DC85</staseq> <stoseq>B7C4CD747AE09D25</stoseq> <rqsttkn1>USRT002 10111014</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(IAPMDI26) LTRM( ) UID(USRT001 ) PGM( ) PRM(AAAA ) </rsp> <rsp>MBR(SYS3 ) CC( 0) TRAN(IAPMDI27) LTRM( ) UID(USRT001 ) PGM( ) PRM(BBBB ) </rsp> <rsp>MBR(SYS3 ) CC( 0) TRAN(IAPMDI27) LTRM( ) UID(USRT003 ) PGM( ) PRM(CCCC ) </rsp> </cmdrspdata> </imsout> Example 3 for DELETE LE command TSO SPOC input: DEL LE TRAN(IAPMDI27) USERID(USRT001) Chapter 23. DELETE commands 343 TSO SPOC output: MbrName SYS3 CC Trancode Lterm 0 IAPMDI27 Userid Program USRT001 OM API input: CMD(DEL LE TRAN(IAPMDI27) USERID(USRT001)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.1.0</omvsn> <xmlvsn>1 </xmlvsn> <statime>2002.163 18:12:21.932813</statime> <stotime>2002.163 18:12:21.933334</stotime> <staseq>B7C4CDED8E70D786</staseq> <stoseq>B7C4CDED8E916246</stoseq> <rqsttkn1>USRT002 10111221</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>SYS3 </master> <userid>USRT002 </userid> <verb>DEL </verb> <kwd>LE </kwd> <input>DEL LE TRAN(IAPMDI27) USERID(USRT001) </input> </cmd> <cmdrsphdr> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="A" dtype="CHAR" align="left" /> <hdr slbl="CC" llbl="CC" scope="LCL" sort="N" dtype="INT" align="right" /> <hdr slbl="TRAN" llbl="Trancode" scope="LCL" sort="N" dtype="CHAR" align="left" /> <hdr slbl="LTRM" llbl="Lterm" scope="LCL" sort="N" dtype="CHAR " align="left" /> <hdr slbl="UID" llbl="Userid" scope="LCL" sort="N" dtype="CHAR " align="left" /> <hdr slbl="PGM" llbl="Program" scope="LCL" sort="N" dtype="CHAR" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>MBR(SYS3 ) CC( 0) TRAN(IAPMDI27) LTRM( </rsp> </cmdrspdata> </imsout> key="1" scroll="NO" len="8" key="0" scroll="YES" len="4" key="0" scroll="YES" len="8" key="0" scroll="YES" len="8" key="0" scroll="YES" len="8" key="0" scroll="YES" len="8" ) UID(USRT001 ) PGM( ) Explanation: This command specifies two filters- transaction and userid. A table entry is deleted if both of these filters are defined and match what was specified in the command. This command deletes one entry from the table. That entry is shown in the command output. Example 4 for DELETE LE command TSO SPOC input: DEL LE USERID(USRT00%) TSO SPOC output: MbrName SYS3 SYS3 344 CC Trancode Lterm 0 IAPMDI26 0 IAPMDI27 Commands, Volume 1: IMS Commands A - M Userid Program USRT001 USRT003 OM API input: CMD(DEL LE USERID(USRT00%)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.1.0</omvsn> <xmlvsn>1 </xmlvsn> <statime>2002.163 18:19:45.616468</statime> <stotime>2002.163 18:19:45.616972</stotime> <staseq>B7C4CF94AFA54304</staseq> <stoseq>B7C4CF94AFC4C704</stoseq> <rqsttkn1>USRT002 10111945</rqsttkn1> <rc>00000000</rc> <rsn>00000000</rsn> </ctl> <cmd> <master>SYS3 </master> <userid>USRT002 </userid> <verb>DEL </verb> <kwd>LE </kwd> <input>DEL LE USERID(USRT00%) </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" /> </cmdrsphdr> <cmdrspdata> <rsp>MBR(SYS3 ) CC( 0) TRAN(IAPMDI26) LTRM( ) UID(USRT001 ) PGM( ) </rsp> <rsp>MBR(SYS3 ) CC( 0) TRAN(IAPMDI27) LTRM( ) UID(USRT003 ) PGM( ) </rsp> </cmdrspdata> </imsout> Explanation: This command specifies only one filter, userid. A wildcard is used, so any table entry where the USERID filter matches the string will be deleted. The command output shows that both of the remaining table entries were deleted. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 Chapter 23. DELETE commands 345 DELETE OTMADESC command Use the DELETE OTMADESC command to delete an existing OTMA destination descriptor without restarting IMS. Subsections: v “Environment” v “Syntax” v v v v v “Keywords” “Usage notes” on page 347 “Output fields” on page 347 “Return, reason, and completion codes” on page 347 “Examples” on page 348 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the commands and keywords. Table 182. Valid environments for the DELETE OTMADESC command and keywords Command / Keywords DB/DC DBCTL DCCTL DELETE OTMADESC X X NAME X X OPTION X X Syntax , NOWILDCARD DELETE OTMADESC NAME( descname* ) OPTION( ) WILDCARD Keywords The following keywords are valid for the DELETE OTMADESC command: NAME(descname*) A required keyword parameter that specifies a 1- to 8-character destination routing descriptor name. The destination routing descriptor name can have an asterisk (*) at the end to mask a group of names. The asterisk can be used by itself to mask all defined descriptor names in the system. Issuing the DELETE command with a name of asterisk only will delete all entries in the destination routing descriptors. If you intend to delete all entries in the table, you must specify DELETE NAME(*) OPTION(WILDCARD). All entries including the entry of asterisk are deleted. OPTION(NOWILDCARD | WILDCARD) Specify NOWILDCARD to delete the descriptor having a name with an asterisk as an entry from the table of destination routing descriptors. Specify WILDCARD to delete the groups of names that the asterisk is masking. If the name with the asterisk is also an entry in the table, the name with the asterisk itself is deleted. 346 Commands, Volume 1: IMS Commands A - M Usage notes The DELETE OTMADESC command requires only the NAME keyword. If the NAME keyword contains the masked character of asterisk, it will not delete the group of names it is masking. It will only delete the name with the asterisk as its own entry in the destination routing descriptors. If the OPTION(WILDCARD) keyword is specified, then the group of names under a masked destination routing descriptor name will also be deleted; the name with the asterisk is also deleted. Log records will be created to track the dynamic changes to destination routing descriptors on restart of IMS. The DELETE OTMADESC command is not valid in an XRF alternate or an RSR tracking environment. Output fields The following table shows the DELETE OTMADESC output fields. The columns in the table are: Short label Contains the short label generated in the XML output. Long label Contains the column heading for the output field in the formatted 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. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 183. Output fields for the DELETE OTMADESC command Short label Long label Keyword Meaning CC CC N/A Completion code for the line of output. The completion code indicates whether IMS was able to process the command for the specified resource. See “Return, reason, and completion codes” for more information. The completion code is always returned. CCTXT CCText N/A Completion code text that briefly explains the meaning of the non-zero completion code. This field is returned only for an error completion code. DEST DestName NAME Destination name. MBR MbrName N/A Member name. Return, reason, and completion codes An IMS return and reason code is returned to OM by the DELETE OTMADESC command. The OM return and reason codes that may be returned as a result of the DELETE OTMADESC command are standard for all commands entered through the OM API. The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Chapter 23. DELETE commands 347 Table 184. Return and reason codes for the DELETE OTMADESC command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. See Table 185 for details. X'02000008' X'00002000' The command contains an invalid verb or no client is registered for the verb. X'02000008' X'00002004' The command contains an invalid primary keyword or no client is registered for the keyword. X'02000008' X'00002028' The command contains an invalid keyword. X'02000008' X'0000202C' The command contains an unknown positional parameter. X'02000008' X'00002034' The command contains an incomplete keyword parameter. X'02000008' X'00002038' The command is missing a required parameter. X'02000008' X'0000203C' The command contains an invalid keyword parameter value. The following table includes an explanation of the completion codes. Errors unique to the processing of this command are returned as completion codes. A completion code is returned for each action against an individual resource. Table 185. Completion codes for the DELETE OTMADESC command Completion code Completion code text Meaning Command completed successfully The DELETE OTMADESC command completed successfully for the resource. 163 Descriptor not available for del During delete processing, the entry in the table of destination routing descriptors might have already been deleted by another user. 166 No entries found Command failed for DELETE OTMADESC, because no entries were found in the table of destination routing descriptors. 0 Examples The following are examples of the DELETE OTMADESC command: Example 1 for DELETE OTMADESC command TSO SPOC input: DELETE OTMADESC NAME(OTMACL*) TSO SPOC output: DestName OTMACL* 348 MbrName IMSA Commands, Volume 1: IMS Commands A - M CC 0 Explanation: The DELETE command will delete only OTMACL* and not delete OTMACL99, because the default for the OPTION keyword is NOWILDCARD. It treats OTMACL* as a standalone entry in the table of destination routing descriptors. Example 2 for DELETE OTMADESC command TSO SPOC input: DELETE OTMADESC NAME(OTMACL*) OPTION(WILDCARD) TSO SPOC output: DestName OTMACL99 OTMACL* MbrName IMSA IMSA CC 0 0 Explanation: The DELETE command will delete both OTMACL99 and OTMACL*, because the OPTION keyword is coded with WILDCARD. It treats OTMACL* as a mask for a group of names, so it includes OTMACL99 and OTMACL* as an entry in itself in the table of destination routing descriptors. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 DELETE PGM command Use the DELETE PGM command to delete program resources. Subsections: v “Environment” v “Syntax” on page 350 v “Keywords” on page 350 v “Usage notes” on page 350 v “Output fields” on page 351 v “Return, reason, and completion codes” on page 351 v “Examples” on page 353 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 186. Valid environments for the DELETE PGM command and keywords Command / Keywords DB/DC DBCTL DCCTL DELETE PGM X X X NAME X X X OPTION X X X Chapter 23. DELETE commands 349 Syntax , DELETE DEL PGM NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE PGM command: NAME Specifies the 1-8 character name of the program. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the resource names that are processed. For NAME(*), command responses are returned only for the resource names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the resource names that are processed. OPTION Specifies additional functions to be performed along with the command. ALLRSP Indicates that the response lines are to be returned for all resources that are processed on the command. The default action is to return response lines only for the resources that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values. Usage notes This command can only be issued through the Operations Manager API. This command applies to DB/DC systems, DBCTL systems, and DCCTL systems. The DELETE PGM command is not valid on the XRF alternate, RSR tracker, or FDBR region. The DELETE PGM command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each program is deleted individually, unlike the online change process where either all programs are deleted or no programs are deleted. The runtime resource definition for a program can be deleted only if the program is not in use. If the program is in use, the delete fails. In a sysplex environment with multiple IMS systems, the delete might succeed on some IMS systems and fail on others. The DELETE PGM command removes ACB members from the 31-bit nonresident pool as well as the 64-bit storage pool. The resources remain deleted across an IMS warm start or emergency restart. To ensure that the resources remain deleted across a cold start, the existing resource definitions must be exported to a system RDDS and then imported from the RDDS at cold start. Or, if the IMSRSC repository is enabled, the DELETE DEFN command must be issued to delete the definition from the repository. If the resource definitions are to be imported from the MODBLKS data set at cold start instead of from an RDDS, the resource definitions must be deleted from system definition and a new MODBLKS data set must be generated. 350 Commands, Volume 1: IMS Commands A - M The DELETE command is not allowed for IMS resources that are identified with a definition type of IMS. For DELETE PGM commands, this means Fast Path utility program DBF#FPU0. Output fields The following table shows the DELETE PGM output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 187. Output fields for the DELETE PGM command Short label Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the meaning of the non-zero completion code. ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a non-zero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. PGM PgmName PGM Program name. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 188. Return and reason codes for the DELETE PGM command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only resources with non-zero completion codes are returned. See the completion code table for details. Chapter 23. DELETE commands 351 Table 188. Return and reason codes for the DELETE PGM command (continued) Return code Reason code Meaning X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 189. Completion codes for the DELETE PGM command Completion code Completion code text 0 Meaning Command completed successfully for program. 10 NO RESOURCES FOUND Program name is invalid, or the wildcard parameter specified does not match any resource names. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this program. This could also mean this command, if the resource is specified by more than one specific or wildcard parameter. 48 NOT ALLOWED FOR IMS RESOURCE DELETE command not allowed for IMS descriptor or resource. An example of an IMS resource include DBF#FPU0. 73 PROGRAM SCHEDULED Program is scheduled. 7B REFERENCED BY RTCODE Routing code references the program to be deleted. The routing code name is returned as error text. Suggested actions: v Issue DELETE RTC command to delete the routing code. or v Issue UPDATE RTC command to update the program to another name. 352 Error text Commands, Volume 1: IMS Commands A - M rtcodename (8 chars) Table 189. Completion codes for the DELETE PGM command (continued) Completion code 88 Completion code text Meaning Error text REFERENCED BY TRAN Transaction references the program to be deleted. The transaction name is returned as error text. Suggested actions: tranname (8 char) v Issue DELETE TRAN command to delete the transaction. or v Issue UPDATE TRAN command to update the program to another name. | | | | | 1D7 IMPORT CHANGE LIST ERROR Resource is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The resource cannot be deleted until it is successfully imported. Examples The following are examples of the DELETE PGM command: Example 1 for DELETE PGM command TSO SPOC input: DELETE PGM NAME(DFSSAM02,AUTPSB2,BADNAME,DFSSAM04) TSO SPOC output: Response PgmName AUTPSB2 BADNAME DFSSAM02 DFSSAM04 DFSSAM04 DFSSAM04 DFSSAM04 for: DELETE PGM NAME(DFSSAM02,AUTPSB2,BADNAME,DFSSAM04) MbrName CC CCText ErrorText IMS1 0 IMS1 10 NO RESOURCES FOUND IMS1 88 REFERENCED BY TRAN PART IMS1 88 REFERENCED BY TRAN ADDINV IMS1 88 REFERENCED BY TRAN ADDPART IMS1 88 REFERENCED BY TRAN DLETINV IMS1 88 REFERENCED BY TRAN DLETPART OM API input: CMD(DEL PGM NAME(DFSSAM02,AUTPSB2,BADNAME,DFSSAM04)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.310 23:38:41.930125</statime> <stotime>2006.310 23:38:41.931770</stotime> <staseq>BFAACDEBAF38D540</staseq> <stoseq>BFAACDEBAF9FA480</stoseq> <rqsttkn1>USRT011 10153841</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> Chapter 23. DELETE commands 353 <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>PGM </kwd> <input>DELETE PGM NAME(DFSSAM02,AUTPSB2,BADNAME,DFSSAM04) </input> </cmd> <cmdrsphdr> <hdr slbl="PGM" llbl="PgmName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>PGM(DFSSAM02) MBR(IMS1) CC( 88) CCTXT(REFERENCED BY TRAN) ERRT(PART ) </rsp> <rsp>PGM(AUTPSB2 ) MBR(IMS1) CC( 0) </rsp> <rsp>PGM(BADNAME ) MBR(IMS1) CC( 10) CCTXT(NO RESOURCES FOUND) </rsp> <rsp>PGM(DFSSAM04) MBR(IMS1) CC( 88) CCTXT(REFERENCED BY TRAN) ERRT(ADDINV ) </rsp> <rsp>PGM(DFSSAM04) MBR(IMS1) CC( 88) CCTXT(REFERENCED BY TRAN) ERRT(ADDPART ) </rsp> <rsp>PGM(DFSSAM04) MBR(IMS1) CC( 88) CCTXT(REFERENCED BY TRAN) ERRT(DLETINV ) </rsp> <rsp>PGM(DFSSAM04) MBR(IMS1) CC( 88) CCTXT(REFERENCED BY TRAN) ERRT(DLETPART) </rsp> </cmdrspdata> </imsout> Explanation: Delete programs DFSSAM02, AUTPSB2, BADNAME, and DFSSAM04. The delete is successful for program AUTPSB2, as shown by the completion code 0. The delete is rejected for DFSSAM02, because transaction PART refers to it. The delete fails for program DFSSAM04 fails, because transactions ADDPART, ADDINV, DLETPART, and DLETINV refer to it. Transactions PART, ADDPART, ADDINV, DLETPART, and DLETINV must either be deleted or updated to refer to another program before deleting programs DFSSAM02 and DFSSAM04. The delete fails for BADNAME, because there is no program named BADNAME. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related tasks: Deleting runtime application program resource and descriptor definitions with the DELETE command (System Definition) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 354 Commands, Volume 1: IMS Commands A - M DELETE PGMDESC command Use the DELETE PGMDESC command to delete program descriptors. Subsections: v v v v v v v “Environment” “Syntax” “Keywords” “Usage notes” on page 356 “Output fields” on page 356 “Return, reason, and completion codes” on page 357 “Examples” on page 358 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 190. Valid environments for the DELETE PGMDESC command and keywords Command / Keywords DB/DC DBCTL DCCTL DELETE PGMDESC X X X NAME X X X OPTION X X X Syntax , DELETE DEL PGMDESC NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE PGMDESC command: NAME Specifies the 1-8 character name of the program descriptor. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the descriptor names that are processed. For NAME(*), command responses are returned only for the descriptor names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the descriptor names that are processed. OPTION Specifies additional functions to be performed along with the command. ALLRSP Indicates that the response lines are to be returned for all descriptors that are processed on the command. The default action is to return response lines only for the descriptors that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values. Chapter 23. DELETE commands 355 Usage notes This command can only be issued through the Operations Manager API. This command applies to DB/DC systems, DBCTL systems, and DCCTL systems. The DELETE PGMDESC command is not valid on the XRF alternate, RSR tracker, or FDBR region. The DELETE PGMDESC command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each descriptor is deleted individually. Individual deletion does not work like online change where either all descriptors are deleted or no descriptors are deleted. Descriptors can be successfully deleted if they are not currently in use. If a descriptor is in use, the delete fails. In a sysplex environment, the delete might succeed on some IMS systems and fail on others. A descriptor is in use if another command is in progress that references the descriptor. The descriptors remain deleted across an IMS warm start or emergency restart. To ensure they remain deleted across a cold start, the existing descriptor definitions must be exported to an RDDS and imported from the RDDS at cold start. The DELETE PGMDESC command is not allowed for IMS descriptors that are identified with a definition type of IMS. For DELETE PGMDESC commands, this means IMS-defined program descriptor DFSDSPG1. Output fields The following table shows the DELETE PGMDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 191. Output fields for the DELETE PGMDESC command 356 Short label Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the meaning of the non-zero completion code. DESC DescName PGMDESC Program descriptor name. ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a non-zero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. Commands, Volume 1: IMS Commands A - M Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 192. Return and reason codes for the DELETE PGMDESC command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only descriptors with nonzero completion codes are returned. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 193. Completion codes for the DELETE PGMDESC command Completion code Completion code text 0 10 Meaning Command completed successfully for program descriptor. NO RESOURCES FOUND Program name is invalid, or the wildcard parameter specified does not match any program descriptor names. Chapter 23. DELETE commands 357 Table 193. Completion codes for the DELETE PGMDESC command (continued) Completion code | | | | | | Completion code text Meaning 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this program descriptor. This could also mean this command, if the descriptor is specified by more than one specific or wildcard parameter. 27 REJECTED FOR DEFAULT DESCRIPTOR DELETE command not allowed for user-defined default descriptor. You must issue an UPDATE command to set another descriptor as the default before deleting this descriptor. 48 NOT ALLOWED FOR IMS RESOURCE DELETE command not allowed for IMS-defined descriptor. An example of an IMS-defined descriptor is DFSDSPG1. IMPORT CHANGE LIST ERROR Descriptor is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The descriptor cannot be deleted until it is successfully imported. 1D7 Examples The following are examples of the DELETE PGMDESC command: Example 1 for DELETE PGMDESC command TSO SPOC input: DEL PGMDESC NAME(*) OPTION(ALLRSP) TSO SPOC output: Response DescName DESC001 DESC002 DESC003 DESC004 DESC005 DFSDSPG1 DOPTDESC FPEDESC GPSBDESC PARLDESC RESDESC TLSDESC for: DEL PGMDESC NAME(*) OPTION(ALLRSP) MbrName CC CCText IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 48 NOT ALLOWED FOR IMS RESOURCE IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 27 REJECTED FOR DEFAULT DESCRIPTOR OM API input: CMD(DEL PGMDESC NAME(*) OPTION(ALLRSP)) OM API output: <imsout> <ctl> <omname>OM1OM 358 </omname> Commands, Volume 1: IMS Commands A - M <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.310 23:09:24.532552</statime> <stotime>2006.310 23:09:24.533243</stotime> <staseq>BFAAC75FB314869E</staseq> <stoseq>BFAAC75FB33FB7DE</stoseq> <rqsttkn1>USRT011 10150924</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>PGMDESC </kwd> <input>DEL PGMDESC NAME(*) OPTION(ALLRSP) </input> </cmd> <cmdrsphdr> <hdr slbl="DESC" llbl="DescName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>DESC(DESC004 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC005 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC001 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DOPTDESC) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(RESDESC ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DFSDSPG1) MBR(IMS1) CC( 48) CCTXT(NOT ALLOWED FOR IMS RESOURCE) </rsp> <rsp>DESC(TLSDESC ) MBR(IMS1) CC( 27) CCTXT(REJECTED FOR DEFAULT DESCRIPTOR) </rsp> <rsp>DESC(DESC002 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(PARLDESC) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC003 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(FPEDESC ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(GPSBDESC) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> Explanation: A DELETE PGMDESC command is issued to delete all program descriptors from an active IMS system. Many program descriptors are successfully deleted, as indicated by the completion code 0. Because the DELETE command attempted to delete all of the program descriptors, OPTION(ALLRSP) is specified to display the successfully deleted program descriptors. Program descriptor TLSDESC fails, because it is the default program descriptor. Program descriptor DFSDSPG1 fails, because it is the IMS-defined program descriptor. Chapter 23. DELETE commands 359 Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 DELETE RTC command Use the DELETE RTC command to delete Fast Path routing codes. Subsections: v v v v v v v “Environment” “Syntax” “Keywords” “Usage notes” on page 361 “Output fields” on page 361 “Return, reason, and completion codes” on page 362 “Examples” on page 363 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 194. Valid environments for the DELETE RTC command and keywords Command / Keywords DB/DC DBCTL DCCTL DELETE RTC X X NAME X X OPTION X X Syntax , DELETE DEL RTC NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE RTC command: NAME Specifies the 1-8 character name of the routing code. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the resource names that are processed. For NAME(*), command responses are returned only for the resource names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the resource names that are processed. 360 Commands, Volume 1: IMS Commands A - M OPTION Specifies additional functions to be performed along with the command. ALLRSP Indicates that the response lines are to be returned for all resources that are processed on the command. The default action is to return response lines only for the resources that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values. Usage notes This command can only be issued through the Operations Manager API. This command applies to DB/DC systems and DCCTL systems. The DELETE RTC command applies if Fast Path is installed. The DELETE RTC command is not valid on the XRF alternate, RSR tracker, or FDBR region. The DELETE RTC command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each routing code is deleted individually, unlike the online change process where either all routing codes are deleted or no routing codes are deleted. The runtime resource definition for a routing code can only be deleted if the routing code is not in use. If the routing code is in use, the delete fails. In a sysplex environment with multiple IMSs, the delete might succeed on some IMSs and fail on others. The resources remain deleted across an IMS warm start or emergency restart. To ensure that the resources remain deleted across a cold start, the existing resource definitions must be exported to a system RDDS and then imported from the RDDS at cold start. Or, if the IMSRSC repository is enabled, the DELETE DEFN command must be issued to delete the definition from the repository. If the resource definitions are to be imported from the MODBLKS data set at cold start instead of from an RDDS, the resource definitions must be deleted from system definition and a new MODBLKS data set must be generated. Output fields The following table shows the DELETE RTC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 195. Output fields for the DELETE RTC command Short label Long label Keyword Meaning CC CC N/A Completion code. Chapter 23. DELETE commands 361 Table 195. Output fields for the DELETE RTC command (continued) Short label Long label Keyword Meaning CCTXT CCText error Completion code text that briefly explains the meaning of the non-zero completion code. ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a non-zero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. RTC RtcName RTC Routing code name. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 196. Return and reason codes for the DELETE RTC command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only resources with non-zero completion codes are returned. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No Fast Path defined. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. 362 Commands, Volume 1: IMS Commands A - M Table 197. Completion codes for the DELETE RTC command Completion code Completion code text 0 | | | | | | Meaning Command completed successfully for routing code. 10 NO RESOURCES FOUND Routing code name is invalid, or the wildcard parameter specified does not match any routing code names. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this routing code. This could also mean this command, if the resource is specified by more than one specific or wildcard parameter. 39 FP(E) TRAN FOR RTC EXISTS Routing code was created by IMS for a Fast Path exclusive transaction and cannot be deleted by a DELETE RTC command. The routing code can only be deleted by a DELETE TRAN command for the Fast Path exclusive transaction. 73 PROGRAM SCHEDULED Program is scheduled. IMPORT CHANGE LIST ERROR Resource is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The resource cannot be deleted until it is successfully imported. 1D7 Examples The following are examples of the DELETE RTC command: Example 1 for DELETE RTC command TSO SPOC input: DEL RTC NAME(OLCFR102,GFP1,BADNAME,EMHTX32,EMHTX32) TSO SPOC output: Response RtcName BADNAME EMHTX32 EMHTX32 GFP1 OLCFR102 for: DEL RTC NAME(OLCFR102,GFP1,BADNAME,EMHTX32,EMHTXT32) MbrName CC CCText IMS1 10 NO RESOURCES FOUND IMS1 0 IMS1 17 ANOTHER CMD IN PROGRESS IMS1 39 FP(E) TRAN FOR RTC EXISTS IMS1 0 OM API input: CMD(DEL RTC NAME(OLCFR102,GFP1,BADNAME,EMHTX32,EMHTX32)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> Chapter 23. DELETE commands 363 <xmlvsn>20 </xmlvsn> <statime>2006.310 23:55:52.034690</statime> <stotime>2006.310 23:55:52.035318</stotime> <staseq>BFAAD1C2119824D2</staseq> <stoseq>BFAAD1C211BF6E52</stoseq> <rqsttkn1>USRT011 10155552</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>RTC </kwd> <input>DEL RTC NAME(OLCFR102,GFP1,BADNAME,EMHTX32,EMHTX32) </input> </cmd> <cmdrsphdr> <hdr slbl="RTC" llbl="RtcName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>RTC(OLCFR102) MBR(IMS1) CC( 0) </rsp> <rsp>RTC(GFP1 ) MBR(IMS1) CC( 39) CCTXT(FP(E) TRAN FOR RTC EXISTS) </rsp> <rsp>RTC(BADNAME ) MBR(IMS1) CC( 10) CCTXT(NO RESOURCES FOUND) </rsp> <rsp>RTC(EMHTX32 ) MBR(IMS1) CC( 0) </rsp> <rsp>RTC(EMHTX32 ) MBR(IMS1) CC( 17) CCTXT(ANOTHER CMD IN PROGRESS) </rsp> </cmdrspdata> </imsout> Explanation: A DELETE RTC command is issued to delete several Fast Path routing codes from a running IMS system. The delete succeeds for some routing codes, as shown by completion code 0. The delete fails for routing code BADNAME, because no such routing code exists. The delete fails for routing code GFP1, because it was created for a Fast Path exclusive transaction called GFP1 and can only be deleted by a DELETE TRAN NAME(GFP1) command. Routing code EMHTX32 is successfully deleted, but routing code EMHTX32 is specified again, which fails because the DELETE RTC command is already in progress for EMHTX32. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related tasks: 364 Commands, Volume 1: IMS Commands A - M Deleting runtime Fast Path routing code resource and descriptor definitions with the DELETE command (System Definition) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 DELETE RTCDESC command Use the DELETE RTCDESC command to delete Fast Path routing code descriptors. Subsections: v v v v v v v “Environment” “Syntax” “Keywords” “Usage notes” on page 366 “Output fields” on page 366 “Return, reason, and completion codes” on page 367 “Examples” on page 368 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 198. Valid environments for the DELETE RTCDESC command and keywords Command / Keywords DB/DC DBCTL DCCTL DELETE RTCDESC X X NAME X X OPTION X X Syntax , DELETE DEL RTCDESC NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE RTCDESC command: NAME Specifies the 1-8 character name of the routing code descriptor. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the descriptor names that are processed. For NAME(*), command responses are returned only for the descriptor names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the descriptor names that are processed. OPTION Specifies additional functions to be performed along with the command. Chapter 23. DELETE commands 365 ALLRSP Indicates that the response lines are to be returned for all descriptors that are processed on the command. The default action is to return response lines only for the descriptors that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values. Usage notes This command can only be issued through the Operations Manager API. This command applies to DB/DC systems and DCCTL systems. The DELETE RTCDESC command applies if Fast Path is installed. The DELETE RTCDESC command is not valid on the XRF alternate, RSR tracker, or FDBR region. The DELETE RTCDESC command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each descriptor is deleted individually. Individual deletion does not work like online change where either all descriptors are deleted or no descriptors are deleted. Descriptors can be successfully deleted if they are not currently in use. If a descriptor is in use, the delete fails. In a sysplex environment, the delete might succeed on some IMS systems and fail on others. A descriptor is in use if another command is in progress that references the descriptor. The descriptors remain deleted across an IMS warm start or emergency restart. To ensure they remain deleted across a cold start, the existing descriptor definitions must be exported to an RDDS and then imported from the RDDS at cold start. The IMS-defined routing code descriptor (DBFDSRT1) cannot be deleted with the DELETE RTCDESC command. Output fields The following table shows the DELETE RTCDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 199. Output fields for the DELETE RTCDESC command 366 Short label Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the meaning of the non-zero completion code. DESC DescName RTCDESC Routing code descriptor name. Commands, Volume 1: IMS Commands A - M Table 199. Output fields for the DELETE RTCDESC command (continued) Short label Long label Keyword Meaning ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a non-zero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 200. Return and reason codes for the DELETE RTCDESC command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only descriptors with non-zero completion codes are returned. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004024' No Fast Path defined. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Chapter 23. DELETE commands 367 Table 201. Completion codes for the DELETE RTCDESC command Completion code Completion code text 0 | | | | | | Meaning Command completed successfully for routing code descriptor. 10 NO RESOURCES FOUND Routing code descriptor name is invalid, or the wildcard parameter specified does not match any routing code descriptor names. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this routing code descriptor. This could also mean this command, if the descriptor is specified by more than one specific or wildcard parameter. 27 REJECTED FOR DEFAULT DESCRIPTOR DELETE command not allowed for user-defined default descriptor. You must issue an UPDATE command to set another descriptor as the default before deleting this descriptor. 48 NOT ALLOWED FOR IMS RESOURCE DELETE command not allowed for IMS descriptor. An example of an IMS descriptor is DBFDSRT1. IMPORT CHANGE LIST ERROR Descriptor is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The descriptor cannot be deleted until it is successfully imported. 1D7 Examples The following are examples of the DELETE RTCDESC command: Example 1 for DELETE RTCDESC command TSO SPOC input: DEL RTCDESC NAME(*) OPTION(ALLRSP) TSO SPOC output: Response DescName DBFDSRT1 DESC001 DESC002 DESC003 DESC004 DESC005 RTCDESC1 for: DEL RTCDESC NAME(*) OPTION(ALLRSP) MbrName CC CCText IMS1 48 NOT ALLOWED FOR IMS RESOURCE IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 27 REJECTED FOR DEFAULT DESCRIPTOR OM API input: CMD(DEL RTCDESC NAME(*) OPTION(ALLRSP)) OM API output: 368 Commands, Volume 1: IMS Commands A - M <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.310 22:57:13.782312</statime> <stotime>2006.310 22:57:13.783073</stotime> <staseq>BFAAC4A6CD428992</staseq> <stoseq>BFAAC4A6CD721DC0</stoseq> <rqsttkn1>USRT011 10145713</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003000</rsn> <rsntxt>At least one request successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>RTCDESC </kwd> <input>DEL RTCDESC NAME(*) OPTION(ALLRSP) </input> </cmd> <cmdrsphdr> <hdr slbl="DESC" llbl="DescName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" /> </cmdrsphdr> <cmdrspdata> <rsp>DESC(DESC004 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC005 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC001 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(RTCDESC1) MBR(IMS1) CC( 27) CCTXT(REJECTED FOR DEFAULT DESCRIPTOR) </rsp> <rsp>DESC(DBFDSRT1) MBR(IMS1) CC( 48) CCTXT(NOT ALLOWED FOR IMS RESOURCE) </rsp> <rsp>DESC(DESC002 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC003 ) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> Explanation: A DELETE RTCDESC command is issued to delete all routing code descriptors from an active IMS system. Many routing code descriptors are successfully deleted, as indicated by the completion code 0. Because the DELETE command attempted to delete all of the routing code descriptors, OPTION(ALLRSP) is specified to display the successfully deleted routing code descriptors. Routing code descriptor RTCDESC1 fails, because it is the default routing code descriptor. Routing code descriptor DBFDSRT1 fails, because it is the IMS-defined routing code descriptor. Related concepts: Chapter 23. DELETE commands 369 How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 DELETE TRAN command Use the DELETE TRAN command to delete transactions. Subsections: v v v v v v v “Environment” “Syntax” “Keywords” “Usage notes” on page 371 “Output fields” on page 371 “Return, reason, and completion codes” on page 372 “Examples” on page 374 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 202. Valid environments for the DELETE TRAN command and keywords Command / Keywords DB/DC DBCTL DCCTL DELETE TRAN X X NAME X X OPTION X X Syntax , DELETE DEL TRAN NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE TRAN command: NAME Specifies the 1-8 character name of the transaction. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the resource names that are processed. For NAME(*), command responses are returned only for the resource names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the resource names that are processed. OPTION Specifies additional functions to be performed along with the command. 370 Commands, Volume 1: IMS Commands A - M ALLRSP Indicates that the response lines are to be returned for all resources that are processed on the command. The default action is to return response lines only for the resources that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values. Usage notes This command can only be issued through the OM API. This command applies to DB/DC systems and DCCTL systems. The DELETE TRAN command is not valid on the XRF alternate, RSR tracker, or FDBR region. The DELETE TRAN command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each transaction is deleted individually, unlike the online change process where either all transactions are deleted or no transactions are deleted. The runtime resource definition for a transaction can only be deleted if the transaction is not in use. If the transaction is in use, the delete fails. In a sysplex environment with multiple IMS systems, the delete might succeed on some IMS systems and fail on others. The resources remain deleted across an IMS warm start or emergency restart. To ensure that the resources remain deleted across a cold start, the existing resource definitions must be exported to a system RDDS and then imported from the RDDS at cold start. Or, if the IMSRSC repository is enabled, the DELETE DEFN command must be issued to delete the definition from the repository. If the resource definitions are to be imported from the MODBLKS data set at cold start instead of from an RDDS, the resource definitions must be deleted from system definition and a new MODBLKS data set must be generated. The DELETE TRAN command stops all queuing and scheduling of the transaction. If the transaction is a Fast Path exclusive transaction, the routing code by the same name is deleted as well. Output fields The following table shows the DELETE TRAN output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Chapter 23. DELETE commands 371 Table 203. Output fields for the DELETE TRAN command Short label Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the nonzero completion code. CONVID ConvID TRAN Conversation id of conversation associated with transaction that caused the delete to fail with a completion code of C'1A'. This information may be used to exit the conversation, before attempting the delete again. ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a nonzero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. LU LUName TRAN APPC LU name associated with the transaction conversation that caused the delete to fail with a completion code of C'1A'. This information may be used to exit the conversation, before attempting the delete again. NODE NodeName TRAN Node name of static node associated with transaction conversation that caused the delete to fail with a completion code of C'1A'. This information may be used to exit the conversation, before attempting the delete again. TMEM TMember TRAN OTMA tmember name associated with transaction conversation that caused the delete to fail with a completion code of C'1A'. This information may be used to exit the conversation, before attempting the delete again. TPIP TPipe TRAN OTMA tpipe name associated with the transaction conversation that caused the delete to fail with a completion code of C'1A'. This information may be used to exit the conversation, before attempting the delete again. TRAN Trancode TRAN Transaction name. USER UserName TRAN User name of dynamic user associated with the transaction conversation that caused the delete to fail with a completion code of C'1A'. This information may be used to exit the conversation, before attempting the delete again. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. 372 Commands, Volume 1: IMS Commands A - M Table 204. Return and reason codes for the DELETE TRAN command Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only resources with nonzero completion codes are returned. See the completion code table for details. X'0000000C' X'00003004' Command was not successful for any of the resources. The command output contains a line for each resource, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 205. Completion codes for the DELETE TRAN command Completion code Completion code text 0 Meaning Command completed successfully for transaction. 10 NO RESOURCES FOUND Transaction name is invalid, or the wildcard parameter specified does not match any transaction names. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this transaction or routing code associated with this transaction, if it is Fast Path exclusive. This could also mean this command, if the resource is specified by more than one specific or wildcard parameter. Chapter 23. DELETE commands 373 Table 205. Completion codes for the DELETE TRAN command (continued) Completion code 1A Completion code text Meaning IN CONVERSATION Transaction is in conversation. The conversation ID and terminal in conversation are returned separately. The terminal can be a static node, node and user, dynamic user, APPC luname, or OTMA tmember and tpipe. Suggested actions: Terminate the conversation. | | | | | | 4A IN USE Transaction is in use. Queuing is in progress, either terminal input or a program-to-program switch. 73 PROGRAM SCHEDULED Program is scheduled. 85 SUSPENDED Transaction is on the suspend queue. 87 TRAN QUEUEING Transaction has messages queued (non-shared-queues environment). 89 TRAN SCHEDULED Transaction is scheduled. B3 ELIGIBLE FOR SCHEDULING Transaction is eligible for scheduling and cannot be deleted. You may need to stop the transaction with an UPDATE TRAN STOP(Q,SCHD) command before attempting the DELETE again. 1D7 IMPORT CHANGE LIST ERROR Resource is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The resource cannot be deleted until it is successfully imported. Examples The following are examples of the DELETE TRAN command: Example 1 for DELETE TRAN command TSO SPOC input: DEL TRAN NAME(AOP,BADNAME,APOL*,BAD*,AOP) TSO SPOC output: Response Trancode AOP AOP APOL11 APOL12 APOL13 APOL14 APOL15 APOL16 374 for: DEL TRAN NAME(AOP,BADNAME,APOL*,BAD*,AOP) MbrName CC CCText IMS1 0 IMS1 17 ANOTHER CMD IN PROGRESS IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 Commands, Volume 1: IMS Commands A - M APOL17 IMS1 APOL18 IMS1 BAD* IMS1 BADNAME IMS1 0 0 10 NO RESOURCES FOUND 10 NO RESOURCES FOUND OM API input: CMD(DEL TRAN NAME(AOP,BADNAME,APOL*,BAD*,AOP)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.311 00:04:00.354581</statime> <stotime>2006.311 00:04:00.355454</stotime> <staseq>BFAAD393C4515645</staseq> <stoseq>BFAAD393C487EF05</stoseq> <rqsttkn1>USRT011 10160400</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003004</rsn> <rsntxt>No requests were successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> <userid>USRT011 </userid> <verb>DEL </verb> <kwd>TRAN </kwd> <input>DEL TRAN NAME(AOP,BADNAME,APOL*,BAD*,AOP) </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="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="CONVID" llbl="ConvID" scope="LCL" sort="n" key="0" scroll="yes" len="4" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="NODE" llbl="NodeName" scope="LCL" sort="n" key="0" scroll="yes" len="8" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="USER" llbl="UserName" scope="LCL" sort="n" key="0" scroll="yes" len="8" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="LU" llbl="LUName" scope="LCL" sort="n" key="0" scroll="yes"len="24" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="TMEM" llbl="TMember" scope="LCL" sort="n" key="0" scroll="yes" len="16" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="TPIP" llbl="TPipe" scope="LCL" sort="n" key="0" scroll="yes" len="8" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>TRAN(AOP ) MBR(IMS1) CC( 0) </rsp> Chapter 23. DELETE commands 375 <rsp>TRAN(BADNAME <rsp>TRAN(APOL11 <rsp>TRAN(BAD* <rsp>TRAN(AOP </rsp> <rsp>TRAN(APOL12 <rsp>TRAN(APOL13 <rsp>TRAN(APOL14 <rsp>TRAN(APOL15 <rsp>TRAN(APOL16 <rsp>TRAN(APOL17 <rsp>TRAN(APOL18 </cmdrspdata> </imsout> ) ) ) ) MBR(IMS1) MBR(IMS1) MBR(IMS1) MBR(IMS1) CC( 10) CCTXT(NO RESOURCES FOUND) </rsp> CC( 0) </rsp> CC( 10) CCTXT(NO RESOURCES FOUND) </rsp> CC( 17) CCTXT(ANOTHER CMD IN PROGRESS) ) ) ) ) ) ) ) MBR(IMS1) MBR(IMS1) MBR(IMS1) MBR(IMS1) MBR(IMS1) MBR(IMS1) MBR(IMS1) CC( CC( CC( CC( CC( CC( CC( 0) 0) 0) 0) 0) 0) 0) </rsp> </rsp> </rsp> </rsp> </rsp> </rsp> </rsp> Explanation: A DELETE TRAN command is issued to delete several transactions from a running IMS system. The delete succeeds for some transactions, as shown by completion code 0. The delete fails for transaction BADNAME, because no such transaction exists. The delete fails for transaction name BAD*, because no transactions start with BAD. Transaction AOP is successfully deleted, but transaction AOP is specified again, which fails because the DELETE TRAN command is already in progress for transaction AOP. Related concepts: How to interpret CSL request return and reason codes (System Programming APIs) Related tasks: Deleting runtime transaction resource and descriptor definitions with the DELETE command (System Definition) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 DELETE TRANDESC command Use the DELETE TRANDESC command to delete transaction descriptors. Subsections: v “Environment” v “Syntax” on page 377 v “Keywords” on page 377 v “Usage notes” on page 377 v “Output fields” on page 378 v “Return, reason, and completion codes” on page 378 v “Examples” on page 380 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 206. Valid environments for the DELETE TRANDESC command and keywords 376 Command / Keywords DB/DC DELETE TRANDESC X X NAME X X Commands, Volume 1: IMS Commands A - M DBCTL DCCTL Table 206. Valid environments for the DELETE TRANDESC command and keywords (continued) Command / Keywords DB/DC OPTION DBCTL DCCTL X X Syntax , DELETE DEL TRANDESC NAME( name* ) OPTION(ALLRSP) Keywords The following keywords are valid for the DELETE TRANDESC command: NAME Specifies the 1-8 character name of the transaction descriptor. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the descriptor names that are processed. For NAME(*), command responses are returned only for the descriptor names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the descriptor names that are processed. OPTION Specifies additional functions to be performed along with the command. ALLRSP Indicates that the response lines are to be returned for all descriptors that are processed on the command. The default action is to return response lines only for the descriptors that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values. Usage notes This command can only be issued through the Operations Manager API. This command applies to DB/DC systems and DCCTL systems. The DELETE TRANDESC command is not valid on the XRF alternate, RSR tracker, or FDBR region. The DELETE TRANDESC command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined). This command is recoverable. Each descriptor is deleted individually. Individual deletion does not work like online change where either all descriptors are deleted or no descriptors are deleted. Descriptors can be successfully deleted if they are not currently in use. If a descriptor is in use, the delete fails. In a sysplex environment, the delete might succeed on some IMS systems and fail on others. A descriptor is in use if another command is in progress that references the command. The descriptors remain deleted across an IMS warm start or emergency restart. To ensure they remain deleted across a cold start, the existing descriptor definitions must be exported to an RDDS and then imported from the RDDS at cold start. Chapter 23. DELETE commands 377 The DELETE TRANDESC command is not allowed for IMS descriptors that are identified with a definition type of IMS. For DELETE TRANDESC commands, this means IMS transaction descriptor DFSDSTR1. Output fields The following table shows the DELETE TRANDESC output fields. The columns in the table are as follows: Short label Contains the short label generated in the XML output. Long label Contains the long label generated in the XML output. Keyword Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in case of an error. Meaning Provides a brief description of the output field. Table 207. Output fields for the DELETE TRANDESC command Short label Long label Keyword Meaning CC CC N/A Completion code. CCTXT CCText error Completion code text that briefly explains the nonzero completion code. DESC DescName TRANDESC Transaction descriptor name. ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a nonzero completion code and further explains the completion code. MBR MbrName N/A IMSplex member that built the output line. Return, reason, and completion codes The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request. Table 208. Return and reason codes for the DELETE TRANDESC command 378 Return code Reason code Meaning X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. X'0000000C' X'00003000' Command was successful for some descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only descriptors with nonzero completion codes are returned. See the completion code table for details. Commands, Volume 1: IMS Commands A - M Table 208. Return and reason codes for the DELETE TRANDESC command (continued) Return code Reason code Meaning X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, accompanied by its completion code. See the completion code table for details. X'00000010' X'0000400C' Command is not valid on the XRF alternate. X'00000010' X'00004014' Command is not valid on the RSR tracker. X'00000010' X'00004120' Online change phase is in progress. X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined). X'00000014' X'00005004' DFSOCMD response buffer could not be obtained. X'00000014' X'00005008' DFSPOOL storage could not be obtained. X'00000014' X'0000500C' AWE could not be obtained. Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes. Table 209. Completion codes for the DELETE TRANDESC command Completion code Completion code text 0 | | | | | | | Meaning Command completed successfully for transaction descriptor. 10 NO RESOURCES FOUND Transaction descriptor name is invalid, or the wildcard parameter specified does not match any transaction descriptor names. 17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this transaction descriptor. This could also mean this command, if the descriptor is specified by more than one specific or wildcard parameter. 27 REJECTED FOR DEFAULT DESCRIPTOR DELETE command not allowed for user-defined default descriptor. You must issue an UPDATE command to set another descriptor as the default before deleting this descriptor. 48 NOT ALLOWED FOR IMS RESOURCE DELETE command not allowed for IMS descriptor. An example of an IMS descriptor is DFSDSTR1. IMPORT CHANGE LIST ERROR Descriptor is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The descriptor cannot be deleted until it is successfully imported. 1D7 Chapter 23. DELETE commands 379 Examples The following are examples of the DELETE TRANDESC command: Example 1 for DELETE TRANDESC command TSO SPOC input: DEL TRANDESC NAME(*) OPTION(ALLRSP) TSO SPOC output: Response DescName CONVDESC DESC001 DESC002 DESC003 DESC004 DESC005 DESC101 DESC102 DESC103 DESC104 DESC105 DESC201 DESC202 DESC203 DESC204 DESC205 DFSDSTR1 FPEDESC FPPDESC MSCDESC for: DEL TRANDESC NAME(*) OPTION(ALLRSP) MbrName CC CCText IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 0 IMS1 48 NOT ALLOWED FOR IMS RESOURCE IMS1 27 REJECTED FOR DEFAULT DESCRIPTOR IMS1 0 IMS1 0 OM API input: CMD(DEL TRANDESC NAME(*) OPTION(ALLRSP)) OM API output: <imsout> <ctl> <omname>OM1OM </omname> <omvsn>1.3.0</omvsn> <xmlvsn>20 </xmlvsn> <statime>2006.310 22:43:49.648480</statime> <stotime>2006.310 22:43:49.650611</stotime> <staseq>BFAAC1A7EB860302</staseq> <stoseq>BFAAC1A7EC0B37D2</stoseq> <rqsttkn1>USRT011 10144349</rqsttkn1> <rc>0200000C</rc> <rsn>00003008</rsn> <rsnmsg>CSLN054I</rsnmsg> <rsntxt>None of the clients were successful.</rsntxt> </ctl> <cmderr> <mbr name="IMS1 "> <typ>IMS </typ> <styp>DBDC </styp> <rc>0000000C</rc> <rsn>00003004</rsn> <rsntxt>No requests were successful</rsntxt> </mbr> </cmderr> <cmd> <master>IMS1 </master> 380 Commands, Volume 1: IMS Commands A - M <userid>USRT011 </userid> <verb>DEL </verb> <kwd>TRANDESC </kwd> <input>DEL TRANDESC NAME(*) OPTION(ALLRSP) </input> </cmd> <cmdrsphdr> <hdr slbl="DESC" llbl="DescName" scope="LCL" sort="a" key="1" scroll="no" len="8" dtype="CHAR" align="left" /> <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" 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" skipb="no" /> <hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0" scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="CONVID" llbl="ConvID" scope="LCL" sort="n" key="0" scroll="yes" len="4" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="NODE" llbl="NodeName" scope="LCL" sort="n" key="0" scroll="yes" len="8" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="USER" llbl="UserName" scope="LCL" sort="n" key="0" scroll="yes" len="8" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="LU" llbl="LUName" scope="LCL" sort="n" key="0" scroll="yes"len="24" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="TMEM" llbl="TMember" scope="LCL" sort="n" key="0" scroll="yes" len="16" dtype="CHAR" skipb="yes" align="left" /> <hdr slbl="TPIP" llbl="TPipe" scope="LCL" sort="n" key="0" scroll="yes" len="8" dtype="CHAR" skipb="yes" align="left" /> </cmdrsphdr> <cmdrspdata> <rsp>DESC(DESC102 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC004 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC205 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DFSDSTR1) MBR(IMS1) CC( 48) CCTXT(NOT ALLOWED FOR IMS RESOURCE) </rsp> <rsp>DESC(DESC201 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(FPPDESC ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC103 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC005 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC001 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC202 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC104 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(CONVDESC) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC002 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC203 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(MSCDESC ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC105 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC101 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(FPEDESC ) MBR(IMS1) CC( 27) CCTXT(REJECTED FOR DEFAULT DESCRIPTOR) </rsp> <rsp>DESC(DESC003 ) MBR(IMS1) CC( 0) </rsp> <rsp>DESC(DESC204 ) MBR(IMS1) CC( 0) </rsp> </cmdrspdata> </imsout> Explanation: A DELETE TRANDESC command is issued to delete all transaction descriptors from an active IMS system. Many transaction descriptors are successfully deleted, as indicated by the completion code 0. Because the DELETE command attempted to delete all of the transaction descriptors, OPTION(ALLRSP) is specified to display the successfully deleted transaction descriptors. The delete for transaction descriptor FPEDESC fails, because it is the default transaction descriptor. The delete for transaction descriptor DFSDSTR1 fails, because it is the IMS-defined transaction descriptor. Related concepts: Chapter 23. DELETE commands 381 How to interpret CSL request return and reason codes (System Programming APIs) Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 382 Commands, Volume 1: IMS Commands A - M Chapter 24. /DEQUEUE command The /DEQUEUE command with any of the following keywords is used to cancel a message that is being processed: LINE, LTERM, LUNAME, MSNAME, NODE, TRAN, or USER. Also, a /DEQUEUE command dequeues messages from either the local queues, or in a shared-queues environment, the shared queues. An output message displays the total count of all messages dequeued. Subsections: v “Environment” v “Syntax” v “Keywords” on page 384 v “Usage notes” on page 388 v “Examples” on page 389 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 210. Valid environments for the /DEQUEUE command and keywords Command / Keywords DB/DC DBCTL DCCTL /DEQUEUE X X X AOITKN X X X LINE X X LTERM X X LUNAME X X MSNAME X X NODE X X PTERM X X PURGE X X PURGE1 X X SUSPEND X X TMEM X X TPIPE X X TPNAME X X TRAN X X USER X X Syntax © Copyright IBM Corp. 1974, 2014 383 /DEQUEUE /DEQ AOITKN aoitokenname LINE line# PTERM pterm# A LTERM ltermname PURGE PURGE1 LUNAME luname TPNAME tpname MSNAME NODE msname PURGE PURGE1 PURGE PURGE1 nodename A USER SUSPEND TMEM tmembername TRAN tranname USER username TPIPE username tpipename PURGE PURGE1 PURGE PURGE1 A A: PURGE LTERM ltermname PURGE PURGE1 Keywords The following keywords are valid for the /DEQUEUE command: AOITOKEN Dequeues and discards all messages associated with the specified AOI token name. LINE PTERM Cancels the output message currently being sent to the specified physical terminal on the specified communication line. LTERM Cancels the output message currently being sent to the specified logical terminal. /DEQUEUE NODE nodename LTERM is not valid for nodes with users. The user that contains the LTERM must be allocated and the session must be active. If the PURGE or PURGE1 keyword is specified and the LTERM is associated with a user with DEADQ status, the DEADQ status will be reset. If the DEADQ status is on, the following command turns it off for the user associated with LTERM ltermname: /DEQUEUE LTERM ltermname (PURGE/PURGE1) The DEADQ status is removed by signing the user on or by issuing the /DEQUEUE command to dequeue one or more messages. LUNAME TPNAME Specifies the LU name and TP name of the LU 6.2 destination from which messages are discarded. A normal (non-qualified) or fully network qualified LUNAME is required for the LUNAME keyword. 384 Commands, Volume 1: IMS Commands A - M Note: A fully qualified LU name must be specified in single quotation marks. Either the PURGE or PURGE1 option must be specified, and the LU 6.2 destination must be stopped and not active; if both actions are not taken, error messages are issued. In a shared-queues environment, only messages that are owned by the command processing IMS are dequeued. Inflight synchronous output messages are not dequeued. Any stranded synchronous output messages with affinity to the command processing IMS are dequeued. If you used a side information entry name to place messages on the queues, to dequeue those messages, specify the side information entry name for the LU name and the character string DFSSIDE for the TP name. MSNAME Cancels the output message currently being sent to the specified MSC link. Either PURGE or PURGE1 is required for this link. The MSC link must be stopped by the /PSTOP LINK command before issuing the /DEQUEUE MSNAME command. NODE Cancels the output message currently being sent to the specified VTAM node. The following command is not valid for nodes with users: /DEQUEUE NODE nodename /DEQUEUE NODE nodename LTERM ltermname The following command cancels the output message currently being sent to the specified ISC session, and the user must be allocated to the node and the session must be active: /DEQUEUE NODE nodename USER username Restrictions for using NODE and USER parameters together: v Commands with the NODE USER keyword pair are valid only if: – The USER is signed on to the NODE – In an ISC environment, the USER is allocated to the NODE – The nodes and users already exist v /DEQUEUE NODE USER LTERM commands are valid for ISC and non-ISC nodes and users. v /DEQUEUE NODE USER PURGE commands and /DEQUEUE NODE USER LTERM PURGE1 commands are valid for ISC, LUP, and 3600 nodes only. If PURGE or PURGE1 is specified, the node must be stopped and idle. Without PURGE and PURGE1, if an ETO node or an ISC static parallel session, the USER keyword is required. If the PURGE keyword is specified, and the NODE is associated with a user with DEADQ status, the DEADQ status will be reset. PURGE Cancels all output messages enqueued to the specified LINE, LTERM, LUNAME, MSNAME, NODE, TMEM, TPIPE, or USER. The PURGE keyword allows cancellation of all output messages enqueued to an LTERM, or to a PTERM without regard to the LTERM. A /DEQUEUE command without PURGE cancels an in-progress output message on the specified terminal and, Chapter 24. /DEQUEUE command 385 optionally, LTERM. If the NODE and LTERM keywords have both been supplied, the LTERM must be a valid LTERM of the user currently associated with the node. Messages cannot be canceled with PURGE if they are destined for the MTO or for terminals or users in response mode or conversation mode. The /DEQUEUE PURGE command does not cancel messages destined for the master terminal operator because the master terminal cannot be stopped, disconnected, or idled. The /EXIT command should be used for a terminal in conversation mode. If the terminal is a dynamic 3600/FINANCE, SLU P, or ISC terminal, the NODE keyword is valid only if the session is stopped and idle, and the LTERMs are still allocated to the terminal pending message resynchronization. For example, the following command is valid for the allocated user only if the specified ISC session is stopped and idled. /DEQUEUE NODE nodename USER username (LTERM ltermname) PURGE Messages queued to LTERMs associated with users that are not signed on can be purged by specifying the LTERM keyword without the NODE keyword. NODE with the USER keyword applies to ISC sessions and dynamic terminals and is valid only if the user is still allocated to the node. However, the line or node must be stopped and idled. If USER is specified and the user had DEADQ status, the DEADQ status is removed. If LTERM or NODE is specified and the LTERM or node is associated with a user with DEADQ status, the DEADQ status is removed. PURGE1 Cancels the first message queued to the specified LTERM. The PURGE1 and PURGE keywords are mutually exclusive. The /DEQUEUE LTERM PURGE1 command removes the first message from the queue. The order of search for messages to be removed is: 1. Fast Path 2. Response mode 3. Exclusive mode messages 4. System messages 5. All other messages Using a synonym for PURGE1 avoids the potential danger of omitting the trailing digit on PURGE1 and canceling all the messages enqueued. Synonyms for PURGE1 are SINGLE, SNGL, and FIRST. When PURGE1 is specified, the terminal must be stopped and idle and not in conversation mode. If the message is in the process of being actively sent, The /DEQUEUE command without PURGE1 cancels the message. SUSPEND Reschedules transactions that have been suspended by IMS. SUSPEND applies to IMS systems sharing data at the block level and to connected external subsystems (not CCTL subsystems). The /DEQUEUE SUSPEND command causes all message-driven transactions that have been suspended to be rescheduled. When a failed IMS system is restarted, the /DEQUEUE SUSPEND command informs the currently running IMS system to reschedule any message-driven transactions on its SUSPEND queue. However, when the failed subsystem has global locks retained and cannot communicate the release of 386 Commands, Volume 1: IMS Commands A - M those locks to the other subsystems, the /DEQUEUE SUSPEND command is used to reschedule these message-driven transactions in the other subsystems. This can occur when: v The still-running IMS has transactions on its SUSPEND queue and the failed IMS has been restarted using the /ERESTART COLDSYS command. v The still-running IMS terminates before the failed IMS is restarted. Thus, when the failed system is restarted, the other system, which has now terminated, is unable to receive the message to reschedule the transactions on its SUSPEND queue. The operator must issue the /DEQUEUE SUSPEND command to reschedule them. Another use for the /DEQUEUE SUSPEND command is to release those transactions queued because the installation specified the requeue region error option in the external subsystem PROCLIB member for a particular subsystem. Transactions will be queued if the subsystem connection terminates in an abnormal fashion (for example, dependent region abend, subsystem abnormal termination). In a shared-queues environment, a /DEQUEUE SUSPEND command moves all transactions on the Transaction Suspend queue to the Transaction Ready queue and makes them eligible for rescheduling. The “suspend” status for the transactions is also reset locally (on the IMS subsystem that entered the command), but is not reset across the sysplex. To reset the “suspend” status across a sysplex, use the /START TRAN command on each IMS subsystem. You can also use the /START TRAN command to reschedule a specific transaction that has been suspended. The /DISPLAY TRAN and /DISPLAY STATUS commands can be used to determine whether a transaction has messages on its suspend queue. TMEM TPIPE Dequeues messages from the specified IMS Open Transaction Manager Access (OTMA) member and transaction pipe. Using the /DEQ command can make OTMA message resynchronization impossible. If resynchronization is in progress for the specified transaction pipe, IMS rejects the command and issues message DFS2392I. In a shared-queues environment, only messages that are owned by the command processing IMS are dequeued. Inflight synchronous output messages are not dequeued. Any stranded synchronous output messages with affinity to the command processing IMS are dequeued. TRAN Dequeues one or more messages from the transaction specified. The transaction name is a 1- to 8-byte name. The transaction must be stopped for messages to be dequeued. Restriction: This keyword is valid only in a shared-queues environment. Recommendation: Stop the transaction on all IMS subsystems in the shared queues group before issuing the /DEQUEUE TRAN command. If you do not, the IMS subsystem that processes the /DEQUEUE could dequeue a message it does not own and that another IMS subsystem might need. A /DEQUEUE TRAN command does not dequeue messages enqueued for suspended transactions. In a shared-queues environment, a /DEQUEUE TRAN command can dequeue transaction messages queued to the transaction from APPC or OTMA Clients. Chapter 24. /DEQUEUE command 387 The command only dequeues the transaction messages. The APPC or OTMA transaction instance blocks (TIB) created at the IMS system are not deleted and the storage may remain allocated until the next IMS restart. For APPC, the TIB is not released and the APPC conversation (the client) hangs if there is no timeout value specified. The APPCIOT=(x,Y) timeout value for APPC would deallocate the APPC conversation and release the TIB after the timeout limit has been reached. USER (LTERM) Dequeues all messages associated with all LTERMs (or a specific) LTERM assigned to that USER. The user must be stopped and not in conversation in order to enter /DEQUEUE USER with PURGE and PURGE1. The /DEQUEUE USER command with PURGE1 or the /DEQUEUE USER LTERM command without PURGE or PURGE1 requires the LTERM keyword. If a user is signed on, the /DEQUEUE USER LTERM command can be used to cancel an output message that is currently being processed. When the purge options are used, messages destined for the MTO and users in response mode, Fast Path, and conversation cannot be canceled. If the USER and LTERM keywords have both been supplied, the LTERM must be a valid LTERM of the specified USER. If the user has DEADQ status, the DEADQ status is removed. Usage notes The DEQUEUE command dequeues messages from an OTMA transaction pipe. CM0 output messages can be placed on the OTMA tpipe using multiple output queue names. A different queue name is used to queue I/O PCB output messages than is used to queue hold queue messages. In the non-super member environment, a CM0 output message could be on the I/O PCB output queue or the member's tpipe hold queue. In the super member environment, a CM0 output message could be on I/O PCB output queue or the super member hold queue. If the member specified is a regular member, CM0 output messages are dequeued from the member's tpipe hold queue and the member's I/O PCB output queue. If the member specified is a super member, CM0 output messages are dequeued from the super member's output hold queue. The number of messages dequeued depends on whether PURGE or PURGE1 is specified. In the non-shared-queues environment, if the member specified is a regular member, messages are dequeued from the regular member's hold queue first, then from the regular member's I/O PCB output queue. In the shared-queues environment the order in which messages for the same destination are dequeued is not guaranteed. Hold queue messages may be dequeued before I/O PCB output messages one time and I/O PCB output messages may be dequeued before hold queue messages the next. If IMS cold starts and messages are queued to the same tpipe destination following the cold start, a new set of queue names is used to queue I/O PCB output messages and hold queue messages. In the shared-queues environment with super member enabled, all messages queued to a super member, are placed on the shared queues using the same queue name, even after a cold start of IMS. Messages on the super member's output queue do not have affinity to any IMS. They can be dequeued from any IMS in the IMSplex. This command can be issued to an IMSplex using the Batch SPOC utility. 388 Commands, Volume 1: IMS Commands A - M A /DEQUEUE command with any of the following keywords activates the Message Control Error exit routine, DFSCMUX0, before processing each message: LTERM, LUNAME TPNAME, NODE, or MSNAME. The user exit routine can request IMS to: v Proceed with the command and purge the message. This is the default action for the Message Control Error exit routine. v Suppress the command. v Suppress the command and send an informational message to the entering terminal. v Route the message to a different destination. The /DEQUEUE NODE command dequeues messages from the local or shared queues for statically defined terminals. Without PURGE or PURGE1, the message actively being sent is dequeued. The /DEQUEUE LTERM command dequeues messages from the local or shared queues. The user must be stopped (by a /STOP USER command), and not in conversation, in order to enter /DEQUEUE USER or /DEQUEUE LTERM with PURGE or PURGE1. In a shared queues and ETO environment where the user does not exist, /DEQUEUE LTERM with PURGE or PURGE1 creates a user structure in order to dequeue messages from the shared queues. Examples The following are examples of the /DEQUEUE command: Example 1 for /DEQUEUE command Entry ET: /DEQUEUE AOITOKEN ABCDE Response ET: DFS058I DEQUEUE COMMAND COMPLETED Explanation: The messages on AOITOKEN ABCDE are dequeued and discarded. Example 2 for /DEQUEUE command Entry ET: /DEQUEUE LINE 5 PTERM 2 Response ET: DFS058I DEQUEUE COMMAND COMPLETED Explanation: The message is terminated on successful completion of the current transmission. Example 3 for /DEQUEUE command Entry ET: /DEQUEUE LTERM ABCDE PURGE Response ET: DFS976I 2 MESSAGE(S) PURGED Chapter 24. /DEQUEUE command 389 Explanation: Two messages are dequeued for LTERM ABCDE (the line is stopped and idle as required). Example 4 for /DEQUEUE command Entry ET: /DEQUEUE LTERM ABCDE PURGE1 Response ET: DFS058I DEQUEUE COMMAND COMPLETED Explanation: The message is dequeued for LTERM ABCDE. Example 5 for /DEQUEUE command Entry ET: /DEQ LUNAME ’NETWORK1.LUNAME1’ TPNAME TPNAME1 PURGE Response ET: DFS1952 10:51:35 DESTINATION NOT FOUND Explanation: An invalid APPC destination was entered. Example 6 for /DEQUEUE command Entry ET: /DEQ LUNAME ’CICSNET.SERVER1’ TPNAME DFSASYNC PURGE1 Response ET: DFS976I 14:10:25 1 MESSAGE(S) PURGED Explanation: The message was dequeued from the APPC destination LUNAME CICSNET.SERVER, TPNAME DFSASYNC. Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 390 Commands, Volume 1: IMS Commands A - M Chapter 25. /DIAGNOSE commands Use the /DIAGNOSE SNAP command to retrieve diagnostic information for system resources such as IMS control blocks, user-defined nodes, or user-defined transactions at any time without creating a console dump. Use the /DIAGNOSE SET command to enable or disable diagnostic features such as the logging facility that captures events related to APPC and OTMA synchronous transactions in a shared-queues environment. The SET and SNAP keywords are mutually exclusive. Related concepts: /DIAGNOSE command SNAP function (Diagnosis) /DIAGNOSE SET command Use the /DIAGNOSE SET command to enable or disable diagnostic features such as the logging facility that captures events related to APPC and OTMA synchronous transactions in a shared-queues environment. Subsections: v “Environment” v “Syntax” v “Keywords” v “Examples” on page 392 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) from which the command can be issued. Table 211. Valid environments for the /DIAGNOSE SET command and keywords Command / Keywords DB/DC DBCTL DCCTL /DIAGNOSE SET X X X AOSLOG X SYSOUT X X X X Syntax | /DIAGNOSE /DIAG SET AOSLOG( ON OFF ) SYSOUT( ON OFF ) | | Keywords | | | | | You can use the /DIAGNOSE SET command to change the values of various IMS diagnostic options. The option to change is identified by the command keyword, and the desired state of the option is specified by the keyword value. For detailed information about option processing, see the specific keyword documentation. The SET keyword is mutually exclusive with the SNAP keyword. © Copyright IBM Corp. 1974, 2014 391 The following keywords are valid for the /DIAGNOSE SET command: AOSLOG Specifies whether events related to APPC and OTMA synchronous transactions in a shared-queues environment are logged. Logged events are written to the OLDS as type X'6701' records. If AOSLOG(ON) is specified in a non-shared-queues environment or when AOS=N is specified in the DFSDCxxx PROCLIB member, the command is rejected with a DFS2859I message. ON Enables AOS logging. OFF Disables AOS logging. | | | | | | | SYSOUT Enables or disables SYSOUT processing by the Diagnostic Services AWE server. If enabled, SYSOUT requests that are queued to the Diagnostic Services AWE server by the /DIAGNOSE command SYSOUT option are processed, and /DIAGNOSE SNAP command output is written to a SYSOUT data set. If disabled, SYSOUT requests that are queued to the Diagnostic Services AWE server are rejected. | ON Enables SYSOUT processing by the Diagnostic Services AWE server. | | OFF Disables SYSOUT processing by the Diagnostic Services AWE server. Examples The following example shows the /DIAGNOSE SET command. Entry ET: /DIAGNOSE SET AOSLOG(ON) Response ET: DFS058I DIAGNOSE COMMAND COMPLETED Explanation: The logging of events related to APPC and OTMA synchronous transactions in the shared-queues environment is enabled. The X'6701' records are captured and written to the IMS log. Related information: DFS2859I (Messages and Codes) /DIAGNOSE SNAP command Use the /DIAGNOSE SNAP command to capture storage information, and then format and display that information on the issuing LTERM. Optionally, the information can be written to the OLDS, trace data sets as type X'6701' records, or a SYSOUT data set. Storage information can be captured for IMS control blocks, user-defined nodes, transactions, programs, and database resources. | | | | | Subsections: v “Environment” on page 393 v “Syntax” on page 393 v “Keywords” on page 395 392 Commands, Volume 1: IMS Commands A - M v “Usage notes” on page 426 v “Examples” on page 427 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) from which the command can be issued. Table 212. Valid environments for the /DIAGNOSE SNAP command and keywords Command / Keywords | | DB/DC DBCTL DCCTL /DIAGNOSE SNAP X X X ADDRESS X X X AREA X X BLOCK X X DB X X JOBNAME X X LINE X X LINK X X LTERM X X MODULE X MSNAME X X NODE X X OPTION X X X PGM X X X REGION X X X RM X SHOW X STRUCTURE X X TRAN X X USER X X | Syntax | /DIAGNOSE /DIAG SNAP X X X X X X X A | | A: | | Chapter 25. /DIAGNOSE commands 393 | | LENGTH(8) KEY(7) LENGTH(length) KEY(0) ADDRESS(address) , AREA( areaname ) BLOCK( B ) , DB( dbname , ) LINE( line# , ) LINK( link# , ) LTERM( ltermname ) C MODULE(modname) , MSNAME( msname , ) NODE( nodename ) C , PGM( pgmname REGION REG ) , ( region# ) , JOBNAME JOB ( jobname ) , , REGION ( region# REG STRUCTURE(ALL) ) JOBNAME JOB ( jobname ) STRUCTURE(structure_name) TRAN(tranname) , USER( username ) C | | LIMIT(1999) DISPLAY D LIMIT(linecount) OPTION OPT ( OLDS ) CLASS(task_default) LIMIT(19999) CLASS(sysout_class) LIMIT(linecount) SYSOUT D TRACE | | SHOW(PRI) , SHOW( PRI keyword blockname | B: | | 394 Commands, Volume 1: IMS Commands A - M ) | ALL CATA CMDE CSCD CSLA CSVT CTLASCB CTLASSB CTLJTCB CTLTCB DCCB DFA DGA DGSD DGSW EDBT ESCD FRB GDBT IRCVECT LCD LCDM LSCD MSCD MWA PXPARMS QSCD RECA RSR RWCD SCD SDTT SKCB SQM TIME TRA TSCD UXDT | | C: | RM(YES) RM( NO ONLY ) | | | D: FORMAT(LONG) FORMAT( LOC LOCATION ) | | Keywords The following keywords are valid for the /DIAGNOSE SNAP command: Chapter 25. /DIAGNOSE commands 395 ADDRESS Captures information about a specific area of storage. The address value identifies the area and must specify a hexadecimal value between 0 and 7FFFFFFF. LENGTH Specifies the length of the area of storage to capture. The LENGTH parameter is optional and has a default value of 8. If the LENGTH parameter is specified, the length value must be a numeric value from 1 to 65536. KEY Specifies the key of the storage to capture. If the KEY parameter is included, the PSW key is changed to the value specified before accessing the storage. The KEY parameter is optional. Valid values for the KEY parameter are 0 and 7. AREA Captures control block information for the Fast Path area specified in the areaname parameter. The areaname must be alphanumeric, no longer than 8 characters, and identify a currently defined Fast Path area. Multiple areaname parameters can be specified with each parameter separated by a comma or a blank. The control blocks that can be captured for a Fast Path area are listed in the following table. Primary control blocks for an area, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for an area, which might be present and available for capture based on workload and other factors, are identified by the column labeled “Optional”. The /DIAGNOSE SNAP AREA() command is available in a DB/DC or DBCTL environment where Fast Path is defined. The DEDB extended area control block (EMAC) is available only in an RSR tracker environment. If the SHOW(ALL) or SHOW(OPT) options are specified in a non-RST tracker environment, the EMAC is ignored. If the SHOW(EMAC) option is specified in a non-tracker environment, a DFS110I error message is issued in response. Table 213. /DIAGNOSE SNAP AREA() control blocks 396 Name Block description Macro ALDS DEDB Area Name List Entry DBFAREA X DMAC DEDB Area Control Block DBFDMAC X ADSC DEDB Area Data Set Control Block DBFADSC X DMHR DEDB Buffer Header (SDEP) DBFDMHR X EMAC DEDB Extended Area Control Block DBFEMAC X DDIR Database Directory Block DFSDDIR X DMCB DEDB Master Control Block DBFDMCB X MRMB DEDB Randomizing Module Block DBFDMRMB X Commands, Volume 1: IMS Commands A - M Primary Optional Table 213. /DIAGNOSE SNAP AREA() control blocks (continued) Name Block description Macro Primary Optional DMSL Data Space Map List DBFDMSL X DSME Data Space Mapping Entry DBFDSME X DMAX DMAC ERE Extension Block DBFDMHV X SHOW keyword parameters for the /DIAGNOSE SNAP AREA command SHOW Used as a filtering mechanism to control which blocks are returned. Using the SHOW() option, a single block, list of blocks, or group of blocks identified by the keyword can be returned. The following example code shows this command option: /DIAG SNAP AREA(DEDB01D1) SHOW(OPT). If the SHOW() option is omitted from the /DIAGNOSE SNAP AREA() command, only the primary control blocks for the area are captured by default. The SNAP AREA() resource type supports the ALL, PRI, and OPT keywords, and all block names listed in Table 213 on page 396 as parameters to the SHOW() option. Multiple SHOW() option parameters can be specified with each parameter separated by a comma or a blank. A maximum of 16 SHOW() option parameters can be specified. ALL Captures all control blocks listed in Table 213 on page 396 that are available. Example: /DIAG SNAP AREA(DEDB01D1) SHOW(ALL). PRI Captures the primary control blocks for the area. Primary control blocks are identified by the Primary column in Table 213 on page 396. Example: /DIAG SNAP AREA(DEDB01D1) SHOW(PRI). OPT Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 213 on page 396. Example: /DIAG SNAP AREA(DEDB01D1) SHOW(OPT). blockname Captures the specified block by block name. Block names are defined in the Name column in Table 213 on page 396. Example: /DIAG SNAP AREA(DEDB01D1) SHOW(ALDS). blockname,blockname Captures multiple blocks by block name. Example: /DIAG SNAP AREA(DEDB01D1) SHOW(ALDS,DMAC). keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP AREA(DEDB01D1) SHOW(PRI,PDIR). BLOCK Captures information for a specific IMS control block. A control block name or ALL is required. | | Multiple control block name parameters can be specified with each parameter separated by a comma or a blank. Valid control block names include: Chapter 25. /DIAGNOSE commands 397 ALL Captures information for all valid control blocks currently available. | | | CATA Captures information for the Catalog Anchor control block. CATA is available only in a DB/DC or DBCTL environment. CMDE Captures information for the Commands SCD Extension control block. | | | CSCD Captures storage information for the APPC/OTMA SMQ SCD Extension control block. CSCD is available only in a DB/DC or DCCTL environment. | | | CSLA Captures information for the Common Service Layer Anchor control block. | | | CSVT Captures information for the Common Callable Services Vector Table control block. | | | CTLASCB Captures information for the IMS control region Address Space Control control block. | | | CTLASSB Captures information for the IMS control region Address Space Secondary control block. | | | CTLJTCB Captures information for the IMS control region Job Step Task Control Block. | | | CTLTCB Captures information for the IMS control region Primary Task Control Block. | | | DCCB Captures information for the Data Communications control block. DCCB is available only in a DB/DC or DCCTL environment. | | DFA | | DGA | | | DGSD Captures information for the Diagnostic Data Set Structures control block. | | | DGSW Captures information for the Diagnose Work Area Storage control block. | | | EDBT Captures information for the RSR FP Global DB Tracking control block. EDBT is available only in an IMS system where Fast Path is defined. Captures information for the Definition Anchor control block. Captures information for the Diagnostics Anchor control block. 398 Commands, Volume 1: IMS Commands A - M | | | ESCD Captures information for the Extended System Contents Directory control block. ESCD is available only in an IMS system where Fast Path is defined. | | | FRB | | | GDBT Captures information for the System RSR Global DB Tracking control block. GDBT is available only in an DB/DC or DBCTL environment. | | IRCVECT Captures information for the Log SVC Vector Table control block. | | | LCD | | | LCDM Captures information for the Log Control Directory (Monitor) control block. | | LSCD Captures information for the APPC SCD Extension control block. LSCD is available only in a DB/DC or DCCTL environment. | | | MSCD Captures information for the MSC SCD Extension control block. MSCD is available only in a DB/DC or DCCTL environment. Captures information for the Fast Restart control block. FRB is available only in a DB/DC or DBCTL environment. Captures information for the Log Control Directory (Journal) control block. MWA Captures information for the Modify Work Area control block. | | PXPARMS Captures information for the Modify Parameter Anchor control block. | | QSCD Captures information for the Queue Manager SCD Extension control block. QSCD is available only in a DB/DC or DCCTL environment. | | | RECA Captures information for the VTAM Receive Any I/O Buffers control blocks. RECA is available only in a DB/DC or DCCTL environment. | | | Because of the volume of data that can be produced by capturing the VTAM Receive Any I/O Buffers, the RECA option is not included in the BLOCK(ALL) option. | | | RSR | | | RWCD Captures information for the Database Recovery 2 Anchor control block. RWCD is available only in a DB/DC or DBCTL environment. Captures information for the Remote Site Recovery Anchor control block. RSR is available only in a DB/DC or DBCTL environment. SCD Captures information for the System Contents Directory control block. | | SDTT Captures information for the Shutdown Trace Table control block. Chapter 25. /DIAGNOSE commands 399 | | SKCB Captures information for the Stack Control Block. SQM Captures information for the Shared Queues Master control block. SQM is available only in a shared-queues environment. | | | | | TIME Captures information for the Timer Services SCD Extension control block. | | TRA Captures information for the Table Trace control block. | | TSCD Captures information for the OTMA SCD Extension control block. TSCD is available only in a DB/DC or DCCTL environment. | | UXDT Captures information for the User Exit Definition Table control block. | The following table shows BLOCK() resources listed by the area. | Table 214. /DIAGNOSE SNAP BLOCK() - System control blocks | Name Block description Macro | CMDE Commands SCD Extension DFSCMDE | | CSLA Common Service Layer Anchor Block DFSCSLA | CSVT Callable Services Vector Table DFSCSVT | | CTLASCB CTL Address Space Control Block IHAASCB | | CTLASSB CTL Address Space Secondary Block IHAASSB | | CTLJTCB CTL Job Step Task Control Block IKJTCB | | CTLTCB CTL Primary Task Control Block IKJTCB | DFA Definition Anchor Block DFSDFA | DGA Diagnostics Anchor Block DFSDGA | | DGSD Diagnostic Data Set Structures DFSDGSWA | DGSW Diagnose Work Area Storage DFSDGSWA | IRCVECT SVC Vector Table IRCVECT | | LCD Log Control Directory (Journal) LCDSECT | | LCDM Log Control Directory (Monitor) LCDSECT | MWA Modify Work Area DFSMWA | PXPARMS Parameter Anchor Block PARMBLK | SCD System Contents Directory ISCD | SDTT Shutdown Trace Table DFSSDTT | SKCB Stack Control Block DFSSKCB 400 Commands, Volume 1: IMS Commands A - M | Table 214. /DIAGNOSE SNAP BLOCK() - System control blocks (continued) | Name Block description Macro | | TIME Timer Services SCD Extension DFSTIME | TRA Table Trace Control Block DFSTRABK | | UXDT User Exit Definition Table DFSUSRXD | Table 215. /DIAGNOSE SNAP BLOCK() - DB control blocks | Name Block description Macro | CATA Catalog Anchor Block DFS3ACH | | EDBT RSR FP Global DB Tracking Block DBFEDBT | | ESCD Extended System Contents Directory DBFESCD | FRB Fast Restart Block DFSFRB | | GDBT RSR Global DB Tracking Block DFSGDBT | | RSR Remote Site Recovery Anchor DFSRSCD Block | | | RWCD Database Recovery 2 Anchor Block | Table 216. /DIAGNOSE SNAP BLOCK() - TM control blocks | Name Block description Macro | | CSCD APPC/OTMA SMQ SCD Extension DFSCSCD | | DCCB Data Communications Control Block DFSDCCB | LSCD APPC SCD Extension DFSLSCD | MSCD MSC SCD Extension DFSMSCD | | QSCD Queue Manager SCD Extension DFSQSCD | | RECA VTAM Receive Any I/O Buffers BUFVTPRE | | SQM Shared Queues Master Control Block DFSSQM | | TSCD OTMA SCD Extension DFSTSCD | DB | | | | DFSRWCD Captures control block information for the database specified in the dbname parameter. The dbname parameter specified must be alphanumeric, no longer than 8 characters, and identify a currently defined database. Multiple dbname parameters can be specified with each parameter separated by a comma or a blank. The control blocks that can be captured for a database are listed in the following table. Primary control blocks for a database, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a database, which might or might Chapter 25. /DIAGNOSE commands 401 not be present and available for capture depending on workload, database type and other factors, are identified by the column labeled “Optional”. | | | Table 217. /DIAGNOSE SNAP DB() control blocks | Name Block description Macro | DDIR Database Directory Block DFSDDIR | DDIREXT Database Directory Block Extension DFSDDIR X | RSCX Resource Extension Block DFSRSCX X | DYNALMBR Dynamic Allocate Member DFSMDA X | DBQLE Database Quiesce List Entry DFSDBQQL X | EEQE Error Queue Element DFSEEQE X | RRE Residual Recovery Element DFSRRE X | TDBC Tracking Data Base Control Block DFSTDBC X | SDTE Segment Delta Block Table Entry DFS5FLDD X | DMB Data Management Block DFSDMB X | PSDB Physical Segment Descriptor Block DFSDMB X | SDB Segment Descriptor Block DFSSDBM X | FDB Field Descriptor Block DFSFDB X | DMBCPAC Segment Edit/Compression Block DFSDMB X | DMBSEC DMB Secondary List DFSDMB X | DMBDACS Randomizer Control Block DFSDMB X | DMBAMPPR Access Method Prefix Block Prefix DFSDMB X | DMBAMP Access Method Prefix Block DFSDMB X | DCBACBP Primary DCB/ACB Block DCBD X | DCBACBS Overflow DCB/ACB Block DCBD X | DMBXBLCK Data Management Exit Block DFSDMB X | DMBXARRY Exit Array Entry Block DFSDMB X | DMBXT Exit Description Block DFSDMB X | DMCB DEDB Master Control Block DBFDMCB X | BHDR | Main Storage Database Header DBFBMSDB X Primary Optional X SHOW keyword parameters for the /DIAGNOSE SNAP DB command SHOW Specifies which blocks are returned. Using the SHOW() option, a single block, list of blocks, or group of blocks identified by the keyword can be returned. Example: /DIAG SNAP DB(IVPDB1) SHOW(DDIR) If the SHOW keyword is omitted from the /DIAGNOSE SNAP DB command, only the primary control blocks for the database are captured by default. | | | The SNAP DB() resource type supports the ALL, OPT, and PRI keywords, and all block names listed in Table 217 as parameters for the SHOW keyword. Multiple SHOW parameters can be specified with each parameter separated by a comma or a blank. A maximum of 16 SHOW parameters can be specified. 402 Commands, Volume 1: IMS Commands A - M The effects of the SHOW option on the data captured by the /DIAGNOSE SNAP DB command are described in the following list: ALL Captures all control blocks listed in Table 217 on page 402 that are available. Example: /DIAG SNAP DB(IVPDB1) SHOW(ALL). OPT Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 217 on page 402. Example: /DIAG SNAP DB(IVPDB1) SHOW(OPT). PRI Captures the primary control blocks for the database. Primary control blocks are identified by the Primary column in Table 217 on page 402. Example: /DIAG SNAP DB(IVPDB1) SHOW(PRI). blockname Captures the specified block by block name. Block names are defined in the Name column in Table 217 on page 402. Example: /DIAG SNAP DB(IVPDB1) SHOW(DDIR). blockname,blockname Captures multiple blocks by block name. Example: /DIAG SNAP DB(IVPDB1) SHOW(DDIR,DMCB). | | keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP DB(IVPDB1) SHOW(PRI,DDIR). Usage notes for the /DIAGNOSE SNAP DB command The /DIAGNOSE SNAP DB command is available only in a DB/DC or DBCTL environment. LINE Captures control block information for the communication line specified in the line# parameter. The line# parameter specified must be numeric, in the range 1 - 1000, and identify a currently defined communication line. Multiple line# parameters can be specified with each parameter separated by a comma or a blank. The control blocks that can be captured for a communication line are listed in the following table. Primary control blocks for a communication line, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a communication line, which might be present and available for capture depending on workload and other factors, are identified by the column labeled “Optional”. | Table 218. /DIAGNOSE SNAP LINE() control blocks | Name Block description Macro | EPF Event Control Block Prefix IEPF | CULE Common Use List Element Block DFSCULE X | DSPWRK1 Dispatcher Work Area IDSPWRK X | SAP Save Area Prefix ISAP X | SAVEAREA Save Area Set REQUATE X | PROLOG Module Prolog Information N/A X | CLB Communication Line Block ICLI Primary Optional X X Chapter 25. /DIAGNOSE commands 403 | Table 218. /DIAGNOSE SNAP LINE() control blocks (continued) | Name Block description Macro | CTB Communication Terminal Block ICLI X | CTT Communication Translate Table ICLI X | CRB Communications Restart Block ICLI X | SPQB Subpool Queue Block ICLI X | SPQBEXT Subpool Queue Extension Block ICLI X | EMHB Expedited Message Handler Block DBFEMHB X | SMB Scheduler Message Block IAPS X | TIB | | YTIB APPC Transaction Instance Block OTMA Transaction Instance Block DFSTIB DFSYTIB X | CNT Communication Name Table ICLI X | ECNT Extended Communication Name Table DBFECNT X | CRTCN Command CART & 4-Byte Console ID DFSMCSC X | CCB Conversational Control Block ICLI X | CIB Communication Interface Block ICLI X | MSGBP Basic 01/03 Message Prefix QLOGMSGP X | UOWE Unit of Work Table Entry DFSUOWE X | INBUF Input Line Buffer N/A X | OUTBUF Output Line Buffer N/A X | RAQE VTAM Receive Any IO Buffer (In) BUFVTPRE X | RAQERES | VTAM Receive Any IO Buffer (Out) BUFVTPRE X Primary Optional SHOW keyword parameters for the /DIAGNOSE SNAP LINE command SHOW Used as a filtering mechanism to control which blocks are returned. Using the SHOW() option, a single block, list of blocks, or group of blocks identified by the keyword can be returned. Example: /DIAG SNAP LINE(1) If the SHOW() option is omitted from the /DIAGNOSE SNAP LINE() command, only the primary control blocks for the communication line are captured by default. The SNAP LINE() resource type supports the ALL, PRI, and OPT keywords, and all block names listed in Table 218 on page 403 as parameters to the SHOW() option. Multiple SHOW() option parameters can be specified with each parameter separated by a comma or a blank. A maximum of 16 SHOW() option parameters can be specified. ALL Captures all control blocks listed in Table 218 on page 403 that are available. Example: /DIAG SNAP LINE(1) SHOW(ALL) PRI Captures the primary control blocks for the communication line. Primary control blocks are identified by the Primary column in Table 218 on page 403. Example: /DIAG SNAP LINE(9) SHOW(PRI) OPT Captures all optional control blocks that are available. Optional 404 Commands, Volume 1: IMS Commands A - M control blocks are identified by the Optional column in Table 218 on page 403. Example: /DIAG SNAP LINE(9) SHOW(OPT) blockname Captures the specified block by block name. Block names are defined in the Name column in Table 218 on page 403. Example: /DIAG SNAP LINE(1) SHOW(CLB) blockname,blockname Captures multiple blocks by block name. Example: /DIAG SNAP LINE(1) SHOW(CLB,CTT) keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP LINE(1) SHOW(PRI,PDIR) Usage notes for the /DIAGNOSE SNAP LINE command The /DIAGNOSE SNAP LINE command is available in a DB/DC or DCCTL environment. | | | | | | The SHOW(PROLOG) option displays information about the modules that are associated with the save areas in the chain. The module entry point is obtained from the saved register 15 value of the previous save area. If SHOW(SAVEAREA) is combined with SHOW(PROLOG), the display consists of a save area followed by the related prolog of the module that uses the save area. | | | | | | The following control blocks are available only in an IMS system where Fast Path is defined. v ECNT (Extended Communication Name Table) EMHB (Expedited Message Handler Block) SMB (Scheduler Message Block) TIB (APPC Transaction Instance Block) YTIB (OTMA Transaction Instance Block) | v v v v | | | | | If the SHOW(ALL) or SHOW(OPT) option is specified in a non-Fast Path environment, these blocks are ignored. If the SHOW(ECNT), SHOW(EMHB), SHOW(SMB), SHOW(TIB), or SHOW(YTIB) option is specified in a non-Fast Path environment, a DFS154I message is issued in response. | | | | | UOWE (Unit of Work Table Entry) block is available only in an IMS system where shared queues are defined. If the SHOW(ALL) or SHOW(APP) option is specified in a non-shared-queues environment, UOWE is ignored. If the SHOW(UOWE) option is specified in a non-shared-queues environment, a DFS154I message is issued in response. | | | | | TIB (APPC Transaction Instance Block) and YTIB (OTMA Transaction Instance Block) are mutually exclusive; only one is present at any given time. For SHOW() purposes, TIB and YTIB are treated as synonyms. Specifying either TIB or YTIB displays, if available, whichever of the two blocks is present. | | | The SHOW(RECANY) option displays information about both RAQE (VTAM Receive Any IO Buffer (In)) and RAQERES (VTAM Receive Any IO Buffer (Out)) control blocks. | The SHOW(SA) option is a synonym for the SHOW(SAVEAREA) option. LINK Captures control block information for the logical link specified in the link# Chapter 25. /DIAGNOSE commands 405 parameter. The link# parameter specified must be numeric, in the range 1 936, and identify a currently defined logical link. Multiple link# parameters can be specified with each parameter separated by a comma or a blank. The control blocks that can be captured for a logical link are listed in the following table. Primary control blocks for a logical link, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a logical link, which might be present and available for capture depending on workload and other factors, are identified by the column labeled “Optional”. | Table 219. /DIAGNOSE SNAP LINK() control blocks | Name Block description Macro | EPF Event Control Block Prefix IEPF | CULE Common Use List Element Block DFSCULE X | DSPWRK1 Dispatcher Work Area IDSPWRK X | SAP Save Area Prefix ISAP X | SAVEAREA Save Area Set REQUATE X | PROLOG Module Prolog Information N/A X | LLB Link Line Block ICLI | LTB Link Terminal Block ICLI X | CTT Communication Translate Table ICLI X | CRB Communications Restart Block ICLI X | SPQB Subpool Queue Block ICLI X | SPQBEXT Subpool Queue Extension Block ICLI X | EMHB Expedited Message Handler Block DBFEMHB X | SMB Scheduler Message Block IAPS X | TIB | | YTIB APPC Transaction Instance Block OTMA Transaction Instance Block DFSTIB DFSYTIB X | LNB Link Name Block ICLI X | ECNT Extended Communication Name Table DBFECNT X | CRTCN Command CART & 4-Byte Console ID DFSMCSC X | CCB Conversational Control Block ICLI X | CIB Communication Interface Block ICLI X | MSGBP Basic 01/03 Message Prefix QLOGMSGP X | UOWE Unit of Work Table Entry DFSUOWE X | INBUF Input Line Buffer N/A X | OUTBUF Output Line Buffer N/A X | LCB Link Control Block LCB X | LXB | Link Extension Block LXB X Primary Optional X X SHOW keyword parameters for the /DIAGNOSE SNAP LINK command SHOW Used as a filtering mechanism to control which blocks are returned. Using the SHOW() option, a single block, list of blocks, or group of blocks identified by the keyword can be returned. The following example code shows this command option: /DIAG SNAP LINK(9) 406 Commands, Volume 1: IMS Commands A - M If the SHOW() option is omitted from the /DIAGNOSE SNAP LINK() command, only the primary control blocks for the logical line are captured by default. The SNAP LINK() resource type supports the ALL, PRI, and OPT keywords, and all block names that are listed in Table 219 on page 406 as parameters to the SHOW() option. Multiple SHOW() option parameters can be specified with each parameter separated by a comma or a blank. A maximum of 16 SHOW() option parameters can be specified. ALL Captures all control blocks listed in Table 219 on page 406 that are available. Example: /DIAG SNAP LINK(9) SHOW(ALL) PRI Captures the primary control blocks for the logical line. Primary control blocks are identified by the Primary column in Table 219 on page 406. Example: /DIAG SNAP LINK(9) SHOW(PRI) OPT Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 219 on page 406. Example: /DIAG SNAP LINE(9) SHOW(OPT) blockname Captures the specified block by block name. Block names are defined in the Name column in Table 219 on page 406. Example: /DIAG SNAP LINK(9) SHOW(CLB) blockname,blockname Captures multiple blocks by block name. Example: /DIAG SNAP LINK(9) SHOW(LLB,CTT) keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP LINK(9) SHOW(PRI,PDIR) Usage notes for the /DIAGNOSE SNAP LINK command The /DIAGNOSE SNAP LINK() command is available only in a DB/DC or DCCTL environment. | | | | | | The SHOW(PROLOG) option displays information about the modules that are associated with the save areas in the chain. The module entry point is obtained from the saved register 15 value of the previous save area. If SHOW(SAVEAREA) is combined with SHOW(PROLOG), the display consists of a save area followed by the related prolog of the module that uses the save area. | | | The following control blocks are available only in an IMS system where Fast Path is defined. | | | | | | v ECNT (Extended Communication Name Table) v EMHB (Expedited Message Handler Block) v SMB (Scheduler Message Block) v TIB (APPC Transaction Instance Block) v YTIB (OTMA Transaction Instance Block) If the SHOW(ALL) or SHOW(OPT) option is specified in a non-Fast Path environment, these blocks are ignored. If the SHOW(ECNT), Chapter 25. /DIAGNOSE commands 407 | | | SHOW(EMHB), SHOW(SMB), SHOW(TIB), or SHOW(YTIB) option is specified in a non-Fast Path environment, a DFS154I message is issued in response. | | | | | UOWE (Unit of Work Table Entry) block is available only in an IMS system where shared queues are defined. If the SHOW(ALL) or SHOW(APP) option is specified in a non-shared-queues environment, UOWE is ignored. If the SHOW(UOWE) option is specified in a non-shared-queues environment, a DFS154I message is issued in response. | | | | | TIB (APPC Transaction Instance Block) and YTIB (OTMA Transaction Instance Block) are mutually exclusive; only one is present at any given time. For SHOW() purposes, TIB and YTIB are treated as synonyms. Specifying either TIB or YTIB displays, if available, whichever of the two blocks is present. | The SHOW(SA) option is a synonym for the SHOW(SAVEAREA) option. LTERM | | | | | Captures control block information for the logical terminal specified in the ltermname parameter. The ltermname parameter specified must be alphanumeric, no longer than 8 characters, and identify a currently defined logical terminal. Multiple ltermname parameters can be specified with each parameter separated by a comma or a blank. | | | | | | | The control blocks that can be captured for logical terminals are listed in the following table. Primary control blocks for a logical terminal, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a logical terminal, which might or might not be present and available for capture depending on workload and other factors, are identified by the column labeled “Optional”. | Table 220. /DIAGNOSE SNAP LTERM() control blocks | Name Block description Macro Primary Optional | CNT Communication Name Table (Target) ICLI X 1 | RCNT Remote Communication Name Table RCNT X 2 | LNB Link Name Block LNB X 2 | EPF Event Control Block Prefix IEPF X | CULE Common Use List Element Block DFSCULE X | DSPWRK1 Dispatcher Work Area IDSPWRK X | SAP Save Area Prefix ISAP X | SAVEAREA Save Area Set REQUATE X | PROLOG Module Prolog Information N/A X | CLB Communication Line Block ICLI X | CTB Communication Terminal Block ICLI X | CTT Communication Translate Table ICLI X | CRB Communications Restart Block ICLI X | SPQB Subpool Queue Block ICLI X | SPQBEXT Subpool Queue Extension Block ICLI X | EMHB Expedited Message Handler Block DBFEMHB X | SMB Scheduler Message Block IAPS X 408 Commands, Volume 1: IMS Commands A - M | Table 220. /DIAGNOSE SNAP LTERM() control blocks (continued) | Name Block description Macro | | | TIB YTIB APPC Transaction Instance Block OTMA Transaction Instance Block DFSTIB DFSYTIB X | CNT Communication Name Table ICLI X | ECNT Extended Communication Name Table DBFECNT X | CRTCN Command CART & 4-Byte Console ID DFSMCSC X | CCB Conversational Control Block ICLI X | CIB Communication Interface Block ICLI X | MSGBP Basic 01/03 Message Prefix QLOGMSGP X | UOWE Unit of Work Table Entry DFSUOWE X | INBUF Input Line Buffer N/A X | OUTBUF Output Line Buffer N/A X | RAQE VTAM Receive Any IO Buffer (In) BUFVTPRE X | RAQERES VTAM Receive Any IO Buffer (Out) BUFVTPRE X | 1 Primary blocks for a local logical terminal | | 2 Primary blocks for a remote logical terminal Primary Optional | SHOW keyword parameters for the /DIAGNOSE SNAP LTERM command | | | | | | | | | | SHOW Specifies which blocks are returned. If the SHOW keyword is omitted from the /DIAGNOSE SNAP LTERM command, only the primary control blocks for the logical terminal are captured by default. The SNAP LTERM() resource type supports the ALL, DEF (or DEFAULT), OPT, PRI, and TAR (or TARGET) keywords, and all block names that are listed in Table 220 on page 408 as parameters for the SHOW keyword. Multiple SHOW parameters can be specified with each parameter separated by a comma or a blank. A maximum of 32 SHOW parameters can be specified. | | | The effects of the SHOW option on the data that is captured by the /DIAGNOSE SNAP LTERM command are described in the following list: | | | ALL | | | | | DEF | | | | OPT | | PRI Captures all control blocks listed in Table 220 on page 408 that are available. Example: /DIAG SNAP LTERM(MTRL) SHOW(ALL). Captures information about default blocks for the current logical terminal. DEF, or DEFAULT, is equivalent to the PRI keyword or without any SHOW parameter. Example: /DIAGNOSE SNAP LTERM(MTRL) SHOW(DEF). Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 220 on page 408. Example: /DIAG SNAP LTERM(MTRL) SHOW(OPT). Captures the primary control blocks for the logical terminal. Chapter 25. /DIAGNOSE commands 409 | | | Primary control blocks are identified by the Primary column in Table 220 on page 408. Example: /DIAG SNAP LTERM(MTRL) SHOW(PRI). | | | TARGET Captures the target CNT (Communication Name Table) for a local logical terminal (LTERM). TARGET can be abbreviated as TAR. | | | | | | If the SHOW(TARGET) option is specified and the only resource specified is a remote logical terminal, a DFS2859I informational message is issued with the following reason text: NO VALID BLOCKS SPECIFIED FOR LTERM(ltermname). If other SHOW() options are included that are applicable to a remote logical terminal, those blocks are displayed, and the TARGET option is ignored. | | | If the SHOW(TARGET) option is specified and both local and remote logical terminal resources are specified, a DFS2859I message is issued for the remote logical terminal. | Example: /DIAGNOSE SNAP LTERM(MTRL) SHOW(TAR). | | | | blockname Captures the specified block by block name. Block names are defined in the Name column in Table 220 on page 408. Example: /DIAG SNAP LTERM(MTRL) SHOW(CLB). | | | blockname,blockname Captures multiple blocks by block name. Example: /DIAG SNAP LTERM(MTRL) SHOW(CLB,CTB). | | | keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP LTERM(MTRL) SHOW(PRI,CTB). | Usage notes for the /DIAGNOSE SNAP LTERM command | | The /DIAGNOSE SNAP LTERM command is available in a DB/DC or DCCTL environment. | | | | | | The SHOW(PROLOG) option displays information about the modules that are associated with the save areas in the chain. The module entry point is obtained from the saved register 15 value of the previous save area. If SHOW(SAVEAREA) is combined with SHOW(PROLOG), the display consists of a save area followed by the related prolog of the module that uses the save area. | | | | The following control blocks are available only in an IMS system where Fast Path is defined. v ECNT (Extended Communication Name Table) v EMHB (Expedited Message Handler Block) | | | v SMB (Scheduler Message Block) v TIB (APPC Transaction Instance Block) v YTIB (OTMA Transaction Instance Block) | | | | | If the SHOW(ALL) or SHOW(OPT) option is specified in a non-Fast Path environment, these blocks are ignored. If the SHOW(ECNT), SHOW(EMHB), SHOW(SMB), SHOW(TIB), or SHOW(YTIB) option is specified in a non-Fast Path environment, a DFS154I message is issued in response. 410 Commands, Volume 1: IMS Commands A - M | | | | | UOWE (Unit of Work Table Entry) block is available only in an IMS system where shared queues are defined. If the SHOW(ALL) or SHOW(APP) option is specified in a non-shared-queues environment, UOWE is ignored. If the SHOW(UOWE) option is specified in a non-shared-queues environment, a DFS154I message is issued in response. | | | | | If the SHOW(RCNT), SHOW(LNB), or SHOW(RCNT,LNB) option is specified and the only resource specified is a local logical terminal, a DFS2859I informational message is issued. If other SHOW() options are included that are applicable to a local logical terminal, those blocks are displayed, and the RCNT or LNB option is ignored. | | | If the SHOW(RCNT), SHOW(LNB), or SHOW(RCNT,LNB) option is specified and both local and remote logical terminal resources are specified, a DFS2859I message is issued for the local logical terminal. | | | | | TIB (APPC Transaction Instance Block) and YTIB (OTMA Transaction Instance Block) are mutually exclusive; only one is present at any given time. For SHOW() purposes, TIB and YTIB are treated as synonyms. Specifying either TIB or YTIB displays, if available, whichever of the two blocks is present. | | | The SHOW(RECANY) option displays information about both RAQE (VTAM Receive Any IO Buffer (In)) and RAQERES (VTAM Receive Any IO Buffer (Out)) control blocks. | The SHOW(SA) option is a synonym for the SHOW(SAVEAREA) option. MODULE Returns the entry point address and captures in-storage prolog information about the IMS module specified in the modname parameter. The standard IMS module in-storage prolog information contains the module name, product level, assembly date and time, last APAR ID, module maintenance level, BPE version, and release (for BPE-based modules), and copyright statement. Note: The name of the IMS module that appears in the in-storage prolog information might not be the same as the loaded module name if binder options were used to declare a different name for the loaded module. MODULE(modname) enables IBM Software Support representatives to see the maintenance level of the installed software. | | | | | | MSNAME Captures control block information for the MSNAME specified in the msname parameter. The msname parameter specified must be alphanumeric, no longer than 8 characters, and identify a currently defined MSNAME. Multiple msname parameters can be specified with each parameter separated by a comma or a blank. | | | | | | The control blocks that can be captured for MSNAMEs are listed in the following table. Primary control blocks for an MSNAME, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for an MSNAME, which might or might not be present and available for capture depending on workload and other factors, are identified by the column labeled “Optional”. | Table 221. /DIAGNOSE SNAP MSNAME() control blocks | Name Block description Macro | LNB Link Name Block (Target) LNB Primary Optional X Chapter 25. /DIAGNOSE commands 411 | Table 221. /DIAGNOSE SNAP MSNAME() control blocks (continued) | Name Block description Macro | EPF Event Control Block Prefix IEPF X | CULE Common Use List Element Block DFSCULE X | DSPWRK1 Dispatcher Work Area IDSPWRK X | SAP Save Area Prefix ISAP X | SAVEAREA Save Area Set REQUATE X | PROLOG Module Prolog Information N/A X | LLB Link Line Block ICLI X | LTB Link Terminal Block ICLI X | CTT Communication Translate Table ICLI X | CRB Communications Restart Block ICLI X | SPQB Subpool Queue Block ICLI X | SPQBEXT Subpool Queue Extension Block ICLI X | EMHB Expedited Message Handler Block DBFEMHB X | SMB Scheduler Message Block IAPS X | TIB | | YTIB APPC Transaction Instance Block OTMA Transaction Instance Block DFSTIB DFSYTIB X | LNB Link Name Block ICLI X | ECNT Extended Communication Name Table DBFECNT X | CRTCN Command CART & 4-Byte Console ID DFSMCSC X | CCB Conversational Control Block ICLI X | CIB Communication Interface Block ICLI X | MSGBP Basic 01/03 Message Prefix QLOGMSGP X | UOWE Unit of Work Table Entry DFSUOWE X | INBUF Input link buffer N/A X | OUTBUF Output link buffer N/A X | LCB Link Control Block LCB X | LXB | Link Extension Block LXB X Primary Optional | | SHOW keyword parameters for the /DIAGNOSE SNAP MSNAME command | | | | | | | | | | SHOW Specifies which blocks are to be returned. If the SHOW keyword is omitted from the /DIAGNOSE SNAP NODE command, only the primary control blocks for the MSNAME are captured by default. The SNAP MSNAME resource type supports the ALL, PRI, OPT, and TAR (or TARGET) keywords, and all block names that are listed in Table 221 on page 411 as parameters for the SHOW keyword. Multiple SHOW parameters can be specified with each parameter separated by a comma or a blank. A maximum of 32 SHOW parameters can be specified. | | | The effects of the SHOW option on the data that is captured by the /DIAGNOSE SNAP MSNAME command are described in the following list: 412 Commands, Volume 1: IMS Commands A - M | | | ALL | | | | OPT | | | | PRI | | | | TARGET Captures the target LNB (Link Name Block) for the MSNAME. TARGET can be abbreviated as TAR. Example: /DIAGNOSE SNAP MSNAME(MTR1) SHOW(TAR). | | | | blockname Captures the specified block by block name. Block names are defined in the Name column in Table 221 on page 411. Example: /DIAGNOSE SNAP MSNAME(MSN1) SHOW(CLB). | | | blockname,blockname Captures multiple blocks by block name. Example: /DIAGNOSE SNAP MSNAME(MSN1) SHOW(CLB,CTB). | | | keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP MSNAME(MSN1) SHOW(PRI,CTB). Captures all control blocks listed in Table 221 on page 411 that are available. Example: /DIAGNOSE SNAP MSNAME(MSN1) SHOW(ALL). Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 221 on page 411. Example: /DIAGNOSE SNAP MSNAME(MSN1) SHOW(OPT). Captures the primary control blocks for the MSNAME. Primary control blocks are identified by the Primary column in Table 221 on page 411. Example: /DIAGNOSE SNAP MSNAME(MSN1) SHOW(PRI). | Usage notes for the /DIAGNOSE SNAP MSNAME command | | The /DIAGNOSE SNAP MSNAME command is available only in a DB/DC or DCCTL environment. | | | | | | The following control blocks are available only in an IMS system where Fast Path is defined. ECNT (Extended Communication Name Table) EMHB (Expedited Message Handler Block) SMB (Scheduler Message Block) TIB (APPC Transaction Instance Block) YTIB (OTMA Transaction Instance Block) | v v v v v | | | | | If the SHOW(ALL) or SHOW(OPT) option is specified in a non-Fast Path environment, these blocks are ignored. If the SHOW(ECNT), SHOW(EMHB), SHOW(SMB), SHOW(TIB), or SHOW(YTIB) option is specified in a non-Fast Path environment, a DFS154I message is issued in response. | | | | | UOWE (Unit of Work Table Entry) block is available only in an IMS system where shared queues are defined. If the SHOW(ALL) or SHOW(APP) option is specified in a non-shared-queues environment, UOWE is ignored. If the SHOW(UOWE) option is specified in a non-shared-queues environment, a DFS154I message is issued in response. | | TIB (APPC Transaction Instance Block) and YTIB (OTMA Transaction Instance Block) are mutually exclusive; only one is present at any given Chapter 25. /DIAGNOSE commands 413 | | | time. For SHOW() purposes, TIB and YTIB are treated as synonyms. Specifying either TIB or YTIB displays, if available, whichever of the two blocks is present. | | | | | | The SHOW(PROLOG) option displays information about the modules that are associated with the save areas in the chain. The module entry point is obtained from the saved register 15 value of the previous save area. If SHOW(SAVEAREA) is combined with SHOW(PROLOG), the display consists of a save area followed by the related prolog of the module that uses the save area. | The SHOW(SA) option is a synonym for the SHOW(SAVEAREA) option. NODE | | | | | Captures control block information for the node name specified in the nodename parameter. The nodename parameter specified must be alphanumeric, no longer than 8 characters, and identify a currently defined node name. Multiple nodename parameters can be specified with each parameter separated by a comma or a blank. | | | | | | The control blocks that can be captured for node names are listed in Table 222. Primary control blocks for a node name, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a node name, which might or might not be present and available for capture depending on workload and other factors, are identified by the column labeled “Optional”. | Table 222. /DIAGNOSE SNAP NODE() control blocks | Name Block description Macro | EPF Event Control Block Prefix IEPF | CULE Common Use List Element Block DFSCULE X | DSPWRK1 Dispatcher Work Area IDSPWRK X Primary Optional X | SAP Save Area Prefix ISAP X | SAVEAREA Save Area Set REQUATE X | PROLOG Module Prolog Information N/A X | CLB Communication Line Block ICLI | CTB Communication Terminal Block ICLI X | CTT Communication Translate Table ICLI X | CRB Communications Restart Block ICLI X | SPQB Subpool Queue Block ICLI X | SPQBEXT Subpool Queue Extension Block ICLI X | EMHB Expedited Message Handler Block DBFEMHB X | SMB Scheduler Message Block IAPS X | TIB | | YTIB APPC Transaction Instance Block OTMA Transaction Instance Block DFSTIB DFSYTIB X | CNT Communication Name Table ICLI X | ECNT Extended Communication Name Table DBFECNT X | CRTCN Command CART & 4-Byte Console ID DFSMCSC X | CCB Conversational Control Block ICLI X | CIB Communication Interface Block ICLI X | MSGBP Basic 01/03 Message Prefix QLOGMSGP X 414 Commands, Volume 1: IMS Commands A - M X | Table 222. /DIAGNOSE SNAP NODE() control blocks (continued) | Name Block description Macro | UOWE Unit of Work Table Entry DFSUOWE X | INBUF Input Line Buffer N/A X | OUTBUF Output Line Buffer N/A X | RAQE VTAM Receive Any IO Buffer (In) BUFVTPRE X | | RAQERES VTAM Receive Any IO Buffer (Out) BUFVTPRE X Primary Optional | SHOW keyword parameters for the /DIAGNOSE SNAP NODE command | | | | | | | | | SHOW Specifies which blocks are returned. If the SHOW keyword is omitted from the /DIAGNOSE SNAP NODE command, only the primary control blocks for the node name are captured by default. The SNAP NODE resource type supports the ALL, OPT, and PRI keywords, and all block names that are listed in Table 222 on page 414 as parameters for the SHOW keyword. Multiple SHOW parameters can be specified with each parameter separated by a comma or a blank. A maximum of 32 SHOW parameters can be specified. | | | The effects of the SHOW option on the data that is captured by the /DIAGNOSE SNAP NODE command are described in the following list: | | | ALL | | | | OPT | | | | PRI | | | | blockname Captures the specified block by block name. Block names are defined in the Name column in Table 222 on page 414. Example: /DIAGNOSE SNAP NODE(L3270A) SHOW(CLB). | | | blockname,blockname Captures multiple blocks by block name. Example: /DIAGNOSE SNAP NODE(L3270A,L3270B) SHOW(CLB,CTB). | | | keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP LTERM(MTRL) SHOW(PRI,CTB). Captures all control blocks listed in Table 222 on page 414 that are available. Example: /DIAGNOSE SNAP NODE(L3270A) SHOW(ALL). Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 222 on page 414. Example: /DIAGNOSE SNAP NODE(L3270A) SHOW(OPT). Captures the primary control blocks for the node. Primary control blocks are identified by the Primary column in Table 222 on page 414. Example: /DIAGNOSE SNAP NODE(L3270A) SHOW(PRI). | Usage notes for the /DIAGNOSE SNAP NODE command | | The /DIAGNOSE SNAP NODE command is available only in a DB/DC or DCCTL environment. | | The following control blocks are available only in an IMS system where Fast Path is defined. Chapter 25. /DIAGNOSE commands 415 ECNT (Extended Communication Name Table) EMHB (Expedited Message Handler Block) SMB (Scheduler Message Block) TIB (APPC Transaction Instance Block) YTIB (OTMA Transaction Instance Block) | | | | | v v v v v | | | | | If the SHOW(ALL) or SHOW(OPT) option is specified in a non-Fast Path environment, these blocks are ignored. If the SHOW(ECNT), SHOW(EMHB), SHOW(SMB), SHOW(TIB), or SHOW(YTIB) option is specified in a non-Fast Path environment, a DFS154I message is issued in response. | | | | | UOWE (Unit of Work Table Entry) block is available only in an IMS system where shared queues are defined. If the SHOW(ALL) or SHOW(APP) option is specified in a non-shared-queues environment, UOWE is ignored. If the SHOW(UOWE) option is specified in a non-shared-queues environment, a DFS154I message is issued in response. | | | | | TIB (APPC Transaction Instance Block) and YTIB (OTMA Transaction Instance Block) are mutually exclusive; only one is present at any given time. For SHOW() purposes, TIB and YTIB are treated as synonyms. Specifying either TIB or YTIB displays, if available, whichever of the two blocks is present. | | | | | | The SHOW(PROLOG) option displays information about the modules that are associated with the save areas in the chain. The module entry point is obtained from the saved register 15 value of the previous save area. If SHOW(SAVEAREA) is combined with SHOW(PROLOG), the display consists of a save area followed by the related prolog of the module that uses the save area. | | | The SHOW(RECANY) option displays information about both RAQE (VTAM Receive Any IO Buffer (In)) and RAQERES (VTAM Receive Any IO Buffer (Out)) control blocks. | The SHOW(SA) option is a synonym for the SHOW(SAVEAREA) option. OPTION Specifies the destination for the resource information captured by the SNAP function. The OPTION parameter is optional. DISPLAY SNAP output is formatted and displayed on the issuing LTERM. DISPLAY is the default. You can specify the following keywords with the DISPLAY option: LIMIT Specifies a limit for the number of lines of formatted SNAP data to display in response to the command. LIMIT is a subparameter of the DISPLAY option. The LIMIT parameter is optional and has a default value of 1999. The linecount parameter must be numeric and in the range 1 - 9999. | | | FORMAT Specifies the format of the output to be produced. The default is FORMAT(LONG). Valid values for the FORMAT() parameter are: | | | LOC LOCATION Only the block name, description, and location are displayed. 416 Commands, Volume 1: IMS Commands A - M | | | | | LONG The complete display is produced, which includes the block name, description, location, and a dump of the complete storage area for the block in both hexadecimal and character format. OLDS SNAP data is written to the OLDS. | | | SYSOUT SNAP data is queued to the diagnostic asynchronous work element (AWE) service and written to a SYSOUT data set. | You can specify the following keywords with the SYSOUT option: | | | | | | | | | CLASS Specifies an output class for the SYSOUT data set. The attributes of each output class are installation-specific and defined during JES initialization. The sysout_class parameter must be a single alphanumeric character A - Z or 0 - 9. Any defined, valid JES output class can be specified. The characteristics of the SYSOUT data set are: DSORG=PS, RECFM=FB, LRECL=80 BLKSIZE=4080. The CLASS parameter is optional and defaults to the default SYSOUT class assigned to the IMS control region. | | | LIMIT Specifies a limit for the number of lines of formatted SNAP data to process. | | | The LIMIT parameter is optional and has a default value of 19999. If specified, the linecount parameter must be numeric and in the range 1 - 99999. | | | FORMAT Specifies the format of the output to be produced. The default is FORMAT(LONG). Valid values for the FORMAT() parameter are: | | | LOC LOCATION Only the block name, description, and location are displayed. | | | | | LONG The complete display is produced, which includes the block name, description, location, and a dump of the complete storage area for the block in both hexadecimal and character format. | TRACE If TRACE is specified, SNAP data is written to the trace data sets. Important: If you do not issue the /TRACE SET ON TABLE DIAG OPTION LOG command before issuing the /DIAGNOSE command with the TRACE option, the /DIAGNOSE command automatically turns on the DIAG trace tables, writes the output to the trace tables, and then turns off the DIAG trace tables. One disadvantage of this method is that the output from only one /DIAGNOSE command can be written to the trace data sets; that is, each new command overwrites the data from the last command. To capture data from a series of /DIAGNOSE commands in a trace data set, issue the commands in this order: 1. /TRACE SET ON TABLE DIAG OPTION LOG command Chapter 25. /DIAGNOSE commands 417 2. /DIAGNOSE commands 3. /TRACE SET OFF TABLE DIAG command PGM Captures control block information for the program specified in the pgmname parameter. The pgmname parameter specified must be alphanumeric, no longer than eight characters, and identify a currently defined program. Multiple pgmname parameters can be specified with each parameter separated by a comma or a blank. The control blocks that can be captured for a program are listed in the following table. Primary control blocks for a logical line, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a logical link, which might be present and available for capture based on workload and other factors, are identified by the column labeled “Optional”. Table 223. /DIAGNOSE SNAP PGM() control blocks Name Block description Macro Primary Optional Work PDIR Program Directory Block DFSPDIR RSCX Resource Extension Block DFSRSCX X X INTLIST Intent List INTLIST X X PSB Program Specification Block DFSPSB X X PST Partition Specification Table IPST X X CNT Communication Name Table ICLI X X SMB Scheduler Message Block IAPS X X DMBL Data management Block List DFSDMBL X X XPCB Program Communication Block Index Maintenance DFSPCBS X X PCB Program Communication Block DFSPCBS X X PCBX Program Communication Extension Block DFSPCBS X X EPCB Program Communication Block Extension DBFEPCB X X MSG6P MSGOP Message Prefix (LU62) Message Prefix (OTMA) DFS62PRE DFSYPRE X X PSBPRM User Parameter List Block IDLI X X WKCDS Data Capture Segment Work Area N/A X X WKNDX Index Maintenance Work Area N/A X X WKXIO Index I/O Work Area N/A X X WKSEG Segment Work Area N/A X X WKIOA I/O Work Area N/A X X WKSSA Segment Search Argument Work Area N/A X X WKIFP Fast Path Control Block Work N/A Area X X X No Work X SHOW keyword parameters for the /DIAGNOSE SNAP PGM command 418 Commands, Volume 1: IMS Commands A - M SHOW Specifies which blocks are returned. Using the SHOW() option, a single block, list of blocks, or group of blocks identified by the keyword can be returned. Example: /DIAG SNAP PGM(APOL1) If the SHOW() option is omitted from the /DIAGNOSE SNAP PGM() command, only the primary control blocks for the program are captured by default. The SNAP PGM() resource type supports the ALL, OPT, PRI, WORK, and NOWORK keywords, and all block names that are listed in Table 223 on page 418 as parameters to the SHOW() option. Multiple SHOW() option parameters can be specified with each parameter separated by a comma or a blank. A maximum of 32 SHOW() option parameters can be specified. ALL Captures all control blocks listed in Table 223 on page 418 that are available. Example: /DIAG SNAP PGM(APOL1) SHOW(ALL) PRI Captures the primary control blocks for the program. Primary control blocks are identified by the Primary column in Table 223 on page 418. Example: /DIAG SNAP PGM(APOL1) SHOW(PRI) OPT Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 223 on page 418. Example: /DIAG SNAP PGM(APOL1) SHOW(OPT) blockname Captures the specified block by block name. Block names are defined in the Name column in Table 223 on page 418. Example: /DIAG SNAP PGM(APOL1) SHOW(PDIR) blockname,blockname Captures multiple blocks by block name. Example: /DIAG SNAP PGM(APOL1) SHOW(PDIR,PSB) keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP PGM(APOL1) SHOW(PRI,PDIR) WORK Captures all working storage blocks that are available. Working storage blocks are identified by the Work column in Table 223 on page 418. Example: /DIAG SNAP PGM(APOL1) SHOW(WORK) NOWORK Captures all non-work control blocks that are available. Non-work control blocks are identified by the No Work column in Table 223 on page 418. Example: /DIAG SNAP PGM(APOL1) SHOW(NOWORK) Usage notes for the /DIAGNOSE SNAP PGM command EPCB (Program Communication Block Extension) is available only in an IMS system where Fast Path is defined. If the SHOW(ALL) or SHOW(OPT) option is specified in a non-FP environment, the EPCB is ignored. If the SHOW(EPCB) option is specified in a non-FP environment, a DFS154I error message is issued in response MSG6P (Message Prefix for LU62) and MSGOP (Message Prefix for OTMA) are mutually exclusive. Only one is present at any point. For SNAP PGM() Chapter 25. /DIAGNOSE commands 419 SHOW() purposes, the MSG6P and MSGOP are treated as synonyms. Specifying either MSG6P or MSGOP displays, if available, whichever of the two blocks is present. REGION Captures control block information for the dependent region specified in the region# parameter. The region# parameter specified must be numeric, in the range 1 - 999, and identify a currently active dependent region. Multiple region# parameters can be specified with each parameter separated by a comma or a blank. The dependent region might also be identified using the SNAP JOBNAME(jobname) format of the SNAP REGION() resource type. The jobname parameter specified must be alphanumeric, no longer than eight characters, and identify a currently active dependent region. Multiple jobname parameters can be specified with each parameter separated by a comma or a blank. The REGION(region#) and JOBNAME(jobname) formats can both be specified on the same command. The control blocks that can be captured for a dependent region are listed in the following table. Primary control blocks for a dependent region, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a dependent region, which might be present and available for capture based on workload and other factors, are identified by the column labeled “Optional”. Table 224. /DIAGNOSE SNAP REGION() control blocks Name Block description Macro VTD SVC Vector Table Directory Entry DFSVDIR ASCB MVS Address Space Control Block IHAASCB X X ASSB MVS Address Space Secondary Block IHAASSB X X DPDIR Dependent Region Directory Block DFSDPDIR X X IWALE Internal Work Area List Elements Block DFSIQALE X X LESEP Local External Entry Table Prefix Block DFSLESEP X X DRAT DRA Thread Control Block DFSDRAT X X IDT Identify Table Entry DFSIDT TCB MVS Task Control Block (IDT) IKJTCB X X TCB Task Control Block (PST) IKJTCB X X SAP Save Area Prefix block ISAP DSPWRK1 Dispatch Block: Work Area Part 1 (current) IDSPWRK X X DSPWRK2 Dispatch Block: Work Area Part 2 (current) IDSPWRK X X TCB MVS Task Control Block (CDSP) IKJTCB X X RB MVS Associated Request Block (CDSP) IHARB X X RBP MVS Associated Request Block Prefix IHARB (CDSP) X X XSB MVS Extended Status Block (CDSP) X X 420 Commands, Volume 1: IMS Commands A - M IHAXSB Primary Optional X System X X X X X Application Table 224. /DIAGNOSE SNAP REGION() control blocks (continued) Name Block description Macro DSPWRK1 Dispatcher Block: Work Area Part 1 (home) DSPWRK2 Primary Optional System IDSPWRK X X Dispatcher Block: Work Area Part 2 (home) IDSPWRK X X DSPPST PST Dispatching Control Block IDSPWRK X X XMCI Cross-Memory Control Block, ITASK Level DFSXMC X X SSVPL System Service Parameter List Block DFSSSVPL X X DMIB Directed Message Manager Interface Block DFSDMIB X X CULE Common Use List Element Block DFSCULE X X CLLE Common Latch List Element Block DFSCLLE X X LSMB Logging Secondary Master Block DFSLSMB X X SSIDX Subsystem Status Index Entry DFSSSIE X X X LCRE Local Current Recovery Entry DFSLCRE X X X RRE Residual Recovery Element Block (LCRE) DFSRRE X X TIB YTIB APPC Transaction Instance Block OTMA Transaction Instance Block DFSTIB DFSYTIB X X PCENTRY Protected Conversation Task Table Entry DFSRRSIB X X RRE Residual Recovery Element Block (PC) DFSRRE X X PST Partition Specification Table IPST CNT Communication Name Table ICLI X X SMB Scheduler Message Block IAPS X X SQPST Scheduler Queue Element ISQPST X X UOW Unit of Work Value (QMGR) DFSUOWE X X UOWE Unit of Work Table Entry DFSUOWE X X EPFXH Extended Message Prefix Header DFSEPFXH X X MSGBP Basic 01/03 Message Prefix QLOGMSGP X X BSGEP Extended Message Prefix QLOGMSGP X X PDIR Program Directory Block DFSPDIR X X PSB Program Specification Block DFSPSB X X TLS Transaction Level Statistics Area DFSTLS X X DACCT DL/I Call Statistics Area DFSDACCT X X MSCEB MSC Message Routing Exit Interface Block DFSMSCEB X X D2AFB DB2 RRS Attach Facility Interface Block DFSD2AF X X OLRW Online Reorganization Work Area Block DFSOLRW X X ISIT Intersubsystem Interface Table IPST X X X X Application X Chapter 25. /DIAGNOSE commands 421 Table 224. /DIAGNOSE SNAP REGION() control blocks (continued) Name Block description Macro DIRCA Interregion Communication Area Block IRC EPST Primary Optional System Application X X Extended Partition Specification Table DBFEPST X X DSTA DBCTL Statistics Area Block DFSDSTA X X RRE Residual Recovery Element Block (PST) DFSRRE X X P62XT LU 6.2 PST Extension Block DFSP62XT X X WLM Workload Manager Work Area Block DFSWLMWK X X RSSMP RAS System Security Message Prevention List DFSRSSMP X X SHOW keyword parameters for the /DIAGNOSE SNAP REGION command SHOW Specifies which blocks are returned. Using the SHOW() option, a single block, list of blocks, or group of blocks identified by the keyword can be returned. Example: /DIAG SNAP REG(1) If the SHOW() option is omitted from the /DIAGNOSE SNAP REGION() command, only the primary control blocks for the dependent region are captured by default. The SNAP REGION() resource type supports the ALL, PRI, OPT, APP, and SYS keywords, and all block names listed in Table 224 on page 420 as parameters to the SHOW() option. ALL Captures all control blocks listed in Table 224 on page 420 that are available. Example: /DIAG SNAP REG(1) SHOW(ALL) PRI Captures the primary control blocks for the region. Primary control blocks are identified by the Primary column in Table 224 on page 420. Example: /DIAG SNAP REG(1) SHOW(PRI) OPT Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 224 on page 420. Example: /DIAG SNAP REG(1) SHOW(OPT) APP Captures all application control blocks that are available. Control blocks that are part of the application group are identified by the Application column in Table 224 on page 420. Example: /DIAG SNAP REG(1) SHOW(APP) SYS Captures all system control blocks that are available. Control blocks that are part of the system group are identified in the System column in Table 224 on page 420. Example: /DIAG SNAP REG(1) SHOW(SYS) 422 Commands, Volume 1: IMS Commands A - M blockname Captures the specified block by block name. Block names are defined in the Name column in Table 224 on page 420. Example: /DIAG SNAP REG(1) SHOW(IDT) blockname,blockname Captures multiple blocks by block name. Example: /DIAG SNAP REG(1) SHOW(VTD,SAP) keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP REG(1) SHOW(SYS,PDIR) Usage notes for the /DIAGNOSE SNAP REGION command DRAT (DRA Thread Control Block) is available only in a DBCTL environment. If the SHOW(ALL) or SHOW(SYS) option is specified in a non-DBCTL environment, the DRAT is ignored. If the SHOW(DRAT) option is specified in a non-DBCTL environment, a DFS110I message is issued. DSTA (DBCTL Statistics Area Block) is available only in a DBCTL environment. If the SHOW(ALL) or SHOW(SYS) option is specified in a non-DBCTL environment, the DSTA is ignored. If the SHOW(DSTA) option is specified in a non-DBCTL environment, a DFS110I message is issued. EPST (Extended Partition Specification Table) is available only in an IMS system where Fast Path is defined. If the SHOW(ALL) or SHOW(APP) option is specified in a non-Fast Path environment, the EPST is ignored. If the SHOW(EPST) option is specified in a non-Fast Path environment, a DFS154I message is issued. TIB (APPC Transaction Instance Block) and YTIB (OTMA Transaction Instance Block) are mutually exclusive. Only one is present at any time. For SNAP REGION() SHOW () purposes, TIB and YTIB are treated as synonyms. Specifying either TIB or YTIB displays whichever of the two blocks is present. The SNAP JOBNAME(jobname) format of the SNAP REGION() resource type cannot be used to identify a CCTL thread. All CCTL threads have the same job name and the CICS region, and therefore it is impossible to identify the correct thread by the job name. If multiple regions are started with the same job name, only the first region will be found using the SNAP JOBNAME(jobname) format of the SNAP REGION() resource type. VTD, ASCB, ASSB, DPDIR, IWALE, LESEP, DRAT, and IDT are not available for an OLR region. If the SHOW(ALL), SHOW(PRI), or SHOW(SYS) option is specified for an OLR region, these blocks are ignored. If any of these blocks are explicitly specified with the SHOW option for an OLR region, a DFS2859I message is issued. | | | RM Specifies the scope of the resource search for certain resource types. The RM() parameter is optional and applicable only to the LTERM(), NODE(), and USER() resource types. | Valid values for the RM() parameter are: | | | YES If YES is specified or the RM() parameter is omitted, a local search is performed for the requested resource. If a local copy of the resource is found, that copy is used. If a local copy of the resource Chapter 25. /DIAGNOSE commands 423 is not found, and a Resource Manager is available, a second search is performed on the RM for the resource. If a global copy of the resource is found, that copy is used. | | | If NO is specified, only a local search for the resource is performed. | | NO | | | | | ONLY If ONLY is specified, only a global search on the Resource Manager is performed. If RM(ONLY) is specified and a Resource Manager is not available, a DFS2859I message is issued with reason text RM(ONLY) INVALID, RM UNAVAILABLE, and the command is not processed. SHOW Specifies which control blocks are captured by the SNAP function. The SHOW parameter is optional. Valid filtering values for the keyword and blockname parameters are listed in each section that describes a SNAP resource type. SHOW(PRI) is the default. STRUCTURE Captures information about the DFSSQS control block storage for the specified shared queues structure. STRUCTURE(ALL) is the default. TRAN Captures information about the transaction specified in the tranname parameter. This keyword captures the SMB data for a specified transaction. | | | | | USER Captures control block information about the user name specified in the username parameter. The username parameter specified must be alphanumeric, no longer than 8 characters, and identify a currently defined user name. Multiple username parameters can be specified with each parameter separated by a comma or a blank. | | | | | | The control blocks that can be captured for user names are listed in the following table. Primary control blocks for a user name, which are always present and available for capture, are identified by the column labeled “Primary”. Optional control blocks for a user name, which might or might not be present and available for capture depending on workload and other factors, are identified by the column labeled “Optional”. | Table 225. /DIAGNOSE SNAP USER() control blocks | Name Block description Macro | SPQB Subpool Queue Block ICLI | EPF Event Control Block Prefix IEPF X | CULE Common Use List Element Block DFSCULE X | DSPWRK1 Dispatcher Work Area IDSPWRK X | SAP Save Area Prefix ISAP X | SAVEAREA Save Area Set REQUATE X | PROLOG Module Prolog Information N/A X | CLB Communication Line Block ICLI X | CTB Communication Terminal Block ICLI X | CTT Communication Translate Table ICLI X | CRB Communications Restart Block ICLI X | SPQBEXT Subpool Queue Extension Block ICLI X | EMHB Expedited Message Handler Block DBFEMHB X 424 Commands, Volume 1: IMS Commands A - M Primary Optional X | Table 225. /DIAGNOSE SNAP USER() control blocks (continued) | Name Block description Macro | SMB Scheduler Message Block IAPS X | | | TIB YTIB APPC Transaction Instance Block OTMA Transaction Instance Block DFSTIB DFSYTIB X | CNT Communication Name Table ICLI X | ECNT Extended Communication Name Table DBFECNT X | CRTCN Command CART & 4-Byte Console ID DFSMCSC X | CCB Conversational Control Block ICLI X | CIB Communication Interface Block ICLI X | MSGBP Basic 01/03 Message Prefix QLOGMSGP X | UOWE Unit of Work Table Entry DFSUOWE X | INBUF Input Line Buffer N/A X | OUTBUF Output Line Buffer N/A X | RAQE VTAM Receive Any IO Buffer (In) BUFVTPRE X | RAQERES | VTAM Receive Any IO Buffer (Out) BUFVTPRE X Primary Optional | SHOW keyword parameters for the /DIAGNOSE SNAP USER command | | | | | | | | | SHOW Specifies which blocks are returned. If the SHOW keyword is omitted from the /DIAGNOSE SNAP USER command, only the primary control blocks for the user name are captured by default. The SNAP USER() resource type supports the ALL, OPT, and PRI keywords, and all block names that are listed in Table 225 on page 424 as parameters for the SHOW keyword. Multiple SHOW parameters can be specified with each parameter separated by a comma or a blank. A maximum of 32 SHOW parameters can be specified. | | | The effects of the SHOW option on the data that is captured by the /DIAGNOSE SNAP USER command are described in the following list: | | | ALL | | | | OPT | | | | PRI | | | | blockname Captures the specified block by block name. Block names are defined in the Name column in Table 225 on page 424. Example: /DIAGNOSE SNAP USER(IMSUS04) SHOW(SPQB). Captures all control blocks listed in Table 225 on page 424 that are available. Example: /DIAGNOSE SNAP USER(IMSUS04) SHOW(ALL). Captures all optional control blocks that are available. Optional control blocks are identified by the Optional column in Table 225 on page 424. Example: /DIAGNOSE SNAP USER(IMSUS04) SHOW(OPT). Captures the primary control blocks for the user. Primary control blocks are identified by the Primary column in Table 225 on page 424. Example: /DIAG SNAP USER(IMSUS04) SHOW(PRI). Chapter 25. /DIAGNOSE commands 425 | | | blockname,blockname Captures multiple blocks by block name. Example: /DIAGNOSE SNAP USER(IMSUS04) SHOW(SPQB,EPF). | | | keyword,blockname Captures a group of blocks by keyword and individual blocks by block name. Example: /DIAG SNAP USER(IMSUS04) SHOW(PRI,EPF). | Usage notes for the /DIAGNOSE SNAP USER command | | The /DIAGNOSE SNAP USER command is available only in a DB/DC or DCCTL environment. | | | The following control blocks are available only in an IMS system where Fast Path is defined. v ECNT (Extended Communication Name Table) | | | | v v v v | | | | | If the SHOW(ALL) or SHOW(OPT) option is specified in a non-Fast Path environment, these blocks are ignored. If the SHOW(ECNT), SHOW(EMHB), SHOW(SMB), SHOW(TIB), or SHOW(YTIB) option is specified in a non-Fast Path environment, a DFS154I message is issued in response. | | | | | UOWE (Unit of Work Table Entry) block is available only in an IMS system where shared queues are defined. If the SHOW(ALL) or SHOW(APP) option is specified in a non-shared-queues environment, UOWE is ignored. If the SHOW(UOWE) option is specified in a non-shared-queues environment, a DFS154I message is issued in response. | | | | | TIB (APPC Transaction Instance Block) and YTIB (OTMA Transaction Instance Block) are mutually exclusive; only one is present at any given time. For SHOW() purposes, TIB and YTIB are treated as synonyms. Specifying either TIB or YTIB displays, if available, whichever of the two blocks is present. | | | | | | The SHOW(PROLOG) option displays information about the modules that are associated with the save areas in the chain. The module entry point is obtained from the saved register 15 value of the previous save area. If SHOW(SAVEAREA) is combined with SHOW(PROLOG), the display consists of a save area followed by the related prolog of the module that uses the save area. | | | The SHOW(RECANY) option displays information about both RAQE (VTAM Receive Any IO Buffer (In)) and RAQERES (VTAM Receive Any IO Buffer (Out)) control blocks. | The SHOW(SA) option is a synonym for the SHOW(SAVEAREA) option. EMHB (Expedited Message Handler Block) SMB (Scheduler Message Block) TIB (APPC Transaction Instance Block) YTIB (OTMA Transaction Instance Block) Usage notes One of the key uses for the /DIAGNOSE SNAP MODULE(modname) command is to return the entry point address of a module. With the /DIAGNOSE SNAP MODULE(modname) command, users can determine the entry point address of the target module without having to create a console dump to set an MVS SLIP trap. 426 Commands, Volume 1: IMS Commands A - M Another important use for the /DIAGNOSE SNAP MODULE(modname) command is to extract the prolog information for a module. The prolog information for a module contains information about the current maintenance level of the module on your system. This can be useful to find out if there is any missing maintenance on your module. Establishing a common, or baseline, maintenance level can be useful in diagnosing difficult or complex problems. Examples Example 1 for /DIAGNOSE command Entry ET: /DIAGNOSE SNAP TRAN(tranname) Response ET: DFS058I DIAGNOSE COMMAND COMPLETED Explanation: Diagnostic information about transaction tranname is captured and written to the IMS log. Example 2 for /DIAGNOSE command Entry ET: /DIAGNOSE SNAP BLOCK(ALL) OPTION(TRACE) Response ET: DFS058I DIAGNOSE COMMAND COMPLETED Explanation: Diagnostic information about IMS control blocks is captured and written to the trace data sets. Example 3 for /DIAGNOSE command Entry ET: /DIAGNOSE SNAP BLOCK(CSCD)OPTION(OLDS) Response ET: DFS058I DIAGNOSE COMMAND COMPLETED Explanation: Diagnostic information about APPC/OTMA SMQ SCD Extension control block is captured and written to the IMS log. Example 4 for /DIAGNOSE command Entry ET: /DIAGNOSE SNAP AREA(00010001) Response ET: /DIAGNOSE SNAP STORAGE DISPLAY Resource: AREA(D0010001) ALDS DEDB Area Name List Entry Loc: 09E0A590 ---- -------- -------- -------- -------- ---------------0000 C4F0F0F1 F0F0F0F1 09BF7E90 09B26A30 |D0010001..=.....| Chapter 25. /DIAGNOSE commands 427 DMAC ---0000 0010 0020 0030 0040 0050 0060 0070 0080 0090 00A0 00B0 00C0 00D0 00E0 00F0 0100 0110 0120 0130 0140 0150 0160 0170 0180 0190 01A0 01B0 01C0 01D0 01E0 01F0 0200 0210 0220 0230 0240 0250 0260 0270 0280 0290 02A0 02B0 02D0 02E0 02F0 0300 0310 0320 0330 0340 0350 0360 0370 0380 0390 03A0 03B0 03C0 03D0 03E0 03F0 0400 0410 428 DEDB -------F1F2F1F8 F0F0F0F1 00000000 00000000 00000000 00000000 00000000 01C1000A 000001F6 00000000 06088001 00000000 00000000 00000000 001CB600 00000000 09A5B0FC 00000000 09A5B0FC 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 34142B20 00010000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 09A5B0FC 00000000 00000000 00000000 00000000 00000000 00000000 40404040 40404040 00000000 00000000 00000000 Area Control Block -------- -------- -------C4C5C4C2 D1F0F0F1 C4F0F0F1 0010213F 2217081F 00000000 000001EF 00008000 00000E5B 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000403 00000000 000F0019 00780002 00000200 000003EA 00000005 00000000 00018000 00000000 01000101 00000001 00000000 00000002 00000000 40000000 00000000 00000000 00000000 09B267A0 00000000 00000000 40404040 000001C7 00000000 00000000 00080600 00000000 0A12F618 00000000 00010000 00000000 00000000 00000000 00000000 00000100 00401800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 0000FFA6 000001EF 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 25262D2E D5D6E5FF 00161718 00000000 09A5C090 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 40404040 40404040 40404040 40404040 40404040 40404040 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 Commands, Volume 1: IMS Commands A - M Loc: 09B26A30 ---------------|1218DEDBJ001D001| |0001............| |...............$| |................| |................| |................| |................| |.A..............| |...6............| |................| |................| |........ .......| |................| |............ | |.......G........| |..............6.| |.v..............| |................| |.v....... ......| |................| |................| |................| |................| |................| |.......w........| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |................| |....NOV.........| |.....v..........| |................| |................| |................| |................| |................| |................| |................| |................| |................| |.v..............| |................| |................| |................| |................| |................| |.... | | | | ............| |................| |................| |................| 0420 00000000 00000000 0430 00000000 00000000 0440 00000000 00000000 0450 2010213F 22193984 0460 00000000 00000000 0470 00000000 00000008 0480 00000000 00000000 0490 00000000 00000000 04A0 00000000 00000000 04B0 00000000 00000000 04C0 00000000 00000000 04D0 00000000 00000000 04E0 00000000 00000000 04F0 00000000 00000000 0500 00000000 00000000 *10213/152244* 00000000 00000000 00000000 2034028D 00000000 00000000 C65DAC50 00000000 00000000 00000000 09B0D000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 F91B8BE0 00000000 00000000 00000000 00000000 00000000 00000000 00000000 |................| |................| |................| |.......d........| |................| |................| |........F).&9...| |................| |................| |................| |................| |................| |................| |................| |........ | Explanation: Diagnostic information about the primary control blocks for the area is captured, formatted, and displayed on the issuing LTERM. Example 5 for /DIAGNOSE command Entry ET: /DIAGNOSE SNAP AREA(D0010001) SHOW(ALDS) Response ET: /DIAGNOSE SNAP STORAGE DISPLAY Resource: AREA(D0010001) ALDS DEDB Area Name List Entry Loc: 09E0A590 ---- -------- -------- -------- -------- ---------------0000 C4F0F0F1 F0F0F0F1 09BF7E90 09B26A30 |D0010001..=.....| *10213/152259* Explanation: Diagnostic information about the ALDS control block for the area is captured, formatted, and displayed on the issuing LTERM. Example 6 for /DIAGNOSE command Entry ET: /DIAGNOSE SNAP AREA(D0010001,D0010002) SHOW(ALDS) Response ET: /DIAGNOSE SNAP STORAGE DISPLAY Resource: AREA(D0010001) ALDS DEDB Area Name List Entry Loc: 09E0A590 ---- -------- -------- -------- -------- ---------------0000 C4F0F0F1 F0F0F0F1 09BF7E90 09B26A30 |D0010001..=.....| Resource: AREA(D0010002) ALDS DEDB Area Name List Entry Loc: 09E0A5A0 ---- -------- -------- -------- -------- ---------------0000 C4F0F0F1 F0F0F0F2 09BF7E90 09B26F38 |D0010002..=...?.| *10213/152311* Chapter 25. /DIAGNOSE commands 429 Explanation: Diagnostic information about the ALDS control block for areas D0010001 and D0010002 is captured, formatted, and displayed on the issuing LTERM. Example 7 for /DIAGNOSE command Entry ET: /DIAGNOSE SNAP AREA(D0010001) SHOW(ALDS,ADSC) Response ET: /DIAGNOSE SNAP STORAGE DISPLAY Resource: AREA(D0010001) ALDS DEDB Area Name List Entry Loc: 09E0A590 ---- -------- -------- -------- -------- ---------------0000 C4F0F0F1 F0F0F0F1 09BF7E90 09B26A30 |D0010001..=.....| ADSC DEDB Area Data Set Control Block Loc: 09A5B0FC ---- -------- -------- -------- -------- ---------------0000 C4F0F0F1 F0F0F0F1 C9D4E2E3 C5E2E3D3 |D0010001IMSTESTL| 0010 4BC4F0F0 F1F0F0F0 F1404040 40404040 |.D0010001 | 0020 40404040 40404040 40404040 40404040 | | 0030 40404040 00008003 08000000 10000000 | ............| 0040 09B26A30 09A5B040 00000000 F9000000 |.....v. ....9...| 0050 00000000 00000000 00000000 01CF1380 |................| 0060 00000000 00000000 00000200 00000200 |................| 0070 00000000 00000000 00000000 00000000 |................| 0080 00000000 00000000 00000000 00000000 |................| 0090 00000000 00000000 00000000 00000000 |................| 00A0 00000000 00000000 00000000 00000000 |................| 00B0 00000000 00000000 00000000 |............ | *10213/152558* Explanation: Diagnostic information about the ALDS and ADSC control blocks for the area is captured, formatted, and displayed on the issuing LTERM. | Example 8 for /DIAGNOSE command | | Entry ET: | | | | | | | | | | | | | | | Response ET: | | Explanation: Diagnostic information about the primary control blocks for MSNAME LINK31V6 is captured, formatted, and displayed on the issuing LTERM. Related concepts: /DIAGNOSE SNAP MSNAME(LINK31V6) SHOW(PRI) /DIAGNOSE SNAP STORAGE DISPLAY Resource: MSNAME(LINK31V6) LNB Link Name Block ---- -------- -------- -------0000 00000000 00000000 00000000 0010 00000000 00820084 00000000 0020 F3F1E5F6 00100021 00053D30 0030 00000000 00000000 00000000 0040 0C67C878 00000000 0004F150 0050 013F01B7 00000000 00000000 0060 00000000 00000000 00000000 *12216/072150* 430 Commands, Volume 1: IMS Commands A - M -------00000000 D3C9D5D2 00000000 00000000 00000000 00000000 00000000 Loc: 0C67C800 ---------------|................| |.....b.d....LINK| |31V6............| |................| |..H.......1&....| |................| |................| /DIAGNOSE command SNAP function (Diagnosis) Chapter 25. /DIAGNOSE commands 431 432 Commands, Volume 1: IMS Commands A - M Chapter 26. /DISPLAY commands Use the IMS /DISPLAY commands to display the processing status of IMS message queues and processing resources. The /DISPLAY commands can provide helpful information for controlling IMS operations. These commands can be issued to an IMSplex using the Batch SPOC utility. The output from a /DISPLAY command consists of headings that describe the display, the information requested, and a time stamp showing Julian date and time, in one of the following two formats: yyddd/hhmmss yyyyddd/hhmmss You control the time stamp format by specifying the YEAR4= execution parameter. The value shown in the QCNT column of the command output has different meanings for different commands, as described in individual /DISPLAY command topics. If the command includes a generic parameter that does not match any existing resource, an error message results. In an IMSplex, when status is copied to RM at signoff/logoff time, the status (and control blocks if the resource is dynamic) is deleted from the local system. An Automated Operator Interface (AOI) application program that issues a /DISPLAY command will not see some status information that is kept in RM if the IMS system on which the AOI program runs is not using RM services. When a /DISPLAY command is issued for NODE, USER, and LTERM resources from the command master, global status from RM might be displayed. The output of the display command will be dependent on the following guidelines: Command master IMS system v Displays information from the local system v Displays information from RM that is not owned, or is owned by a failed system Other IMS systems Displays information from the local system Attention: Using ALL, generic parameters, the /DISPLAY STATUS command, and the /DISPLAY CONVERSATION command without a specific resource name will result in extensive accesses to the Resource Manager for global information, and their use should be carefully considered. Subsections: v v v v “Status and attributes for the /DISPLAY command” on page 435 “/DISPLAY ACT command” on page 448 “/DISPLAY AFFIN command” on page 464 “/DISPLAY AOITKN command” on page 467 © Copyright IBM Corp. 1974, 2014 433 v v v v v “/DISPLAY APPC command” on page 468 “/DISPLAY AREA command” on page 470 “/DISPLAY ASMT command” on page 476 “/DISPLAY CCTL command” on page 485 “/DISPLAY CONV command” on page 488 v v v v v v v “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY CPLOG command” on page 492 CQS command” on page 493 DB command” on page 493 DBD command” on page 504 DESC command” on page 505 FDR command” on page 506 FPV command” on page 507 v v v v v v “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY HSB command” on page 509 HSSP command” on page 512 LINE command” on page 513 LINK command” on page 517 LTERM command” on page 521 LUNAME command” on page 525 v “/DISPLAY MASTER command” on page 530 v “/DISPLAY MODIFY command” on page 531 v “/DISPLAY MSNAME command” on page 545 v v v v “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY NODE command” on page 547 OASN SUBSYS command” on page 558 OLDS command” on page 559 OTMA command” on page 562 v “/DISPLAY OVERFLOWQ command” on page 567 v “/DISPLAY PGM command” on page 570 v “/DISPLAY POOL command” on page 573 v v v v v “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY PSB command” on page 592 PTERM command” on page 593 Q command” on page 595 QCNT command” on page 598 RECOVERY command” on page 603 v “/DISPLAY RTCODE command” on page 609 v “/DISPLAY SHUTDOWN STATUS command” on page 610 v v v v v v v “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY “/DISPLAY STATUS command” on page 616 STRUCTURE command” on page 623 SUBSYS command” on page 624 SYSID TRANSACTION command” on page 627 TIMEOVER command” on page 628 TMEMBER command” on page 629 TRACE command” on page 641 v “/DISPLAY TRACKING STATUS command” on page 651 v “/DISPLAY TRAN command” on page 659 v “/DISPLAY UOR command” on page 664 434 Commands, Volume 1: IMS Commands A - M v “/DISPLAY USER command” on page 667 Related concepts: Displaying components and resources (System Administration) Status and attributes for the /DISPLAY command A list of the attributes and status shown in the /DISPLAY command are described in the following table. Table 226. Attributes and status in the /DISPLAY command Status or attribute Meaning Indicates no status for the resource. ACCEPT TRAFFIC Indicates that the OTMA client is ready. ACT MODETBL Indicates the mode table name actually used to initiate mode. ACTIV Indicates that this node is in an XRF session, on the active system. ACTIVE, A Indicates conversation in progress. For /DISPLAY MODIFY, indicates that the routing code (RTCODE) named is active or that the library is active. Indicates that the IMS subsystem is the active subsystem. Indicates that the current XRF surveillance mechanism is active. Indicates that the OTMA client is in an active z/OS cross-system coupling facility (XCF) group. Indicates that the secondary master terminal is active. ACTIVE-DBCMD Indicates an /DBD or /DBR command is in progress and waiting for the region to terminate before the /DBD or /DBR can complete. | | | | ACTIVE-RRS The APPC/OTMA shared queues enablement is active, and z/OS Resource Recovery Services (RRS) is used for communication between front-end and back-end systems for all synchronization levels. | | | | | | ACTIVE-RRS/XCF The APPC/OTMA shared queues enablement is active, and z/OS cross-system coupling facility (XCF) is used for communication between front-end and back-end systems if synchronization level is NONE or CONFIRM. For synchronization level SYNCPOINT, RRS is used for communication between front-end and back-end systems. | | | | | | ACTIVE-XCF The APPC/OTMA shared queues enablement is active, and XCF is used for communication between front-end and back-end if synchronization level is set to NONE or CONFIRM. Transactions of synchronization level SYNCPOINT are queued with affinity to the front-end system. ACTV Indicates, for a logical link, that link startup processing is complete and the line is available for message transfer. ALLOC Indicates that an ISC user is allocated. The node name to which the user is allocated or signed on follows in parentheses. ALLOCATION IN PROGRESS Indicates that a conversation is in the process of being allocated. ALLOCF Indicates that database allocation failed. Chapter 26. /DISPLAY commands 435 Table 226. Attributes and status in the /DISPLAY command (continued) 436 Status or attribute Meaning ALLOCS Indicates that database allocation was successful. AREA The subset of a DEDB. AUTOSR Indicates a session initiation option of ASR. AVAILABLE Indicates that the OLDS can be reused. Indicates that a region is available to schedule an application. Indicates that a coupling facility structure is available for use by IMS. AWAITING RESPONSE Indicates that an active terminal is waiting for a response. AWAITING SNAPQ Indicates that the alternate subsystem is waiting for /CHE SNAPQ from the active subsystem. BACKOUT Indicates that the OLDS is potentially required for backout or, in the case of a database, there are incomplete backouts that prevent the use of the database. BACKUP Indicates that the IMS subsystem is the alternate subsystem. BAL Identifies a transaction eligible for load balancing (for example, with parallel limits specified). The current maximum number of regions that can be simultaneously scheduled to process the transaction follows in parentheses. BCKUP Indicates that this node is in an XRF session, on the alternate system. C1INOP, C2INOP, C3INOP, C4INOP Indicates the inoperable node or terminal component, where C1, C2, C3, and C4 refer to different components as defined by system definition. (See the /COMPT and /RCOMPT commands for details on how to ready inoperable components.) CANCEL Indicates that an APPC connection was stopped by the /STOP APPC CANCEL command. CHECK Indicates that the OTMA client is using RACF for security verification. CLSER Indicates that an error occurred while closing the OLDS. CLSDST Indicates that a /CLSDST or /STOP command has been entered for a VTAM node but has not yet taken effect. This condition can occur because of an outstanding input or output operation that has not completed. The VTAM network operator can issue a z/OS VARY command to clear the condition. COLD For an MSC logical link, indicates that link startup processing is not complete. For a SLUP or FINANCE terminal, indicates that the next session initiation is cold (message sequence numbers are initialized to 0.) COMPINOP Indicates an inoperable terminal component. For 3270 terminals, this is an indication that either the display or the printer is not ready. CON Indicates that a node is connected, or in session, with IMS. CONN Subsystem connection. CONN, ACTIVE Indicates that an application program has established communication with a subsystem. CONNECTED Indicates that IMS is connected to a coupling facility structure. Commands, Volume 1: IMS Commands A - M Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning CONN IN PROGRESS Subsystem connection in progress. CONVACT, CONV-ACT Indicates an active conversation on this terminal, node, or user. CONVERSATION TERM/USER Indicates for /DISPLAY MODIFY that the transaction to be changed or deleted or the transaction that references a program or database to be changed or deleted is in conversation. The terminal originating the conversational transaction and the conversation ID are also displayed. The terminal displayed is: v nodename for VTAM terminals v nodename and username if an ETO user is signed on to the node v username for ETO users who signed off while in conversation v lin#-pte# (line and pterm number) for non-VTAM terminals v 1- SC for the system console CONVHLD, CONV-HLD Indicates a held conversation on this terminal, node, or user. COPY-PHASE Indicates that the CREATE utility is currently in COPY-PHASE for an ADS. CREATED Indicates the XCF group has been created, but the OTMA client has not yet connected to it. DB-STOPD Indicates that a database used by this program is stopped. /DBD ACTIVE A /DBDUMP command is in progress for a database to be changed or deleted. /DBR ACTIVE A /DBRECOVERY command is in progress for a database to be changed or deleted. DEACT (DEACTIVATED) Indicates a physical terminal/node or line has been permanently deactivated. Restart of non-VTAM node requires /STOP DC and /START DC commands. Message DFS2473 in the system console log might contain information regarding the reason this status was set. DFS2473 can occur more than once in the system console log. DEADQ Indicates a user with dead letter queues or whose last access time was outside the limit set by the DLQT JCL parameter. The DEADQ status can be removed by signing on the user or entering the /DEQUEUE or /ASSIGN command. DEALLOCATION IN PROGRESS Indicates that a conversation is in the process of being deallocated. DEQCT Number of local message dequeues since the last IMS cold start or, in a shared-queue environment, since the last IMS restart. DEQCT is reset to zero when ENQCT reaches 32768. A DEQCT count can equal the sum of the DEQCTs of multiple destinations (logical terminals or transactions). DISABLED Indicates APPC/IMS is not known to APPC/z/OS. Chapter 26. /DISPLAY commands 437 Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning DISCONNECTED Indicates that a node is not in session. Indicates that the OTMA client has disconnected from the XCF group. Indicates that IMS is not connected to a coupling facility structure. DQF Indicates a dequeue request for OTMA REPresynch command failed. DYNAMIC A transaction was built in a shared-queues environment to enable transaction messages to be enqueued, but the transaction cannot run on the current IMS subsystem. EEQE Extended error queue element, indicates that one or more error queue elements are associated with the database. ELIGIBLE FOR SCHEDULING Indicates that the transaction is eligible for scheduling and cannot be deleted by online change. Stop the transaction before attempting another online change commit. ENABLED Indicates that APPC is started. ENQCT Number of local message enqueues since the last IMS cold start, or in a shared-queue environment, since the last IMS restart. ENQCT is reset to the number of messages on queue (QCT) when the counter reaches 32768 (QCT = ENQCT DEQCT). The ENQCT can exceed 32768 if the DEQCT remains zero. The ENQCT will be reset to zero if the counter exceeds 65535. An ENQCT count can equal the sum of the ENQCTs of multiple destinations (logical terminals or transactions). ERE Indicates, for a logical link, that link startup processing is not complete. When the link is started, emergency restart synchronization will be performed, because the previous link shutdown was either not normal or an IMS emergency restart was performed. EXCL Indicates a node, terminal, or user is in exclusive mode. FAILED Indicates that APPC failed to start. Indicates that OTMA failed to start or that the XCF group failed initialization. FILLING Indicates that a log gap is currently being filled. FLOOD Indicates that input from the tmember is suppressed because of a message flood condition. FORCE, FORCES Indicates a session initiation option of FORCE. | | | | | | FORCE-RRS The APPC/OTMA shared queues enablement is active, and RRS is used for communication between front-end and back-end systems for all synchronization levels. All transactions are queued without affinity even if one IMS system has the APPC/OTMA shared queues enablement not active. | | | | | | | | FORCE-RRS/XCF The APPC/OTMA shared queues enablement is active, and XCF is used for communication between front-end and back-end systems if synchronization level is NONE or CONFIRM. For synchronization level SYNCPOINT, RRS is used for communication between front-end and back-end systems. All transactions are queued without affinity even if one IMS system has the APPC/OTMA shared queues enablement not active. 438 Commands, Volume 1: IMS Commands A - M Table 226. Attributes and status in the /DISPLAY command (continued) | | | | | | | Status or attribute Meaning FORMAT-PHASE Indicates that the CREATE utility is currently in FORMAT-PHASE for an ADS. FULL Indicates that the OTMA client is using RACF for security verification, including for dependent regions. GLOBAL QUEUE COUNT INTERNAL ERROR, GLOBAL QUEUE COUNT STORAGE ERROR Indicates that IMS is unable to access global queue counts or obtain storage to query the queue counts. IC Indicates that image copy is in progress for that area or database by an HSSP region. IDENTIFICATION IN PROGRESS Indicates that the IMS logger is in the process of identifying to the Transport Manager Subsystem (TMS) but has not yet completed. IDENTIFIED Indicates that an IMS logger has identified to the TMS. IDLE Indicates that no activity of any kind is in progress for a line, node, or logical link. This is a common condition for VTAM node channel-to-channel links, and processor storage-to-processor storage links. IDLE-Cxx When the Multiple Systems Coupling (MSC) TCP/IP link is in IDLE state, asynchronous output might still be in progress and the link is waiting for that response. xx represents the following values: X'10' A response is owed for data. X'16' A response is owed for stop bracket initiation (SBI) or bracket initiation stopped (BIS). INACTIVE The APPC/OTMA shared queues enablement is inactive. If AOS=Y is specified, the global status might change to active if the IMS member that does not support the APPC and OTMA shared queues enablement leaves the shared queues group. A back-end system will still be able to process messages from a front-end system even with status INACTIVE. INACTIVE, I Indicates that the current XRF surveillance mechanism is inactive. For the /DISPLAY MODIFY command, indicates that the library is inactive. The RSR tracking subsystem is idle. INOP Indicates that a terminal or node is inoperable. IN-OVERFLOW Indicates that a coupling facility structure is in overflow mode. INPUT IN PROGRESS Indicates input in progress for an active terminal. INQONLY Indicates a /DBDUMP command was issued for the database. IN SLOWDOWN Indicates that the OTMA client is experiencing a slowdown because of excessive message traffic or resource constraints. INUSE, IN USE Indicates that queuing is in process for this transaction. (either terminal input or program-to-program switch). Also indicates this is the OLDS currently being used. INVALID SUBSYSTEM NAME = XXXX Indicates that a subsystem name was not defined to IMS. Chapter 26. /DISPLAY commands 439 Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning I/O PREVEN, I/O PREVENT, Indicates a BMP program that contains GSAM cannot I/O PREV complete scheduling because I/O prevention has not completed. Indicates further I/O requests to data sets are inhibited. 440 I/O TOLERATION Takeover process by which an alternate IMS subsystem ensures database integrity and enables new transaction processing as soon as possible. LOCK Indicates a node, terminal, transaction, program, or database is locked. LOOPTEST Indicates a line or terminal in looptest mode. LOST Indicates that the VTAM LOSTERM EXIT has been scheduled for this node but has not yet been recognized by IMS. At the next interrupt for this node, IMS will interrogate the LOSTERM value. All values, with one exception, result in an immediate CLSDST, or disconnection, from IMS. For the LOSTERM exception, IMS must wait for VTAM to notify IMS (by another LOSTERM) of completion of recovery operation. Indicates an IMS logger's connection to the TMS is gone as a result of TMS or VTAM failure. MESSAGES WAITING Indicates that there are system messages waiting to be sent, which prevents shutdown from completing. MFSTEST, MFST Indicates a terminal, node, or user in MFSTEST mode. MSGS IN QUEUE Indicates that there are messages in the queue for an active terminal. MSG CT Number of messages on the queue for this destination (calculated by subtracting the DEQCT from ENQCT). N/A Indicates that a link is not assigned or a user is signed on to a static terminal, in which case queues are not applicable. NEEDED Indicates the OLDS that needs to be archived. NO ACTIVE CONVERSATION Indicates that there is no active conversation between a logger and a log router. NODE-USR Node name and user identifier. NOIN Indicates a line or terminal stopped for input. NO INPUTTING LINES Indicates no terminal activity. NO LOG ROUTER SG DEFINED Indicates that there is no Log Router Service Group defined to DBRC. NONE Indicates that the OTMA client is not using RACF for security verification. NOOUT Indicates a line or terminal stopped for output. NO OUTPUTTING LINES Indicates no terminal activity. NOQUEUE Indicates a line or terminal that has had message queuing stopped for message switching. NOT CONN No subsystem connection. NOT DEFINED Indicates the OTMA client has left the XCF group. NOT IDENTIFIED Indicates that an IMS logger is not identified to the TMS. Commands, Volume 1: IMS Commands A - M Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning NOTIDLE s Indicates that a logical link is waiting for the completion of a synchronous event. The s represents the following subcodes: A Indicates a status of NOTIDLE-POST, which means that an event has completed but the link has not been dispatched to process it. B Indicates a status of NOTIDLE-IWAIT, which means the link is waiting for completion of internal I/O. Cxx Indicates a status of NOTIDLE-TP WAIT, which means the link is waiting for completion of a TP access method request. The two characters xx indicate the value of the access method operation code. Blanks are displayed if the link is VTAM. For MSC TCP/IP links, xx indicates the following: X'20' A response is owed for a restart request. NOTINIT Indicates a database or program for which directory initialization failed or indicates DMB or PSB pool space not large enough to accommodate blocks. Indicates a TRAN that could not be initialized. NOTOPEN, NOT-OPEN Indicates a database, area, line, terminal, or physical link that is not in open status. This status is not applicable to MSDBs. NOT USABLE Indicates a log data set (OLDS) is unusable because of previous error. NRE Indicates, for a logical link, that link startup processing is not complete. When the link is started, normal restart synchronization will be performed, because the previous link shutdown or IMS restart was normal. OFR Indicates that the database or area is being brought up to the current tracking level with online forward recovery. OLR Indicates that the database has online reorganization in progress OPEN Indicates that the VTAM ACB is open. Indicates an area to be changed or deleted is open. OPNDST Indicates that an OPNDST is in process for this node. OUTBOUND Indicates that the alternate subsystem is APPC-enabled. Also shown on active subsystem when APPC processing cannot start. OUTPUT IN PROGRESS Indicates output in progress for an active terminal. PAGE Indicates an MFS paged message. PERMNT ERR Indicates that there is a permanent error, such as a read error, that prevents a log gap from being filled. PLANNED TAKEOVER IN PROGRESS Indicates all active subsystems being tracked have successfully shut down and the tracker is now in the process of shutting down. PRE-OPEN FAILED Pre-open for ADS failed. Chapter 26. /DISPLAY commands 441 Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning PREV CLSER Indicates that the previous OLDS could not be closed because of an I/O error; therefore, this OLDS is required by the Log Recovery utility to correct the condition. PRI Indicates that this node is the primary partner of an ISC session; or, for a link, indicates that it is the primary partner of an MSC-VTAM session. PRIMARY MSTR Indicates that the terminal is the primary master terminal. PROFILE Indicates that the OTMA client is using values in the Security Data section of the message prefix for a transaction. PRST Indicates that a terminal or user is in preset destination mode. The destination trancode or logical terminal name follows in parentheses. PSB SCHEDULED A program that references a database to be changed or deleted is scheduled. PSTOPPED (PSTO, PSTOP) Indicates a line, terminal, transaction, or logical link that has been pstopped. This status can indicate that a different, necessary resource is unavailable. For example, a transaction could show a status of PSTOP because the associated program is not initialized. PUR, PURGING Indicates a transaction, line, or terminal that is purging all of its output. QCT Number of messages on the queue for this destination (calculated by subtracting the DEQCT from ENQCT). QERR, QERROR Indicates that an I/O error occurred on the queue for this LTERM, or remote transaction (MSC). QLOCK Indicates that the LTERM is locked from sending any further output or from receiving input which could create additional output for the same LTERM until the state is reset by a specific request received on the session. QSTP Indicates that transaction queuing is stopped by online change because the transaction is affected by the online change. Online change might be changing or deleting the transaction, or changing or deleting a program, PSB, database, or DMB referenced by the transaction. Transaction queuing is stopped until the online change is committed or aborted. QUEUING nn Indicates that messages are queued to the transaction to be changed or deleted, and nn is the number of messages queued. QUI Indicates that a VTAM node has sent a VTAM Quiesce-End-of-Chain indicator to suspend IMS output. QUIESCED Indicates one of the following: v The XCF group is stopped. v The node is stopped. v The database is currently quiesced by a previous UPDATE DB START(QUIESCE) or UPDATE AREA START(QUIESCE) command. QUIESCING 442 Commands, Volume 1: IMS Commands A - M Indicates that the database is undergoing quiesce by a previous UPDATE DB START(QUIESCE) or UPDATE AREA START(QUIESCE) command. Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning REBLD-INPROG Indicates that a CQS structure rebuild is in progress for a structure. RECALL Indicates that database or area is in recall. RECD The number of messages that are received from the specified node. For static terminals, this is the number of messages that are received since the last IMS cold start, warm start, or emergency restart. The count is not reset when a static terminal logs off or logs on. For dynamic terminals, this is the number of messages that are received since the current user signed on to the dynamic terminal. The count is reset when a user signs off from the dynamic terminal, and following a cold start, warm start, or emergency restart. RECOVERY Requests the display of recovery values that pertain to the node or user. For the /DISPLAY DB command, indicates that DRF recovery is in progress for that database. RECOVERY-NEEDED, RECOVERN Indicates areas that need recovery. RELREQ (NODE) Indicates that the VTAM RELREQ exit routine has been driven but IMS is waiting for an operation in progress to complete before releasing the node. REP Indicates that IMS is waiting for an OTMA REPresynch command from the client. REQ Indicates that IMS is sending an OTMA REQresynch command to the client. RESP Indicates that the node, line, terminal, or user is in input response mode and the response reply message is available for output or in the process of being sent. RESPINP, RESP-INP Indicates the terminal, line, node, or user is in full-function input response mode and the response mode input is still in-doubt; for example, the response reply message is not available for output. RESP-INP-FP Indicates the terminal, line, node, or user is in Fast-Path input response mode and the response mode input is still in-doubt; for example, the response reply message is not available for output. RESYNC Indicates that the positive acknowledgment for an IMS recoverable output message was not received when the connection with the VTAM node was terminated. This message will be subject to resynchronization when the next connection for this node is attempted. RNL Randomizer is not loaded for a DEDB database. RSF Indicates that a reset request failed for an OTMA REPresynch command. Chapter 26. /DISPLAY commands 443 Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning SCHEDULED Indicates that a conversation, transaction, or program has been received and queued. For a conversation, this status will be displayed from the time an input message is entered until the output message is dequeued. With /DISPLAY MODIFY, indicates that the named resource (a transaction or program to be changed or deleted, or a program referencing a database to be changed or deleted) is scheduled. With /DISPLAY OLDS, indicates that an archive job had been generated. SEC Indicates that this node is the secondary partner of an ISC session; or, for a link, indicates that it is the secondary partner of an MSC-VTAM session. SECOND MSTR Indicates that the terminal is the secondary master terminal. SENDING LOGS Indicates that a logger has an active conversation with a log router and is sending logs to the tracking site. SENT The number of messages that are sent from the specified node. For static terminals, this is the number of messages sent since the last IMS cold start, warm start, or emergency restart. The count is not reset when a static terminal logs off or logs on. For dynamic terminals, this is the number of messages sent since the current user signed on to the dynamic terminal. The count is reset when a user signs off from the dynamic terminal, and following a cold start, warm start, or emergency restart. | | | | 444 SERVER Indicates that the OTMA client is acting as the server. SEVER+FLOOD Indicates that the global flood limit was specified in client descriptor or in the /START TMEMBER ALL INPUT command, and IMS has reached this OTMA global flood limit. SEVERE-ERROR Indicates that ADS encountered a severe error. SHUT Indicates that normal processing has completed for the node and a VTAM shutdown-complete indicator was returned to IMS. The node can receive IMS output but cannot enter data while in this state. SHUTDOWN-STRCHKPT Indicates that CQS will take a structure checkpoint during normal shutdown. SIGN Indicates that a terminal or user is signed on to a node under enhanced security. The user signed on to the node is shown in parentheses following SIGN. SIMLOGON Indicates that a logon to IMS has been simulated. SMQ BACKEND Indicates that the member does not connect to any OTMA client and is used only for shared queues back-end processing. SPND Indicates that a transaction had messages on the suspend queue. /STA ACTIVE A /START DB command is in progress for a database to be changed or deleted. Commands, Volume 1: IMS Commands A - M Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning STARTING Shown after /DIS CONV is issued and before the status is set to SCHEDULED. Indicates that a conversation has been received but is not eligible for scheduling to an application program until an end-of-message indication is received. Also shown after /START APPC is issued and before the status is set to ENABLED or FAILED. STATIC Indicates that the node, LTERM, or user was defined during system definition. STOP IN PROGRESS Indicates a /STOP SUBSYS command is in progress. STOPPED, STO, STOP Indicates an area, line, LTERM, LU name, node, terminal, user, OLDS, subsystem, transaction, routing code (RTCODE), OTMA client, program, or database that is stopped. Indicates that a subsystem connection is stopped. Indicates a /STOP SERVGRP command was issued. Indicates that a transaction pipe is stopped. STO-INP Indicates that the terminal is stopped with input messages enqueued to the LU name. STO-OUTP Indicates that the terminal is stopped with output message enqueued to the LU name. STRCHKPT-INPROG Indicates that a CQS structure checkpoint is in progress for a structure. SUBSYSTEM XXXX NOT DEFINED BUT RECOVERY OUTSTANDING Indicates that the subsystem was not defined but IMS has outstanding recovery elements. SUSPENDED Indicates that the transaction has been suspended. For /DISPLAY MODIFY, indicates that the transaction to be changed or deleted is on the suspend queue. SUSPENDED LOGS Indicates that a logger has an active conversation with a log router but has suspended sending logs to the tracking site because of resource shortage. The conversation is still intact. SYNCHRONIZING, SYN Indicates that the alternate subsystem is processing a /CHE SNAPQ command from the active subsystem. Indicates that a transaction pipe is being synchronized. SYS CONSOLE Indicates that the terminal is the system console. TAKEOVER IN PROGRESS Indicates that the alternate subsystem is taking over workload from the active subsystem. TAKEOVER REQUESTED Indicates that the active subsystem has requested a takeover by the alternate subsystem. TBR Indicates that IMS is waiting for an OTMA TBResynch command from the client. TERM IN PROGRESS Indicates an internal termination of the subsystem. TERMINATING Indicates that the application program is being terminated. TEST Indicates a line, node, terminal, or user in test mode. TKOTRA Indicates that a node, line, link, or terminal in an XRF session is to be traced only during takeover, to help diagnose XRF terminal switch problems. TMP Indicates that a transaction pipe is temporary. Chapter 26. /DISPLAY commands 445 Table 226. Attributes and status in the /DISPLAY command (continued) | | | | | 446 Status or attribute Meaning TRA Indicates that the physical terminal, node, logical link, LU name, transaction, program, or transaction pipe is being traced. TRACKING Indicates that the XRF alternate subsystem is tracking the active subsystem or an RSR tracking subsystem is tracking one or more active subsystems. UNAVAILABLE, UNAVAIL Indicates an ADS that is unavailable. Indicates that a region is unavailable because an application is using it, even though the application is not currently scheduled. The region is not available to any other application for use. Indicates that there are no records of a log gap at the active site; these records may have been deleted. Indicates that a coupling facility structure is not available for use by IMS. UNKNOWN Indicates the XCF group has an unknown status. UNPLANNED TAKEOVER IN PROGRESS Indicates an /RTAKEOVER command was entered on the tracking subsystem and an unplanned takeover is in progress. USTOP, USTOPPED Indicates that scheduling of transactions has been stopped because of unavailable data. UNSUPPORTED The APPC/OTMA shared queues enablement is not supported for this member. This status applies only to the local status. The IMS system has been started with AOS=N or AOS=F and RRS=N. This IMS system will never be able to support the APPC/OTMA shared queues enablement. VIR Indicates that the DEDB area has the VSO option. Commands, Volume 1: IMS Commands A - M Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning WAIT cond Indicates that the application program is waiting for the completion of an event. The cond represents the reason for waiting. The cond can be: AOI indicates that an AO application issued a GMSG call with the wait option specified, but there are no messages for the application to retrieve. BLOCKMOVER or BLKMVR indicates that an application control block cannot be loaded because the ACB block mover is busy. The application might be waiting in the block mover because of an IRLM failure. CMD/PENDING indicates that a /DBD command or a /DBR command is in progress. INPUT indicates that the application program is in wait-for-input (WFI) mode. INTENT or INTENT/POOL indicates one of two conditions: 1. The application program's intent for a database conflicts with the use of the database by a scheduled program. 2. A temporary shortage of DMB, PSB, of PSB work area pool space exists. I/O PREVEN indicates that a BMP region which accesses a GSAM database cannot schedule until I/O prevention has completed. MESSAGE indicates that the application program is in a pseudo wait-for-input mode. The application is scheduled and is waiting for a message. POOLSPACE or POOLSP indicates a temporary shortage of DMB, PSB, or PSB work area pool space exists. SWITCHOVER or SWITCH indicates that the alternate system is tracking the active system. SYNCPOINT indicates that the application in the region is now in sync point. WAIT-EPCB POOL indicates that there is a temporary shortage of EPCB pool space. WAIT-RRS/OTMA PC A program has a protected conversation with an OTMA client. WAIT BID Indicates that the OTMA client is processing a Client-Bid request. WAITING Indicates that the MPP region is waiting for work. Indicates a log gap is not being filled yet. Chapter 26. /DISPLAY commands 447 Table 226. Attributes and status in the /DISPLAY command (continued) Status or attribute Meaning WAIT RESPONSE Indicates that the OTMA client is processing a message and is waiting for a response from the server. WRTERR Indicates a write I/O error on the OLDS or a database. Related tasks: Setting DEADQ status time with the DLQT parameter (Communications and Connections) /DISPLAY ACT command Use the /DISPLAY ACT command to display region and DC information associated with an IMS system. The region is scheduled to an application program and the IMS resources are assigned. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 449 v “Output fields” on page 449 v “Examples” on page 456 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 227. Valid environments for the /DISPLAY ACT command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X ACT X X X DC X REGION X X X X Syntax /DISPLAY /DIS ACT DC REGION Keywords The following keywords are valid for the /DISPLAY ACT command: DC 448 Displays only the DC subset of the output. The DC portion of the display can include: Commands, Volume 1: IMS Commands A - M v The status of active VTAM ACBs. If MNPS is used for XRF, then both the APPLID ACB and the MNPS ACB are displayed. If MNPS is not active, only the APPLID ACB displays. v User variable (USERVAR) name if using an XRF. If MNPS is active, USERVAR is invalid and is not displayed. Instead, the MNPS ACB name is displayed. v VTAM generic resource name (GRSNAME) and its current status. v The APPC IMS LU name, the APPC connection status, and the APPC timeout value. v The APPC/OTMA SHARED QUEUE status, the number of RRS TCBs attached and the number of AWEs (work-elements) queued to the RRS TCBs. v OTMA status. v The TCP/IP generic resources GENIMSID value and status. v The number of active LINES receiving input or sending output. v The number of active NODES receiving input or sending output. v The number of active LINKS (half sessions) receiving input or sending output. REGION Displays only the REGION subset of the output. The display consists of active regions. Usage notes When you issue the /DISPLAY ACT command from a specific environment, such as DCCTL, only the information that is valid for that environment is displayed. ACTIVE-XCF, ACTIVE-RRS, and ACTIVE-RRS/XCF have similar values for local and global status. FORCE-RRS/XCF The global status is ACTIVE-XCF because FORCE is a local status. ACTIVE-RRS Both the local and global status is changed to INACTIVE if RRR becomes unavailable. ACTIVE-RRS/XCF Both the local and global status is changed to ACTIVE-XCF if RRS becomes unavailable. Output fields If /DISPLAY ACT command is issued, the output for both DC and REGION is displayed. The following output fields are displayed for the /DISPLAY ACT DC command, and also for the /DISPLAY ACT command (no DC or REGION keyword specified): OTMA GROUP Status of the IMS Open Transaction Manager Access (OTMA) group. The status can be either ACT or NOTACTIVE. Only one OTMA group can be active at one time. Chapter 26. /DISPLAY commands 449 VTAM ACB The status of the VTAM ACB, which can be OPEN, CLOSE PENDING, or CLOSED. The status of LOGONS can be ENABLED or DISABLED. The base IMS LU name and the current APPC connection status are shown if IMS is running with an APPC/MVS-capable operating system. The following are displayed for the VTAM ACB: APPLID= The application identification name for IMS. If MNPS is used with XRF, then it is the APPLID ACB. USERVAR= The user name for IMS. Only applicable for XRF-capable or RSR-capable systems. GRSNAME= The VTAM generic resource name. Displayed as blanks if no generic resource name exists. Restriction: IMS displays either the USERVAR or the GRSNAME. For non-XRF or non-RSR subsystems (no USERVAR specified), IMS displays the GRSNAME, which can be blank. If the IMS system is XRF, the following fields are appended to the date/time stamp: RSEname Recoverable service element name System ACT or BACKUP MNPS= The MNPS ACB name if MNPS is used for XRF. QUEUED RRSWKS The number of RRS requests (work elements) currently queued to the RRS TCBs. The work elements might be queued to the RRS TCBs for work from the APPC or OTMA shared message queue function. STATUS Status can be one of the following: AWAITING SNAPQ Alternate system awaiting SNAPQ checkpoint from active SYNCHRONIZING Alternate system processing SNAPQ checkpoint TRACKING Alternate system is in process of tracking active system TAKEOVER REQUESTED Alternate system requests a takeover TAKEOVER IN PROGRESS Alternate system in process of taking over workload from active I/O TOLERATION New active system in I/O toleration phase of processing prior to becoming a true active system 450 Commands, Volume 1: IMS Commands A - M TCPIP_GENIMSID The generic IMS ID that is used to participate in an MSC TCP/IP generic resource group. The value shown is the value specified on the GENIMSID parameter of the IMS DFSDCxxx member of the IMS.PROCLIB data set. TCP/IP generic resources enable remote MSC systems to connect to an IMSplex without having to specify a specific IMS system. If TCPIP_GENIMSID displays a value, then the following STATUS field displays ACTIVE. If no value is shown, then the STATUS field displays DISABLED. STATUS Displays ACTIVE or DISABLED depending on whether a value is displayed in the TCPIP_GENIMSID field. The following output fields are displayed for the /DISPLAY ACT REGION command, and also for the /DISPLAY ACT command (no DC or REGION keyword specified): | | END TIME The time at which IMS will end this synchronous program switch request. REGID Region identifier. For DBCTL, the thread number is displayed. JOBNAME The name of the job processing in the region. If no regions of that type exist, the job name is set to MSGRGN, FPRGN, BATCHRGN, or DBTRGN, depending on the region type. DBTRGN is only displayed for systems that support DBT threads. DBTRGN, BATCHRGN, or FPRGN is displayed for DBCTL. TYPE Type of application program processing in the region, or type of region. BMH, BMP, DBRC, DBT, DLS, and FPU are displayed for DBCTL. The following region/program types can be displayed: BMH HSSP processing BMP Batch message processing BMPE Batch message processing for an external subsystem thread DBRC DBRC address space DBT DBCTL thread DLS DL/I address space FP Fast Path FPE Fast Path processing for an external subsystem FPM Fast Path message-driven program FPME Fast Path message-driven program for an external subsystem thread FPU Fast Path utility program FPUE Fast Path utility program for an external subsystem thread TP Teleprocessing TPE Message-driven program for an external subsystem thread Chapter 26. /DISPLAY commands 451 TPI Transaction Program Instance. A CPI Communications driven transaction is running in the region TRAN The name of the target transaction in the request data of a DL/I ICAL request that initiated a synchronous program switch. | | TRAN/STEP Transaction code being processed by region, or NONE, if there are no regions of that type. PROGRAM Name of the program processing in the region. DFSCPIC is displayed for CPI Communications driven transaction programs that have not issued a DL/I APSB call to allocate a PSB. For DBCTL, SB name is displayed. STATUS Status of the region, which can be one of the following: ACTIVE-RRS The z/OS Resource Recovery Services (RRS) enablement is active. The synchronous transaction inputs from APPC/OTMA with sync levels of NONE, CONFIRM, and SYNCPT with the RRS indicator are queued onto the shared queue. This status is equivalent to the existing status of ACTIVE and is for a setting combination of AOS=Y and RRS=Y. ACTIVE-XCF The z/OS cross-system coupling facility (XCF) enablement is active. The synchronous transaction inputs from APPC/OTMA with sync levels of NONE and CONFIRM with the XCF indicator are queued onto the shared queue. This status is for either AOS=X or a setting combination of AOS=B and RRS=N. ACTIVE-RRS/XCF The RRS enablement and the XCF enablement are both active. The synchronous transaction inputs from APPC/OTMA with sync level of SYNCPT with the RRS indicator are queued onto the shared queue. The synchronous transaction inputs with sync level of NONE and CONFIRM with the XCF indicator are queued onto the shared queue. This status is for a setting combination of AOS=B and RRS=Y. ACTIVE-DBCMD A /DBD, /DBR, UPD DB STOP(ACCESS), or UPDATE DB STOP(UPDATES) command is in progress and waiting for the region to terminate before the command can complete. AVAILABLE The active threads are available. The region is available to schedule an application. FORCE-RRS The synchronous transaction inputs with sync levels of NONE, CONFIRM, and SYNCPT with the RRS indicator are queued onto the shared queue (without any affinity). This status is equivalent to the existing status of FORCE where AOS=F is specified. 452 Commands, Volume 1: IMS Commands A - M FORCE-RRS/XCF The synchronous transaction inputs with sync level of SYNCPT with the RRS indicator are queued onto the shared queue (without any affinity). The XCF enablement is also active. The synchronous transaction inputs with sync levels of NONE and CONFIRM with the XCF indicator are queued onto the shared queue. This status is equivalent to the combination of the existing status of FORCE where AOS=F is specified and the new status ACTIVE-XCF. The status is for a setting combination of AOS=S. It is equivalent to the combination of the existing status of FORCE where AOS=F is specified and the new status ACTIVE-XCF. OLR-RUNNING The region is an IMS system-created BMP region to process the HALDB online reorganization (HALDB OLR) for the partition name. For those regions that have OLR running, the region type is BMP, the job name is the DBD name, the transaction name is the partition name, and the program name is the partition name with a suffix of 0. | | | | | | OLR-ALTER-INPROG The region is an IMS system-created BMP region to process the OLR-ALTER for the HALDB database. For those regions that have OLR-ALTER in progress, the region type is BMP, the job name is the DBD name, the transaction name is the partition name, and the program name is the partition name with a suffix of 0. SCHEDULING The application program is being scheduled. TERMINATING A dependent region or application program is being terminated. TERM-ABDUMP IN-P A /STOP REGION ABDUMP command has been issued, an SRB has been scheduled for the region, and abnormal termination is in progress. TERM-ABDUMP PEND A /STOP REGION ABDUMP command has been issued, but an abnormal termination SRB has not been scheduled because the region is in an ineligible state. TERM-ABDUMP SCHD A /STOP REGION ABDUMP command has been issued and an abnormal termination SRB has been scheduled for the region. TERM-BCKOUT IN-P Abnormal termination is in progress and backout processing has been initiated. TERM-THREAD TERM Region termination is in progress. For abnormal termination, either a /STOP REGION ABDUMP command was issued or the region encountered an error and terminated independently. For normal termination, either a /STOP REGION command was issued or the application program completed and terminated independently. Chapter 26. /DISPLAY commands 453 TERM-WAIT SYNCPT Region termination is in progress and the application in the region is in the sync point. When a dependent region is found in this state, a continuation line is inserted into the display, which shows the recovery unit ID (URID) and the originating IMS system ID (ORIGIN) that are associated with the transaction processing in the dependent region. TERM-WAIT RRS Region termination is in progress and the application in the region is in the sync point. This status is displayed when an application has a protected conversation with an OTMA client that is processing a sync point. The sync point can continue after the OTMA client issues either an SRRCMIT or SRRBACK call. This status is also displayed when the application program is part of a cascaded family and is processing a sync point. RRS cascaded transaction support is used by APPC/OTMA SMQ enablement to synchronize the back-end and front-end systems. When a dependent region is found in this state, a continuation line is inserted into the display, which shows the recovery unit ID (URID) and the originating IMS system ID (ORIGIN) that are associated with the transaction processing in the dependent region. UNAVAILABLE An active DBT thread is unavailable. An application is using the region, even though the application is not currently scheduled. This region is therefore not available to any other application. WAIT-AOI An AO application issued a GMSG call with the WAITAOI subfunction specified, but there are no messages for the AO application to retrieve. WAIT-BLOCKMOVER An application control block cannot be loaded because the ACB block mover is busy. The application might be waiting in the block mover because of an IRLM failure. WAIT-CALLOUT The application program in the region is waiting for a response to a synchronous callout or synchronous program switch message. | | | | | | | When a dependent region is found in this state and is waiting for a synchronous callout message, a continuation line is inserted into the display, which shows the target member (TMEM) and the transaction pipe (TPIPE) that are associated with the transaction processing in the dependent region. | | | | | When the dependent region is waiting for a synchronous program switch message, the continuation line displays the target transaction code and when the synchronous program switch request will time out. The time value is in the format YYDDD/HHMMSS. WAIT-CMD/PENDING A /DBDUMP, /DBRECOVERY, or /START command is in progress. 454 Commands, Volume 1: IMS Commands A - M The status of the MPP region continues to show WAIT-CMD/PENDING until the command completes and the region is rescheduled. To clear a WAIT-CMD/PENDING status without rescheduling the MPP region, issue a /STA DB command against one of the databases in the intent list for the PSB used by the MPP region that failed to initially schedule. Issuing this command drains the scheduler subqueue (SUBQ) 4 and posts all PSTs there, including any suspended MPP regions. WAIT-EPCB POOL A temporary shortage of EPCB pool space exists. WAITING The MPP region is waiting for work. WAIT-INPUT The application program is in WAIT-FOR-INPUT (WFI) mode. WAIT-INTENT The application program's intent for a database conflicts with the use of the database by a scheduled program. WAIT-INTENT/POOL Indicates either the application program's intent for a database conflicts with the use of the database by a scheduled program, or a temporary shortage of DMB, PSB, or PSB work area pool space exists. WAIT-INTENT SCHD The IMS transaction scheduler detected an application scheduling intent failure. (For example, Load Balancing.) WAIT-I/O PREVEN A BMP region that accesses a GSAM database cannot schedule until I/O prevention has completed. WAIT-MESSAGE The application program is in a pseudo WAIT-FOR-INPUT (WFI) mode. The application is scheduled and is waiting for a message. WAIT-POOLSPACE A temporary shortage of DMB, PSB, or PSB work area pool space exists. WAIT-QSC The application program (BMP, MPP, IFP, or DBCTL) is waiting for the quiesced state of a database that it tries to access to be released. WAIT-RRS PC The application program has a protected conversation with an OTMA client that is processing a sync point. The sync point can continue after the OTMA client issues either an SRRCMIT or SRRBACK call. Or, the application program is part of a cascaded family and is processing a sync point. APPC/OTMA SMQ Enablement uses RRS cascaded transaction support to synchronize the back-end and the front-end system. When a dependent region is found in this state, a continuation line is inserted into the display, which shows the recovery unit ID (URID) and the originating IMS system ID (ORIGIN) that are associated with the transaction processing in the dependent region. Chapter 26. /DISPLAY commands 455 WAIT-SWITCHOVER The alternate system is tracking the active system. WAIT-SYNCPOINT The application in the region is now in SYNC POINT. When a dependent region is found in this state, a continuation line is inserted into the display, which shows the recovery unit ID (URID) and the originating IMS system ID (ORIGIN) that are associated with the transaction processing in the dependent region. WAIT-XCF The application program has a standard conversation with an APPC or OTMA client that is processing a sync point. The sync point can continue after the client issues either a positive acknowledgment (ACK) or a negative acknowledgment (NAK). The APPC/OTMA SMQ enablement uses XCF to communicate between the back-end and the front-end IMS systems. A standard conversation is indicating a synchronous SQ transaction with sync level of NONE or CONFIRM. TERM-WAIT XCF Region termination is in progress and the application in the region is in the sync point. This status is displayed when an application program has a standard conversation with an APPC or OTMA client that is processing a sync point. The sync point can continue after the client issues either an ACK or NAK. The APPC/OTMA SMQ enablement uses XCF to communicate between the back-end and front-end IMS systems. When a dependent region is found in this state, a continuation line is inserted into the display. This line shows either the target member (TMEM) and the transaction pipe (TPIPE) for an OTMA client, or the network ID (NETWORKID) and the logic unit name (LUNAME) for an APPC client, and the originating IMS system ID (ORIGIN) that is associated with the transaction processing in the dependent region. TMEM A 1- to 16-alphanumeric character that displays the OTMA client target member. TPIPE A 1- to 8-alphanumeric character that displays the OTMA output message destination. LUNAME A 1- to 8-alphanumeric character NETWORK ID concatenated with a 1- to 8-alphanumeric character LU name. CLASS One of the classes associated with the region. The region can have from one to four classes, whose values range from 1 to 999. Examples The examples of the /DISPLAY ACTIVE command are organized into the following three sections: v “Examples of /DISPLAY ACTIVE” on page 457 v “Examples of /DISPLAY ACTIVE DC” on page 460 456 Commands, Volume 1: IMS Commands A - M v “Examples of /DISPLAY ACTIVE REG” on page 463 The following are examples of the /DISPLAY ACT command. Examples of /DISPLAY ACTIVE The following series of examples show the output of the /DISPLAY ACTIVE command for various configuration scenarios. Example 1 for /DISPLAY ACT command Entry ET: /DISPLAY ACT Response ET: REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS MSGRGN TP NONE BATCHREG BMP NONE FPRGN FP NONE DBTRGN DBT NONE 1 IMSMPP0 TPE DSN8PS DSN8IP13 BATCHREG BMP NONE FPRGN FP NONE DBR3CTA3 DBRC DLI3CTA3 DLS VTAM ACB OPEN -LOGONS ENABLED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 4 LINK ACTIVE-IN 0 ACTIV-OUT 0 *89041/163619* CLASS 1, 3 Example 2 for /DISPLAY ACT command Entry ET: /DISPLAY A Response ET: REGID JOBNAME 1 I3YMPP BATCHREG FPRGN DBRC VTAM ACB CLOSED APPLID=APPL8 TCPIP_GENIMSID= LINE ACTIVE-IN NODE ACTIVE-IN *11041/100117* TYPE TRAN/STEP PROGRAM TP BMP NONE FP NONE DBRC STATUS WAITING CLASS 4, 1, 2, 3 CLASS 1, 3, 6, 7 GRSNAME= STATUS=DISABLED STATUS=DISABLED 1 ACTIV-OUT 0 0 ACTIV-OUT 0 Example 3 for /DISPLAY ACT command Entry ET: /DISPLAY A Response ET: REGID JOBNAME 2 I431MPP 3 IMS1BMP TYPE TRAN/STEP PROGRAM STATUS TP SKS7 DFSDDLT7 BMP REGION SIS04P01 Chapter 26. /DISPLAY commands 457 1 I431IFP FPM TXCDRN07 DDLTRN07 R3 DBRC VTAM ACB OPEN -LOGONS ENABLED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 2 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *11041/144425* DFSRSENM ACTIVE Explanation: The system is XRF capable so the date time stamp includes the RSE name and system indicator. Example 4 for /DISPLAY ACT command Entry ET: /DISPLAY A Response ET: REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS 1 I431MPP TP TXCDRN18 DDLTRN18 WAIT-INPUT BATCHREG BMP NONE 2 I431IFP FPM NO MSG. DDLTRN07 R3 DBRC VTAM ACB OPEN -LOGONS ENABLED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINE ACTIVE-IN 0 ACTIV-OUT 0 *11041/132348* DFSRSENM ACTIVE CLASS 1, 3, 6, 7 Explanation: Transaction TXCDRN18 is waiting for an input message. Program DDLTRN07 currently has no messages to process. Region 1 is in WAIT-FOR-INPUT (WFI) mode. Example 5 for /DISPLAY ACT command Entry ET: /DISPLAY A Response ET: REGID 2 3 1 JOBNAME TYPE TRAN/STEP PROGRAM STATUS I431MPP TP SKS7 DFSDDLT7 WAIT-MESSAGE IMS1BMP BMP REGION SIS04P01 I431IFP FPM TXCDRN07 DDLTRN07 R3 DBRC VTAM ACB OPEN -LOGONS ENABLED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 2 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *11041/144425* DFSRSENM ACTIVE CLASS 1, 3, 6, Explanation: Transaction SKS7 is waiting for an input message. Program DFSDDLT7 currently has no messages to process. Region 2 is in Pseudo Wait-For-Input (PWFI) mode. Example 6 for /DISPLAY ACT command 458 Commands, Volume 1: IMS Commands A - M 7 Entry ET: /DISPLAY A Response ET: ** SUBSYSTEM NAME ** SYS3 REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS CLASS 2 I431MPP TP SKS7 DFSDDLT7 WAIT-MESSAGE 1,3,6,7 3 IMS1BMP BMP REGION SIS04P01 1 I431IFP FPM TXCDRN07 DDLTRN07 R3 DBRC VTAM ACB OPEN -LOGONS ENABLED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN2 ACTIV-OUT0 NODE ACTIVE-IN0 ACTIV-OUT0 LINK ACTIVE-IN0 ACTIV-OUT0 *11041/144425* DFSRSENM ACTIVE Explanation: Transaction SKS7 is waiting for an input message. Program DFSDDLT7 currently has no messages to process. Region 2 is in Pseudo Wait-For-Input (WPFI) mode. Example 7 for /DISPLAY ACT command Entry ET: /DISPLAY ACTIVE Response ET: REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS CLASS 1 IMSMPPA TPI TPN1 DFSCPIC WAIT-BLOCKMOVER 20, 22, 24, 2 IMSMPPB TPI TPN2 DFSCPIC 21, 23, 25, 3 IMSMPPC TP TPN3 SAAPSB1 28, 29, 24, 4 IMSMPPD TPI TPN4 DFSCPIC WAIT-SYNCPOINT 14, 15, 16, 4 IMSMPPE TP TRAN1 LU2PGMA WAIT-INPUT 2, 4, 6, 5 IMSMPPF TP TRAN2 LU2PGMB 1, 3, 5, VTAM ACB OPEN / APPC LUNAME=IMSLUNME ENABLED -LOGONS ENABLED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 2 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *90332/114253* 26 22 23 17 8 7 Example 8 for /DISPLAY ACT command Entry ET: /DISPLAY ACTIVE Response ET: REGID JOBNAME MSGRGN BATCHREG FPRGN DBTRGN DBRSCHA5 DLISCHA5 VTAM ACB OPEN IMSLU=N/A.N/A APPLID=APPL8 TCPIP_GENIMSID= TYPE TP BMP FP DBT DBRC DLS TRAN/STEP PROGRAM NONE NONE NONE NONE STATUS -LOGONS DISABLED APPC STATUS=DISABLED USERVAR=IMS1 STATUS=DISABLED CLASS TIMEOUT= 0 Chapter 26. /DISPLAY commands 459 LINE ACTIVE-IN 1 ACTIV-OUT NODE ACTIVE-IN 0 ACTIV-OUT LINK ACTIVE-IN 0 ACTIV-OUT *11080/183050* DFSRSENM ACTIVE 0 0 0 Explanation: The IMS subsystem is both XRF-capable and RSR-capable. Example 9 for /DISPLAY ACT command Entry ET: /DISPLAY ACTIVE Response ET: REGID 1 2 4 3 2 JOBNAME IMSMPPA IMS1BMP IMS2BMP I510MPP IMS3BMP TYPE TRAN/STEP PROGRAM STATUS CLASS TP WAITING 4, 1, 2 BMP REGION SIS04P01 WAIT-AOI BMP REGION SIS04P02 WAIT-AOI TP WAIT-EPCB POOL 8, 8, BMP WAIT-EPCB POOL 8, 8 FPRGN FP NONE DBRC DBRC VTAM ACB CLOSED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 *11280/095345* Example 10 for /DISPLAY ACTIVE command Entry ET: /DISPLAY ACTIVE Response ET: REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS CLASS 1 I431MPP TP TERMINATING 1, 2, 3, 4 BATCHREG BMP NONE 2 I431IFP FPM NO MSG. DDLTRN07 R3 DBRC VTAM ACB OPEN -LOGONS ENABLED APPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN - 1 ACTIV-OUT - 0 NODE ACTIVE-IN - 0 ACTIV-OUT - 0 LINE ACTIVE-IN - 0 ACTIV-OUT - 0 *11041/132348* DFSRSENM ACTIVE Explanation: MPP region I431MPP is in the process of terminating because of a /STOP REGION command. Region 1 is in TERMINATING mode. Examples of /DISPLAY ACTIVE DC The following series of examples show the output of the /DISPLAY ACTIVE DC command for various configuration scenarios. Example 1 for /DISPLAY ACTIVE DC command Entry ET: 460 Commands, Volume 1: IMS Commands A - M /DISPLAY ACTIVE DC Response ET: VTAM STATUS AND ACTIVE DC COUNTS VTAM ACB OPEN -LOGONS ENABLED IMSLU=SYS1.IMSLUNME STATUS=ENABLED APPLID=APPL8 USERVAR=IMS1 TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 2 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *11232/114253* Example 2 for /DISPLAY ACTIVE DC command Entry ET: /DISPLAY ACTIVE DC Response ET: VTAM STATUS AND ACTIVE DC COUNTS VTAM ACB CLOSED -APPLID ACB VTAM ACB OPEN -LOGONS ENABLED -MNPS ACB IMSLU=N/A.N/A APPC STATUS=DISABLED TIMEOUT= 0 OTMA GROUP=N/A STATUS=NOTACTIVE APPC/OTMA SHARED QUEUE STATUS - LOCAL=INACTIVE GLOBAL=INACTIVE APPC/OTMA RRS MAX TCBS - 2 ATTACHED TCBS - QUEUED RRSWKS - 0 N APPLID=APPL8 GRSNAME= STATUS=DISABLED MNPS=APPL1 TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *11069/143346* DFSRSENM ACTIVE Explanation: An XRF system is using MNPS. The MNPS ACB is APPL1, which is open and is accepting logons. The APPLID ACB is APPL8, but it is closed. Example 3 for /DISPLAY ACTIVE DC command Entry ET: /DISPLAY ACTIVE DC Response ET: DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I VTAM STATUS AND ACTIVE DC COUNTS VTAM ACB OPEN -LOGONS DISABLED IMSLU=N/A.N/A APPC STATUS=DISABLED TIMEOUT= 0 OTMA GROUP=N/A STATUS=NOTACTIVE APPC/OTMA SHARED QUEUE STATUS - LOCAL=ACTIVE-XCF GLOBAL=ACTIVE-XCF APPC/OTMA SHARED QUEUES LOGGING=Y APPC/OTMA RRS MAX TCBS - 40 ATTACHED TCBS 1 QUEUED RRSWKSAPPLID=APPL8 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *09039/142037* IMS1 0 Example 4 for /DISPLAY ACTIVE DC command showing TCP/IP generic resources Chapter 26. /DISPLAY commands 461 Two examples of the /DISPLAY ACT DC command are shown here. The first example is issued on an IMS system within a TCP/IP generic resource group. The second example is issued on the remote partner IMS system that is connects to the TCP/IP generic resource group. Entry ET in the TCP/IP generic resource group: /DISPLAY ACTIVE DC Response ET in the TCP/IP generic resource group: VTAM STATUS AND ACTIVE DC COUNTS VTAM ACB OPEN -LOGONS ENABLED IMSLU=N/A.N/A APPC STATUS=DISABLED TIMEOUT= 0 OTMA GROUP=N/A STATUS=NOTACTIVE APPC/OTMA SHARED QUEUE STATUS - LOCAL=INACTIVE GLOBAL=INACTIVE APPC/OTMA SHARED QUEUES LOGGING=N APPC/OTMA RRS MAX TCBS 40 ATTACHED TCBS 1 QUEUED RRSWKS- 0 APPLID=L6APPL3 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID=IMS STATUS=ACTIVE LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *11130/230804* Entry ET in the partner of a TCP/IP generic resource group: /DISPLAY ACTIVE DC Response ET in the partner of a TCP/IP generic resource group: VTAM STATUS AND ACTIVE DC COUNTS VTAM ACB OPEN -LOGONS ENABLED IMSLU=N/A.N/A APPC STATUS=DISABLED TIMEOUT= 0 OTMA GROUP=N/A STATUS=NOTACTIVE APPC/OTMA SHARED QUEUE STATUS - LOCAL=INACTIVE GLOBAL=INACTIVE APPC/OTMA SHARED QUEUES LOGGING=N APPC/OTMA RRS MAX TCBS 40 ATTACHED TCBS 1 QUEUED RRSWKS0 APPLID=L6APPL1 GRSNAME= STATUS=DISABLED TCPIP_GENIMSID= STATUS=DISABLED LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *11130/231519* Example 5 for /DISPLAY ACTIVE DC command showing TCP/IP generic resources with XRF The following example shows the output of the /DISPLAY ACT DC command for a system that is participating in both an XRF complex and in an MSC TCP/IP generic resource group. In the example, the use of XRF is indicated by the presence of the USERVAR field and the DFSRSENM field. The use of TCP/IP generic resources is indicated by a non-blank value on the TCPIP_GENIMSID field and a status of ACTIVE. Entry ET in the TCP/IP generic resource group: /DISPLAY ACTIVE DC Response ET in the TCP/IP generic resource group: DFS000I DFS000I DFS000I DFS000I 462 VTAM STATUS AND ACTIVE DC COUNTS VTAM ACB OPEN -LOGONS ENABLED IMSLU=N/A.N/A APPC STATUS=DISABLED OTMA GROUP=N/A STATUS=NOTACTIVE Commands, Volume 1: IMS Commands A - M TIMEOUT= 0 DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I APPC/OTMA SHARED QUEUE STATUS - LOCAL=UNSUPPORTED GLOBAL=INACTIVE APPC/OTMA SHARED QUEUES LOGGING=N APPC/OTMA RRS MAX TCBS - 40 ATTACHED TCBS 2 QUEUED RRSWKSAPPLID=APPL8 USERVAR=IMS1 TCPIP_GENIMSID=IMS STATUS=ACTIVE LINE ACTIVE-IN 1 ACTIV-OUT 0 NODE ACTIVE-IN 0 ACTIV-OUT 0 LINK ACTIVE-IN 0 ACTIV-OUT 0 *11201/163416* DFSRSENM ACTIVE 0 Examples of /DISPLAY ACTIVE REG Example 1 for /DISPLAY ACTIVE REG command Entry ET: /DISPLAY ACTIVE REG Response ET: REGID JOBNAME 2 MPPI3 1 MPPI2 JMPRGN 3 BMPI4 JBPRGN FPRGN DBTRGN DBRICSAK DLIICSAK *08030/132621* TYPE TRAN/STEP PROGRAM TP SHF1 PMVAPZ12 TP NQF1 PMVAPZ12 JMP NONE IMS1 BMP PMVAPZ12 JBP NONE IMS1 FP NONE IMS1 DBT NONE IMS1 DBRC DLS IMS1 IMS1 STATUS CLASS WAIT-QSC 1, 2, WAIT-QSC 1, 2, WAIT-QSC IMS1 3, 4 3, 4 IMS1 IMS1 Explanation: The status of MPPI2, MPPI3, and BMPI4 transactions are shown as WAIT-QSC, which indicates that the database that these transactions are trying to access are in quiesce state and that the transactions are waiting for the UPDATE STOP(QUIESCE) command to be issued to release the quiesce. Example 2 for /DISPLAY ACTIVE REG command Entry ET: /DISPLAY ACTIVE REG Response ET: REGID JOBNAME 1 MPP1A TYPE TP TMEM: JMPRGN JMP JBPRGN JBP BATCHREG BMP FPRGN FP DBTRGN DBT DBRZCSAJ DBRC DLIZCSAJ DLS *08235/173441* TRAN/STEP PROGRAM STATUS APOL11 APOL1 WAIT-CALLOUT HWS1 TPIPE: TPIPE1 NONE NONE NONE NONE NONE CLASS 1 Explanation: Message processing program APOL1 is processing transaction APOL11, which is waiting for a response to a synchronous callout request (WAIT-CALLOUT) from transaction pipe TPIPE1. Example 3 for /DISPLAY ACTIVE REG command Entry ET: Chapter 26. /DISPLAY commands 463 /DISPLAY ACTIVE REG Response ET: REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS JMPRGN JMP NONE IMS1 1 IMSMPPA TPI APOL11 IMS1 APOL1 URID: C2D6B6917DE820000000000001010000 ORIGIN: IMS2 2 IMSMPPB TPI APOL12 IMS1 APOL1 URID: C2D6B6917DE830000000000001010000 ORIGIN: IMS2 3 IMSMPPB TPI APOL13 IMS1 APOL1 TMEM: HWS1 TPIPE: CLIENT01 ORIGIN: IMS2 4 IMSMPPB TPI APOL14 IMS1 APOL1 LUNAME: IMSNETWK.LU62IMS1 ORIGIN: IMS2 JBPRGN JBP NONE IMS1 BATCHREG BMP NONE IMS1 FPRGN FP NONE IMS1 DBTRGN DBT NONE IMS1 DBRICTAB DBRC DLISDEP DLS IMS1 *09039/154931* CLASS WAIT-RRS/PC TERM-WAIT RRS WAIT-XCF IMS1 1,2,3,4 1,2,3,4 1,2,3,4 TERM-WAIT XCF 1,2,3,4 IMS1 | Example 4 for /DISPLAY ACTIVE REG command | | Entry ET: | | | | | | | | | | | | | Response ET: | | | | The APOL11 transaction is in the WAIT-CALLOUT state while it waits for a response to a synchronous program switch request. SKS1 is the transaction name that was requested in the ICAL call. The timeout value of the ICAL call was used to calculate the value of the END TIME field. /DIS ACTIVE REG REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS CLASS 1 MPP1A TP APOL11 APOL1 WAIT-CALLOUT 1 TRAN:SKS1 END TIME: 2010.172 12:45:04 JMPRGN JMP NONE JBPRGN JBP NONE BATCHREG BMP NONE FPRGN FP NONE DBTRGN DBT NONE DBRZCSAJ DBRC DLIZCSAJ DLS *10172/120101* * Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 /DISPLAY AFFIN command Use the /DISPLAY AFFIN command to display the current link or node affinities that an IMS subsystem has within a TCP/IP or VTAM generic resource group. Subsections: v “Environment” on page 465 v “Syntax” on page 465 v “Keywords” on page 465 v “Usage notes” on page 465 v “Equivalent IMS type-2 commands” on page 465 464 Commands, Volume 1: IMS Commands A - M v “Examples” on page 466 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 228. Valid environments for the /DISPLAY AFFIN command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X AFFIN X X NODE X X LINK X X Syntax /DISPLAY /DIS AFFIN NODE LINK nodename link_id link_range ALL Keywords The following keywords are valid for the /DISPLAY AFFIN command: NODE Specify one or multiple nodes. You cannot specify generic names such as nodename* or ALL. LINK Specify one or multiple links, a range of links, or ALL. You must specify link_range in the form of link_a-link_b; for example, 1-3. Usage notes This command is valid only when you use TCP/IP or VTAM generic resources. Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY AFFIN command and the IMS type-2 commands that perform similar functions. Table 229. Type-2 equivalents for the /DISPLAY AFFIN command Task /DISPLAY AFFIN command Similar IMS type-2 command Displays TCP/IP generic resource affinities. /DISPLAY AFFIN LINK links QUERY MSLINK NAME(linkname | *) SHOW(AFFIN) Displays VTAM generic resource affinities. /DISPLAY AFFIN NODE node QUERY NODE SHOW(AFFIN) Chapter 26. /DISPLAY commands 465 Examples The following are examples of the /DISPLAY AFFIN command. Example 1 for /DISPLAY AFFIN command Entry ET: /DISPLAY AFFIN NODE NDSLU2A1 Response ET: NODE APPLID NDSLU2A1 APPL9 *97098/162106* Explanation: The node has an affinity for APPL ID APPL9. Example 2 for /DISPLAY AFFIN command Entry ET: /DISPLAY AFFIN NODE LU37722 Response ET: NODE APPLID LU37722 N/A *97098/162156* Explanation: The node has no affinities. Example 3 for /DISPLAY AFFIN command Entry ET: /DISPLAY AFFIN LINK 22 Response ET: DFS000I DFS000I LINK LINKNAME 22 LNK12T01 NODE APPLID IMS1 Explanation: Link 22 has affinity with the current IMS system under the TCP/IP generic resource ID of IMS1. Example 4 for /DISPLAY AFFIN command Entry ET: /DISPLAY AFFIN LINK ALL Response ET: DFS000I LINK LINKNAME NODE APPLID DFS000I 1 LNK32V01 L6APPL1 N/A DFS000I 2 LNK32V02 L6APPL1 N/A DFS000I 3 LNK32V03 L6APPL1 N/A DFS000I 4 LNK31V01 L6APPL3 APPL7 DFS000I 5 LNK31V05 L6APPL3 APPL7 DFS000I 6 LNK32V05 L6APPL1 N/A DFS000I 7 LNK31T01 N/A DFS000I 22 LNK32T01 IMS1 DFS000I 23 LNK33T01 IMS1 466 Commands, Volume 1: IMS Commands A - M Explanation: Links 4 and 5 to IMS node L6APPL3 have affinity for APPL7 in the IMSplex. Links 1, 2, 3, and 6 are VTAM links to IMS node L6APPL1 and have no affinity. Link 7 is not a VTAM link. Links 22 and 23 are MSC TCP/IP links that have affinity to the current IMS system within the IMS1 TCP/IP generic resource group. Related reference: QUERY NODE command (Commands) /DISPLAY AOITKN command Use the /DISPLAY AOITKN command to display all Automated Operator Interface (AOI) tokens in the system. Subsections: v “Environment” v “Syntax” v “Usage notes” v “Output fields” v “Examples” on page 468 Environment The /DISPLAY AOITKN command is valid in DB/DC, DBCTL, and DCCTL environments. Syntax /DISPLAY /DIS AOITKN Usage notes If QCT=0 and W-REGID=NONE, then the AOI token is deleted at the next checkpoint. Output fields The following output fields are displayed for each AOI token: AOITKN AOI token name. ENQCT Total number of messages enqueued. In a shared-queues environment, only shows messages enqueued for the local subsystem. QCT Number of messages currently queued to the token and not yet retrieved by the AO application. In a shared-queues environment, only shows messages enqueued for the local subsystem. SEGS Number of segments in messages queued (QCT) to the AOI token. W-REGID The region IDs of AO applications that issued a GMSG call with the Chapter 26. /DISPLAY commands 467 WAITAOI subfunction specified. This AO application is in a wait state, since there are currently no messages for it to retrieve. Examples Entry ET: /DISPLAY AOITKN Response ET: AOITOKEN ENQCT QCT SEGS W-REGID AOITOKN1 4 2 12 NONE AOITOKN2 0 0 0 2,4 AOITOKN3 1 0 0 NONE AOITOKN4 1000000000 1000000000 2147483647 NONE *92280/095345* /DISPLAY APPC command Use the /DISPLAY APPC command to display inquiries about LU 6.2 related activities, including the current outbound LU if it is different from the base LU. Subsections: v v v v “Environment” “Syntax” “Output fields” “Examples” on page 470 Environment The /DISPLAY APPC command is valid in DB/DC and DCCTL environments. Syntax /DISPLAY /DIS APPC Output fields The following output fields are displayed for the /DISPLAY APPC command: IMSLU The IMSLU is a base IMS LU name. This LU is always a network-qualified LU name. It is displayed as N/A.N/A if IMS is not connected to APPC/MVS. For example, if status is DISABLED, FAILED, or STARTING, N/A.N/A applies. For the CANCEL status, the field can contain either the LU name or N/A.N/A. #APPC-CONV LU 6.2 inbound and outbound conversation count. SECURITY RACF security level, which is one of the following: v CHECK v FULL v NONE 468 Commands, Volume 1: IMS Commands A - M v PROFILE STATUS The current APPC connection status. The possible values for APPC connection status are: CANCEL Shown after the /STOP APPC CANCEL command. DISABLED Shown when APPC/IMS is not identified or connected to APPC/MVS. ENABLED Shown after successful /START APPC command completion. FAILED Shown after unsuccessful /START APPC command. OUTBOUND Shown on the XRF alternate system as it tracks the active. It is also shown on the active if IMS is unable to initiate normal APPC processing. For example, the /START APPC command can be reissued to attempt APPC enablement. PURGING Shown after the /PURGE APPC command. STARTING Shown after the /START APPC is issued and before the status is set to ENABLED or FAILED. STOPPED Shown after the /STOP APPC command. DESIRED Desired APPC connection status. This status is changed by the /PURGE, /START and /STOP APPC (CANCEL) commands. The possible values for desired APPC connection status are: CANCEL Shown after /STOP APPC CANCEL DISABLED Shown when APPC/IMS is not identified or connected to the APPC/MVS ENABLED Shown after /START APPC OUTBOUND Shown on the XRF alternate system as it tracks the active PURGING Shown after /PURGE APPC STOPPED Shown after /STOP APPC GRNAME The IMS/APPC generic LU name (if VTAM Generic Resources is activated). TYPE BASE for BASE LU or OUTB for OUTBOUND LU. Chapter 26. /DISPLAY commands 469 Examples Entry ET: /DISPLAY APPC Response ET: IMSLU #APPC-CONV SECURITY STATUS IMSLUNME 0 FULL ENABLED *90347/114253* DESIRED ENABLED Entry ET: /DISPLAY APPC Response ET: IMSLU #APPC-CONV SECURITY STATUS DESIRED IMSLUNME 0 FULL DISABLED ENABLED *90347/114253* Entry ET: /DISPLAY APPC Response ET: IMSLU SYS1.IMSLUNME *92232/114253* #APPC-CONV SECURITY STATUS DESIRED 0 FULL STOPPED STOPPED /DISPLAY AREA command Use the /DISPLAY AREA command to display data sets, status conditions, control intervals, and databases associated with an area. Subsections: v v v v v v “Environment” “Syntax” “Keywords and reserved parameters” on page 471 “Usage notes” on page 472 “Equivalent IMS type-2 commands” on page 472 “Output fields” on page 472 v “Examples” on page 474 Environment The /DISPLAY AREA command is valid in DB/DC and DBCTL environments. Syntax 470 Commands, Volume 1: IMS Commands A - M /DISPLAY /DIS AREA areaname ALL IOVF MADSIO NOTOPEN OFR QSC RECALL RECOVERN STOPPED Keywords and reserved parameters The following keywords can be specified for the /DISPLAY AREA command: IOVF Displays the independent overflow area statistics. If the /DISPLAY AREA IOVF command is entered on an RSR tracking subsystem, the IOVF statistics might be incorrect. When the ALL parameter is used with the IOVF keyword (for example, /DIS AREA ALL IOVF), performance can be affected depending on the number and size of areas involved. If large areas, large numbers of areas, or both are involved, the control region can appear to be stopped while processing this command. Areas are selected for display based on the attributes specified. For example, /DISPLAY AREA STOPPED only displays the areas that are currently stopped. The attribute display format is the same as the standard AREA display. Attributes generally correspond to the conditions displayed for areas. Any exceptions are flagged in the following list. The attributes are reserved parameters for the /DISPLAY AREA command and cannot be used to name areas. The following list describes the attributes that can be used with the AREA keyword: MADSIO Displays the areas that are currently in a long busy condition or are in long busy recovery mode. NOTOPEN Displays the areas that have yet to be opened. OFR Displays the areas that are being brought up to the current tracking level with online forward recovery. QSC Displays the Fast Path DEDB areas that are currently quiesced by a previous UPDATE DB START(QUIESCE) or UPDATE AREA START(QUIESCE) command. RECALL Displays the areas that are in recall. Chapter 26. /DISPLAY commands 471 RECOVERN Displays the areas that need recovery. This parameter corresponds to the area condition RECOVERY-NEEDED. STOPPED Displays the areas that are currently stopped. Usage notes If an IMS Fast Path utility is active when the /DISPLAY AREA command is issued, the following output line is displayed: UTILITY XXXX PVTTOT# YY PVTAVL# ZZ IMSID:SSSS TTTT or UTILITY: XXXX IMSID:SSSS The output values represent: v XXXX - the active utility name or VSO function v YY - the total number of private buffers available to the utility v ZZ - the number of unused private buffers available to the utility v SSSS - the IMSID of the IMS system on which the utility is active v TTTT - the IMSID of the IMS system on which the display was issued There are six IMS Fast Path utilities, one VSO functions, and one IBM DBTOOL utility that can be displayed. They include: v HSSP (High Speed Sequential Processing utility) v HSRE (DBFUHDR0, High Speed Reorganization utility) v MDL0 (DBFUMDL0, SDEP Delete utility) v v v v v MSC0 (DBFUMSC0, SDEP Scan utility) MRI0 (DBFUMRI0, DEDB Create utility) MMH0 (DBFUMMH0, DEDB Compare utility) PRLD (VSO Preload is active) TOOL (an IBM DBTOOL Online utility) Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY AREA command and the IMS type-2 commands that perform similar functions. Table 230. Type-2 equivalents for the /DISPLAY AREA command Task /DISPLAY AREA command Similar IMS type-2 command Displays information about an area. /DISPLAY AREA QUERY AREA Output fields The following output fields are displayed for the /DISPLAY AREA command: AREANAME Name of the Fast Path DEDB area. DDNAME Names of the data sets that contain that area. 472 Commands, Volume 1: IMS Commands A - M CONDITIONS Status conditions associated with the area or ADS. Status conditions associated with the area include: IC HSSP image copy is currently active on the area. MADSIO The areas is currently in a long busy condition or long busy recovery mode. NOTOPEN The area has yet to be opened. This will be done when first call is issued to the area. RECALL Area is in recall. RECOVERY-NEEDED The area has been marked RECOVERY-NEEDED. The Database Recovery utility needs to be run to restore this area. STOPPED The area is in STOPPED status. All access to it is prohibited. This can be changed with the /START command. VIR The area is a VSO area. PREO The area is defined to be preopened during IMS initialization. PREL The area is defined to be preloaded during IMS initialization. QUIESCED The Fast Path DEDB area named on the command is currently quiesced by a previous UPDATE DB START(QUIESCE) or UPDATE AREA START(QUIESCE) command. QUIESCING The Fast Path DEDB area named on the command is currently undergoing quiesce by a previous UPDATE DB START(QUIESCE) or UPDATE AREA START(QUIESCE) command. Status conditions associated with the ADS include the following: COPY-PHASE The CREATE utility is currently in the COPY phase on this ADS. The CREATE utility must complete before anything can be done with this ADS. FORMAT-PHASE The CREATE utility is currently in the FORMAT phase on this ADS. The CREATE utility must complete before anything can be done with this ADS. PRE-OPEN FAILED XRF PREOPEN was not successful for this ADS. RECALL Area is in Recall. SEVERE-ERROR This ADS has had a severe I/O error (write error to second CI, in which Fast Path keeps its control information). Chapter 26. /DISPLAY commands 473 UNAVAILABLE This ADS has been marked unavailable, probably because of I/O errors. (EQE REMAIN = 0). EQECT Specifies the count of I/O errors for the area. TOTAL SEQ DEPENDENT Total control intervals defined for sequential dependent space. UNUSED SEQ DEPENDENT Unused control intervals for sequential dependent space. TOTAL DIRECT ADDRESSABLE Total control intervals defined for direct addressable space. UNUSED DIRECT ADDRESSABLE Unused control intervals for direct addressable space. DBNAME Database name. EEQECT Count of write error EEQE for this area. IOVF Independent overflow area statistics. These statistics are only displayed if IOVF is specified on the /DIS AREA command (/DIS AREA ALL IOVF or /DIS AREA areaname IOVF). If the IOVF parameter is not specified on the /DIS AREA command, N/A appears in the display output. Examples The following are examples of the /DISPLAY AREA command. Example 1 for /DISPLAY AREA command Entry ET: /DIS AREA db21ar1 db21ar3 db21ar6 IOVF Response ET: AREANAME EQECT TOTAL UNUSED TOTAL UNUSED DBNAME EEQECT CONDITIONS DDNAME REMAIN SEQ DEPENDENT DIR ADDRESSABLE DB21AR1 N/A 13 11 74 74-CI DEDBJN21 999 VIR, PREO, PREL DB21AR1 10 N/A N/A N/A N/A N/A DB21AR1B 10 N/A N/A N/A N/A N/A DB21AR1C 10 N/A N/A N/A N/A N/A DB21AR3 N/A 13 11 74 56-CI DEDBJN21 PREO DB21AR3 10 N/A N/A N/A N/A N/A DB21AR3B 10 N/A N/A N/A N/A N/A DB21AR6 N/A 17 15 74 56-CI DEDBJN21 DB21AR6 10 N/A N/A N/A N/A N/A *93076/173254* Explanation: DIR ADDRESSABLE means Independent Overflow part. Example 2 for /DISPLAY AREA command Entry ET: /DIS AREA ALL 474 Commands, Volume 1: IMS Commands A - M Response ET: AREANAME DDNAME EQECT TOTAL UNUSED TOTAL UNUSED REMAIN SEQ DEPENDENT DIR ADDRESSABLE DB21AR0 N/A 17 DB21AR0 10 N/A DB21AR1 N/A 13 DB21AR1 10 N/A DB21AR1B 10 N/A DB21AR1C 10 N/A DB21AR10 N/A 17 DB21AR10 10 N/A DB21AR11 N/A 133 DB21AR11 10 N/A DB21AR2 N/A 19 UTILITY: HSRE PVTTOT# DB21AR2 10 N/A DB21AR3 N/A 13 DB21AR3 10 N/A DB21AR3B 10 N/A DB21AR4 N/A N/A DB21AR5 N/A N/A DB21AR6 N/A N/A DB21AR7 N/A N/A DB21AR8 N/A N/A DB21AR9 N/A N/A *93076/173254* 15 74 N/A N/A 11 74 N/A N/A N/A N/A N/A N/A 15 74 N/A N/A 131 74 N/A N/A 17 74 45 PVTAVL# N/A N/A 11 74 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A DBNAME EEQECT CONDITIONS N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A 0-UW 15 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A DEDBJN21 999 N/A DEDBJN21 N/A N/A N/A DEDBJN21 N/A DEDBJN21 N/A DEDBJN21 N/A DEDBJN21 N/A N/A DEDBJN21 DEDBJN21 DEDBJN21 DEDBJN21 DEDBJN21 DEDBJN21 VIR, PREO, PREL VIR, PREO VIR, PREO, PREL VIR VIR, PREO, PREL PREO STOPPED, NOTOPEN STOPPED, NOTOPEN STOPPED, NOTOPEN NOTOPEN NOTOPEN NOTOPEN Explanation: DIR ADDRESSABLE means Independent Overflow part. Example 3 for /DISPLAY AREA command Entry ET: /DIS AREA db11ar4 Response ET: AREANAME DDNAME EQECT REMAIN DB21AR4 N/A TOTAL UNUSED TOTAL UNUSED SEQ DEPENDENT DIR ADDRESSABLE N/A N/A N/A N/A DBNAME EQECT CONDITIONS DEDBJN21 999 STOPPED, NOTOPEN, RECOVERY *97136/173254* Explanation: RECOVERY means this Fast Path area is undergoing recovery with the Online Recovery Service. Example 4 for /DISPLAY AREA command Entry ET: /DIS AREA DB21AR0 Response ET: DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I AREANAME DDNAME DB21AR0 UTILITY: DB21AR01 DB21AR02 DB21AR03 EQECT TOTAL UNUSED TOTAL UNUSED DBNAME EEQECT CONDITIONS SYS3 REMAIN SEQ DEPENDENT DIR ADDRESSABLE SYS3 N/A 29 28 74 0-UW DEDBJN21 0 VIR, PREO, PREL SYS3 HSSP PVTTOT# 45 PVTAVL# 30 IMSID: IMS2 SYS3 10 N/A N/A N/A N/A N/A SYS3 10 N/A N/A N/A N/A N/A SYS3 10 N/A N/A N/A N/A N/A SYS3 Explanation: The IMS Fast Path utility, HSSP, is active on IMSID=IMS2. Chapter 26. /DISPLAY commands 475 Example 5 for /DISPLAY AREA command Entry ET: /DIS AREA QSC Response ET: AREANAME EQECT TOTAL UNUSED TOTAL UNUSED DBNAME EEQECT CONDITIONS DDNAME REMAIN SEQ DEPENDENT DIR ADDRESSABLE AXYZ01 N/A N/A N/A N/A N/A FPDBXYZ 0 QUIESCED Explanation: This is an example of displaying databases that have the status of quiesced. Related concepts: DEDB area design guidelines (Database Administration) Related reference: QUERY AREA command (Commands) /DISPLAY ASMT command Use the /DISPLAY ASMT command to display resource assignments. Subsections: v “Environment” v “Syntax” on page 477 v “Keywords” on page 477 v “Equivalent IMS type-2 commands” on page 478 v “Examples” on page 479 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 231. Valid environments for the /DISPLAY ASMT command and keywords Command / Keywords 476 DB/DC DBCTL DCCTL /DISPLAY X X X ASMT X X LINE X X LINK X X LTERM X X MSNAME X X MSPLINK X X NODE X X SYSID X X USER X X Commands, Volume 1: IMS Commands A - M Syntax /DISPLAY /DIS ASMT LINE line# PTERM pterm# ALL LINK link# ALL LTERM ltermname ltermname* ALL MSNAME msname msname* ALL MSPLINK msplinkname ALL NODE nodename nodename USER username ALL ALL SYSID sysid# ALL USER username username* ALL Keywords The following keywords are valid for the /DISPLAY ASMT command: LINE PTERM The logical terminal names associated with the specified line and physical terminal. LINK The physical link, SYSIDs, and logical link paths assigned to the specified logical link. LTERM The communication line and physical terminal or node and component associated with the specified logical terminal name. When using ISC or a dynamic terminal, the displayed output for a logical terminal assigned to the VTAM pool shows the assigned node, if any, and the user name. The LTERM parameter can be generic. Chapter 26. /DISPLAY commands 477 MSNAME The physical link and logical link assigned to the specified logical link path. MSPLINK The type, address, and logical link associated with the specified physical link. For MSC with TCP/IP or VTAM, MSPLINK also displays the maximum number of allowed sessions and the identifier used by the remote IMS system. For TCP/IP physical links, the command output displays the IMS ID of the remote IMS system. For VTAM physical links, the output displays the VTAM node name of the remote IMS system. If logons are stopped for a physical link that is used for MSC TCP/IP generic resources, the status of the link displays as PSTOPGEN. NODE The logical terminal names associated with the specified node. When using ISC, the displayed output shows at least one line of information for each half-session of the node, shows whether the half-session is active, and shows whether LTERMs are assigned. If the half-session is active, the user identifier is displayed. If no LTERMs are assigned, NONE is indicated. The USER keyword is valid for ISC nodes and non-ISC nodes with signed-on users. The NODE parameter can be generic. Restrictions for using NODE and USER parameters together: v Commands with the NODE USER keyword pair are valid only if: – The USER is signed on to the NODE – In an ISC environment, the USER is allocated to the NODE – The nodes and users exist v /DISPLAY ASMT commands with NODE USER keyword pair are valid for ISC and non-ISC nodes and users. SYSID The physical link, logical link, and logical link path assignments associated with the specified system identification. USER All the USER structures and USERIDs that match the parameter specified. These are the following: v The USER field shows the USER structure name. N/A appears for all static USERIDs signed on to static nodes. v The USERID field displays the RACF USERID that was used to sign on to the node. N/A appears if a USER structure is not associated with a node. In this case, the USER structure exists to hold status or has messages inserted to it. If no messages or status exist, the USER structure is deleted at the next checkpoint. v The node name and logical terminal names are displayed if the user is allocated to a node or signed on to a node. v For ISC sessions, the ID field shows the other half session qualifier. The USER parameter can be generic. Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY ASMT command and the IMS type-2 commands that perform similar functions. 478 Commands, Volume 1: IMS Commands A - M Table 232. Type-2 equivalents for the /DISPLAY ASMT command. Task /DISPLAY ASMT command Similar IMS type-2 command Displays input and output components. /DISPLAY ASMT LTERM ltermname QUERY LTERM SHOW(COMPONENT) Displays the node associated with the /DISPLAY ASMT LTERM ltermname lterm. QUERY LTERM SHOW(NODE) Displays the user associated with the lterm. /DISPLAY ASMT LTERM ltermname QUERY LTERM SHOW(USER) Displays the attributes of an MSC logical link /DISPLAY ASMT MSPLINK msplinkname QUERY MSLINK SHOW(ALL) Displays the attributes of an MSC physical link /DISPLAY ASMT MSPLINK msplinkname QUERY MSPLINK SHOW(ALL) Displays assigned lterms. /DISPLAY ASMT NODE node QUERY NODE SHOW(LTERM) Displays the user associated with the node. /DISPLAY ASMT NODE node QUERY NODE SHOW(USER) Displays the other half-session qualifier ID of the ISC node. /DISPLAY ASMT USER user QUERY USER SHOW(ID) Displays assigned lterms. /DISPLAY ASMT USER user QUERY USER SHOW(LTERM) Displays the node. /DISPLAY ASMT USER user QUERY USER SHOW(NODE) QUERY USERID SHOW(NODE) Displays the user ID. /DISPLAY ASMT USER user QUERY USER SHOW(USERID) Displays the user. /DISPLAY ASMT USER user QUERY USERID SHOW(USER) Examples The following are examples of the /DISPLAY ASMT command. Example 1 for /DISPLAY ASMT command Entry ET: /DISPLAY ASMT LINE 2 PTERM ALL Response ET: TERMINAL 2- 1 IN - L2740S2 OUT - L2740S1, L2740S2 *90295/130910* Entry ET: /DISPLAY ASMT LINE 4 PTERM 1, 2 Response ET: TERMINAL 4- 1 IN - L2740SM1 OUT- L2740SM1 4- 2 IN - L2740SM2 OUT- L2740SM2 *90295/130328* Example 2 for /DISPLAY ASMT command Entry ET: Chapter 26. /DISPLAY commands 479 /DISPLAY ASMT LINK ALL Response ET: LINK PLINK SIDR 1 BLCB1CTC 1 1 3 2 BLCB2BSC 21 22 3 BLCB1MTM 19 *90280/072935* SIDL 4 5 6 23 24 20 MSNAME SYSTEM2A SYSTEM2B FRESNO BOSTON ALBANY TEST1 Example 3 for /DISPLAY ASMT command Entry ET: /DISPLAY ASMT LTERM DIALQ1 INQUIRY1 L2740S1 MASTER WTOR Response ET: LTERM IN-TERMINAL DIALQ1 111 INQUIRY1 51 L2740S1 31 MASTER 31 WTOR 1SC *90295/130657* OUT-TERMINAL 111 51 31 31 1SC USER Entry ET: /DISPLAY ASMT LTERM L1 L2 L3 Response ET: LTERM IN-TERMINAL OUT-TERMINAL USER L1 141 141 L2 NODEA -1 NODEA -1 A L3 N/A -1 N/A -1 B *90231/143059* Entry ET: /DISPLAY ASMT LTERM ALL Response ET: LTERM IN-TERMINAL OUT-TERMINAL CRDPUNCH 141 141 DIALQ1 111 111 DIALQ2 121 121 DIALQ3 131 131 INQUIRY1 51 51 INQUIRY2 61 61 INQUIRY3 71 71 INQUIRY4 81 81 INQUIRY5 91 91 INQUIRY6 101 101 L2740SM1 41 41 L2740SM2 42 42 L2740S1 31 31 L2740S2 21 21 MASTER 31 31 PTPPUNCH 141 141 WS12DS WS121 WS121 WTOR 1SC 1SC *90295/160953* 480 Commands, Volume 1: IMS Commands A - M USER Example 4 for /DISPLAY ASMT command Entry ET: /DISPLAY ASMT MSNAME ALL Response ET: LINK PLINK SIDR N/A 32 10 PLNK12V 20 N/A 35 N/A 28 1 PLNK12V 31 10 PLNK12V 266 10 PLNK12V 256 2 PLNK12C 33 10 PLNK12V 80 11 PLNK12V 40 3 PLNK12M 34 12 PLNK13V 38 7 N/A 43 N/A 36 1 PLNK12V 21 1 PLNK12V 22 10 PLNK12V 90 5 N/A 26 1 PLNK12V 32 N/A 8 6 N/A 51 3 PLNK12M 24 N/A 266 4 N/A 35 N/A 31 N/A 43 N/A 80 N/A 37 6 N/A 27 N/A 33 4 N/A 25 N/A 34 5 N/A 29 N/A 29 2 PLNK12C 23 10 PLNK12V 36 7 N/A 42 16 LKV1TSTB 93 *97258/170244* SIDL 3 10 3 3 11 2036 1012 13 300 9 14 18 44 3 11 12 500 16 12 3 41 14 3 15 3 3 3 3 17 3 15 3 19 3 13 16 45 3 MSNAME IMS1 LINK23B4 IMS1 LINK12V1 IMS1 LINK23U2 IMS1 ELINK211 IMS1 LINK13B3 IMS1 LINK13V IMS1 LINK12V IMS1 LINK13C2 IMS1 LINK13X IMS1 LINK12V2 IMS1 LINK13M2 IMS1 LINK13V2 IMS1 ELINK124 IMS1 LINK23V1 IMS1 LINK12B1 IMS1 LINK12B2 IMS1 LINK12Y IMS1 ELINK120 IMS1 LINK13B4 IMS1 LINK21V3 IMS1 ELINK1MS IMS1 LINK12M1 IMS1 LINK23V IMS1 LINK13U2 IMS1 LINK23B3 IMS1 ELINK224 IMS1 LINK23X IMS1 LINK23V2 IMS1 ELINK121 IMS1 LINK23C2 IMS1 LINK12U1 IMS1 LINK23M2 IMS1 ELINK122 IMS1 ELINK222 IMS1 LINK12C1 IMS1 LINK13V1 IMS1 ELINK123 IMS1 PTH3TSTB IMS1 Example 5 for /DISPLAY ASMT command The following example displays information about MSC physical link assignments. The output is displayed in tabular format. Each logical link assigned to a physical link is displayed on a single row. The attributes of the physical links are displayed in columns. In the output of the /DISPLAY ASMT MSPLINK command: LINK The link number of the logical link that is assigned to the physical link. PLINK The name of the physical link. TYPE The physical link type. Chapter 26. /DISPLAY commands 481 ADDR The address of the physical link. ADDR applies to VTAM and CTC only. MAXSESS The maximum number of logical links or sessions that can be assigned to the physical link. NODE The identifier of the remote IMS system. For VTAM physical links, NODE is the node name of the remote IMS system. For TCP/IP physical links, NODE is the IMSID of the remote IMS system. Entry ET: /DISPLAY ASMT MSPLINK ALL Response ET: DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I LINK PLINK TYPE 3 PLNK12M MTM 9 PLNK12MA MTM 2 PLNK12C CTC N/A PLNK12MU MTM N/A PLNK12CU CTC 1 PLNK12V VTAM 10 PLNK12V VTAM 11 PLNK12V VTAM 28 PLNK12V VTAM N/A PLNK12VU VTAM 12 PLNK13V VTAM 13 PLNKSON1 VTAM 14 PLNKSON2 VTAM 15 PLNKSON3 VTAM 16 PLNK12MB MTM 17 PLNK13MB MTM 18 PLNK12CB CTC 19 PLNK13CB CTC 20 PLNK12VB VTAM 21 PLNK13VB VTAM 22 PLNK12TA TCPIP 23 PLNK12TA TCPIP 24 PLNK13TA TCPIP *11130/232948* ADDR MAXSESS NODE **** **** 0211 **** **** 00000000 3 L6APPL1 00000000 3 L6APPL1 00000000 3 L6APPL1 00000000 3 L6APPL1 **** 1 PZ606099 00000000 5 APPL7 00000000 1 L6APPLU 00000000 2 L6APPLV 00000000 2 L6APPLW **** **** **** **** 00000000 2 L6APPL1 00000000 2 APPL7 **** 2 IMS2 **** 2 IMS2 **** 2 IMS3 Example 6 for /DISPLAY ASMT command Entry ET: /DISPLAY ASMT NODE NLU1 NLUT65 NLUT6P Response ET: NODE USER NLU1 NLUT65 NLUT6P A NLUT6P N/A NLUT6P C *04008/113126* LTERM I/OI/OI/OI/OI/O- L1 L3 L5 NONE L7 Entry ET: /DISPLAY ASMT NODE NLUT6P USER C Response ET: 482 Commands, Volume 1: IMS Commands A - M , L2 , L6 NODE USER NLUT6P C *04008/113126* LTERM I/O- L7 Entry ET: /DISPLAY ASMT NODE ALL Response ET: NODE USER CT3275 CT3277A CT3277B CT3277C CT3277D CT3277E L3270A L3270B L3284A W612 W613 FCBOX1 *04008/113126* LTERM I/OI/OI/OI/OI/OI/OI/OI/OI/OI/OI/OI/O- VT3275 , VT3275P VT3270A VT3270B VT3270C VT3270P1 VT3270P2 VT3270L1 VT3270L2 VT3270P3 W610JP , W610D6 , W610FP W620JP , W620D6 , W620PB W6CIT , W620M6 Example 7 for /DISPLAY ASMT command Entry ET: /DISPLAY ASMT SYSID ALL Response ET: LINK PLINK SIDR SIDL MSNAME 1 BLCB1CTC 1 4 SYSTEM2A 1 BLCB1CTC 2 5 SYSTEM2B 1 BLCB1CTC 3 6 FRESNO 3 BLCB1MTM 19 20 TEST1 2 BLCB2BSC 21 23 BOSTON 2 BLCB2BSC 22 24 ALBANY *90280/072821* Entry ET: /DISPLAY ASMT SYSID ALL Response ET: LINK PLINK SIDR SIDL MSNAME N/A 8 3 LINK21V3 N/A 28 3 ELINK211 5 N/A 29 19 ELINK122 1 PLNK12V 31 11 LINK13B3 1 PLNK12V 32 12 LINK13B4 2 PLNK12C 33 13 LINK13C2 3 PLNK12M 34 14 LINK13M2 4 N/A 35 15 LINK13U2 10 PLNK12V 36 16 LINK13V1 N/A 37 3 LINK23V2 12 PLNK13V 38 18 LINK13V2 7 N/A 43 44 ELINK124 6 N/A 51 41 ELINK1MS 10 PLNK12V 80 300 LINK13X 10 PLNK12V 266 2036 LINK13V *97258/170653* IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 Entry ET: Chapter 26. /DISPLAY commands 483 /DISPLAY ASMT SYSID 22 23 24 Response ET: LINK PLINK SIDR SIDL MSNAME 2 BLCB2BSC 22 24 ALBANY 23 IS LOCAL 24 IS LOCAL *90280/072902* Example 8 for /DISPLAY ASMT command Entry ET: /DISPLAY ASMT USER A B C D Response ET: USER ID A CICSA B C CICSB D *90229/083059* NODE NLUT6P I/OI/OI/OI/O- NLUT6P L1 L3 L4 NONE , L2 Entry ET: /DISPLAY ASMT USER IMSUS01 IMSUS02 Response ET: USER USERID ID IMSUS01 IMSUS01 N/A IMSUS01 N/A IMSUS02 DT327002 IMSUS02 *92350/112229* NODE DTSLU201 L3270A L3270B DT327002 I/OI/OI/OI/O- IMSUS01 T3270LA T3270LB DT327002 Entry ET: /DISPLAY ASMT USER IMSUS01* Response ET: USER USERID ID IMSUS01C N/A IMSUS01D N/A IMSUS01 IMSUS01 N/A IMSUS01 *92350/113904* NODE I/OI/ODTSLU201 I/OL3270A I/O- NONE NONE IMSUS01 T3270LA Entry ET: /DISPLAY ASMT USER ALL Response ET: USER CA13 IMSUS01C IMSUS01D LU6SPA LU6SPB DT327002 IMSUS03 IMSUS01 IMSUS05 484 USERID ID N/A N/A N/A N/A IMSUS02 IMSUS03 IMSUS01 N/A Commands, Volume 1: IMS Commands A - M NODE I/OI/OI/OLU6NDPF I/OI/ODT327002 I/ODTSLU601 I/ODTSLU201 I/OI/O- CA1SP3T1, CA1SP3T2 NONE NONE LU6LTPA1 LU6LTPB1, LU6LTPB2 DT327002 IMSUS03 IMSUS01 NONE N/A IMSUS02 N/A IMSUS01 N/A IMSUS04 *92350/114845* L3270B L3270A L3270C I/O- T3270LB I/O- T3270LA I/O- T3270LC | Example 9 for /DISPLAY ASMT command: ISC TCP/IP nodes | | In the following examples, the nodes that are shown in the command output are ISC TCP/IP nodes. | | Entry ET: | | | | Response ET: | | Entry ET: | | | | Response ET: | | Entry ET: | | | | | Response ET: /DIS ASMT NODE CICS NODE USER LTERM CICS IMSUS01 I/O- IMSUS01 *12062/122917* IMS1 /DIS ASMT USER IMSUS01 USER USERID ID IMSUS01 N/A IMSUS01 *12062/122949* IMS1 NODE CICS I/O- IMSUS01 /DIS ASMT LTERM IMSUS01 LTERM IN-TERMINAL OUT-TERMINAL IMSUS01 CICS -1 CICS -1 *12062/123336* IMS1 USER IMSUS01 Related reference: QUERY LTERM command (Commands) QUERY NODE command (Commands) QUERY USER command (Commands) QUERY USERID command (Commands) QUERY MSLINK command (Commands) QUERY MSPLINK command (Commands) /DISPLAY CCTL command Use the /DISPLAY CCTL command to display all coordinator controllers that are connected to DBCTL along with the pseudorecovery token, recovery token, region ID, PSB name, and status. Restriction: The /DISPLAY CCTL command does not support the ODBA interface to IMS DB. To display status information about units of work for protected resources that are managed by z/OS Resource Recovery Services, use the /DISPLAY UOR command. Subsections: Chapter 26. /DISPLAY commands 485 v v v v v “Environment” “Syntax” “Keywords” “Output fields” on page 487 “Examples” on page 487 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 233. Valid environments for the /DISPLAY CCTL command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X ACTIVE X X X CCTL X X INDOUBT X X Syntax ALL /DISPLAY /DIS CCTL ACTIVE INDOUBT cctlname Keywords The following keywords are valid for the /DISPLAY CCTL command: ALL | cctlname Specifies the coordinator controllers to be displayed. ALL Displays all coordinator controllers that are connected to IMS. cctlname Specifies the name of the coordinator controller. You can specify one or more coordinator controller names. ACTIVE | INDOUBT Mutually exclusive, optional keywords that you use to specify the type of threads to be displayed. ACTIVE Displays all currently active threads that are associated with either the specified coordinator controller name (cctlname) or with all coordinator controllers. INDOUBT Displays all in-doubt threads that are associated with either the specified coordinator controller name (cctlname) or with all coordinator controllers. 486 Commands, Volume 1: IMS Commands A - M Output fields Coordinator controllers that are attached to IMS show a status of ATTACHED. The status of active threads can be any of the following: v v v v v v v ACTIVE ACTIVE-DBCMD AVAILABLE TERM UNAVAIL W-BLKMVR W-INTENT v W-POOLSP v W-SWITCH The status of in-doubt threads is always displayed as INDOUBT. Examples The following are examples of the /DISPLAY CCTL command. Example 1 for /DISPLAY CCTL command Entry ET: /DISPLAY CCTL Response ET: CCTL CICS1 *89067/114857* STATUS Example 2 for /DISPLAY CCTL command Entry ET: /DISPLAY CCTL ALL Response ET: CCTL CICS1 PSEUDO-RTKN RECOVERY-TOKEN 0000000000000000 0000000000000000 0000000000000000 REGID 3 2 1 PSBNAME STATUS ATTACHED AVAILABLE AVAILABLE AVAILABLE *89067/113236* Example 3 for /DISPLAY CCTL command Entry ET: /DISPLAY CCTL CICS1 Response ET: Chapter 26. /DISPLAY commands 487 CCTL CICS1 PSEUDO-RTKN RECOVERY-TOKEN 9FFA9568FF594301 9FFA956B7AE24E00 0000000000000000 REGID 3 2 1 PSBNAME BMP255 BMP255 STATUS ATTACHED ACTIVE ACTIVE AVAILABLE *89067/113251* Example 4 for /DISPLAY CCTL command Entry ET: /DISPLAY CCTL CICS1 ACTIVE Response ET: CCTL CICS1 PSEUDO-RTKN RECOVERY-TOKEN 9FFA967C26D69802 9FFA967ACF9EB802 REGID 2 1 PSBNAME BMP255 BMP255 STATUS ATTACHED ACTIVE ACTIVE *89067/114557* Example 5 for /DISPLAY CCTL command Entry ET: /DISPLAY CCTL CICS1 INDOUBT Response ET: CCTL CICS1 PSEUDO-RTKN RECOVERY-TOKEN 000100C0 00010040 *89067/113413* 9FFA956B7AE24E00 9FFA9568FF594301 REGID PSBNAME BMP255 BMP255 STATUS ATTACHED INDOUBT INDOUBT Related reference: “Status and attributes for the /DISPLAY command” on page 435 /DISPLAY CONV command Use the /DISPLAY CONV command to display all BUSY and HELD conversations in the IMS system if no other keywords or parameters are specified. Subsections: v v v v v “Environment” “Syntax” on page 489 “Keywords and reserved parameters” on page 489 “Usage notes” on page 490 “Equivalent IMS type-2 commands” on page 490 v “Output fields” on page 490 v “Examples” on page 491 Environment The /DISPLAY CONV command is valid in DB/DC and DCCTL environments. The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. 488 Commands, Volume 1: IMS Commands A - M Table 234. Valid environments for the /DISPLAY CONV command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X CONV X X LINE X X NODE X X USER X X Syntax /DISPLAY /DIS CONV BUSY HELD LINE line# NODE PTERM pterm# ALL nodename nodename* ALL USER username username* ALL Keywords and reserved parameters The following keywords and reserved parameters are valid for the /DISPLAY CONV command: BUSY The conversations currently active for the system or active for a specific node, line and physical terminal, or user. HELD The conversations currently held in the system or held from a specific node, line and physical terminal, or user. LINE All conversations for the specified communication line are displayed. NODE All conversations for the specified node are displayed. If the NODE keyword is used and the node is an ISC node, information for all applicable sessions of the parallel session node is displayed. For dynamic terminals, the conversations of the currently associated user are displayed. The NODE parameter can be generic. PTERM All conversations for the specified physical terminal are displayed. USER All conversations that apply to the specified user are displayed. The USER parameter can be generic. Chapter 26. /DISPLAY commands 489 Usage notes /DISPLAY CONVERSATION is accepted as a valid command from an IMS terminal because CONVERSATION is a valid synonym of CONV. When ISC is used with parallel sessions, one line of information for each session in a conversation is displayed. The user name is also displayed. Attention: In an IMSplex, use of the /DISPLAY CONV command without a specific resource name will result in extensive accesses to the Resource Manager for global information, and its use should be carefully considered. For an IMS conversational transaction issued from an LU 6.2 application program, the /DISPLAY CONV command shows the LU name and user ID (if available) of the LU 6.2 conversation along with the IMS conversation ID and status. For an IMS conversational transaction issued from an OTMA client, the /DISPLAY CONV command shows the TMEMBER and TPIPE name in addition to the IMS conversation ID and status. On an IMS XRF alternate system, where TMEMBER and TPIPE name information is not available, the literal 'UNKNOWN.OTMA' is displayed instead of the TMEMBER and TPIPE names associated with the conversation. Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY CONV command and the IMS type-2 commands that perform similar functions. Table 235. Type-2 equivalents for the /DISPLAY CONV command Task /DISPLAY CONV command Similar IMS type-2 command Displays nodes with active or held conversations. /DISPLAY CONV QUERY NODE STATUS(CONV) Displays users with active or held conversations. /DISPLAY CONV QUERY USER STATUS(CONV) Displays IMS conversation information for a particular node. /DISPLAY CONV NODE node QUERY NODE SHOW(CONV) Displays IMS conversation information for a particular user. /DISPLAY CONV USER user QUERY USER SHOW(CONV) Output fields The following output fields are displayed for the /DISPLAY CONV command: ID A 4-byte conversation ID, which is unique for each user and terminal. STATUS Conversation status. The status can be ACTIVE, HELD, or SCHEDULED. TERMINAL Physical device with which the conversation is associated. This can be a non-VTAM device/pterm, a VTAM node, an ISC node, an APPC luname, or an OTMA tmember/tpipe. USER The user signed on to a dynamic VTAM node, or the subpool associated with an ISC node, or the user ID for an LU 6.2 conversation. 490 Commands, Volume 1: IMS Commands A - M Examples Entry ET: /DISPLAY CONV Response ET: TERMINAL USER ID STATUS NO CONVERSATIONS *91113/182917* Entry ET: /DISPLAY CONV Response ET: TERMINAL USER 112 42 114 21 51 *91115/135706* ID STATUS 0001 HELD 0002 ACTIVE, SCHEDULED 0001 HELD 0001 HELD 0002 ACTIVE Entry ET: /DISPLAY CONV Response ET: TERMINAL USER LUNAME1 USERID1 DT327001 IMSUS01 LUNAME2 LUNAME3 USERID4 LUNAME1 USERID4 *90332/114253* ID STATUS 0001 ACTIVE 0005 ACTIVE 0002 ACTIVE,SCHEDULED 0003 ACTIVE,SCHEDULED 0004 SCHEDULED Entry ET: /DISPLAY CONV BUSY Response ET: TERMINAL USER ID STATUS NO BUSY CONVERSATIONS *91113/182959* Entry ET: /DISPLAY CONV BUSY Response ET: TERMINAL USER 21 42 41 *91113/192021* ID STATUS 0001 ACTIVE, SCHEDULED 0010 ACTIVE, SCHEDULED 0011 ACTIVE, SCHEDULED Entry ET: /DISPLAY CONV BUSY LINE 4 PTERM ALL Response ET: Chapter 26. /DISPLAY commands 491 TERMINAL USER 42 41 *91113/192101* ID STATUS 0001 ACTIVE, SCHEDULED 0002 ACTIVE, SCHEDULED Entry ET: /DISPLAY CONV BUSY Response ET: TERMINAL NETWORK1.LUNAME1 DT327001 NID2.LUNAME2 LUNAME3 NETWORK1.LUNAME1 *92232/114253* USER USERID1 IMSUS01 USERID4 USERID5 ID 0001 0005 0002 0003 0004 STATUS ACTIVE ACTIVE ACTIVE,SCHEDULED ACTIVE,SCHEDULED ACTIVE Entry ET: /DISPLAY CONV HELD Response ET: TERMINAL USER ID STATUS NO HELD CONVERSATIONS *91113/183022* Entry ET: /DISPLAY CONV HELD NODE NSLUTP6 Response ET: TERMINAL USER ID STATUS NSLUTP6 SPOOLA 0007 HELD NSLUTP6 SPOOLC 000A HELD *91113/183033* Related reference: QUERY NODE command (Commands) QUERY USER command (Commands) /DISPLAY CPLOG command Use the /DISPLAY CPLOG command to display the value of the IMS execution parameter, CPLOG. CPLOG specifies the number of system log records between system-generated checkpoints. Subsections: v “Environment” v “Syntax” on page 493 Environment The /DISPLAY CPLOG command is valid in DB/DC, DBCTL, and DCCTL environments. 492 Commands, Volume 1: IMS Commands A - M Syntax /DISPLAY /DIS CPLOG /DISPLAY CQS command Use the /DISPLAY CQS command to display information about the Common Queue Server (CQS), including the CQS job name, version number, and current status. Valid status conditions are CONNECTED and DISCONNECTED. Subsections: v “Environment” v “Syntax” v “Examples” Environment The /DISPLAY CQS command is valid in DB/DC and DCCTL environments. This command is valid only in a shared-queues environment. Syntax /DISPLAY /DIS CQS Examples Entry ET: /DISPLAY CQS Response ET: JOBNAME VERS# STATUS CQS1 1.1 CONNECTED *95200/170817* Explanation: IMS is connected to the Common Queue Server, CQS1. /DISPLAY DB command Use the /DISPLAY DB command to display the status of the specified databases. If a specified database is a DEDB, the associated DEDB areas are also displayed. The /DISPLAY DB command can be used on HALDB databases. Subsections: v “Environment” on page 494 v “Syntax” on page 494 v “Keywords and reserved parameters” on page 494 v “Usage notes” on page 497 v “Equivalent IMS type-2 commands” on page 497 Chapter 26. /DISPLAY commands 493 v “Output fields” on page 497 v “Examples” on page 500 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 236. Valid environments for the /DISPLAY DB command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X DB X X BKERR X X Syntax /DISPLAY /DIS dbname ALL DB BKERR ALLOCF ALLOCS BACKOUT EEQE INQONLY LOCK NOTINIT NOTOPEN OFR QSC RECALL RECOVERY RNL STOPPED OLR Keywords and reserved parameters The following keywords can be specified for the /DISPLAY DB command: BKERR Displays the error queue elements associated with a DL/I or DEDB database. It also displays incomplete backouts preventing the use of a DL/I database. OLR The /DISPLAY DB OLR command displays the status of a specified partition locally; that is, the status is only from the IMS where the command was issued. The /DISPLAY DB OLR command returns OLR information and status of all partitions that have HALDB online reorganization (OLR) cursor-active status. The following information is returned: RATE The rate at which the HALDB OLR is running, from 1 to 100 494 Commands, Volume 1: IMS Commands A - M BYTES The total number of bytes moved to the output data sets SEGMENT The total number of segments moved to the output data sets ROOTS The total number of roots moved to the output data sets STARTTIME The local time the OLR was first started STATUS HALDB OLR status. One or more of the following statuses are returned: v RUNNING - OLR is running. v WAITLOCK - OLR is waiting for a lock. v WAITRATE - OLR is waiting because of an intentional delay. This intentional delay occurred because a value of less than 100 was specified for the RATE parameter. v OPTDEL - Output data sets are deleted at the end of OLR. v OPTNODEL - Output data sets are not deleted at the end of OLR. v RESUMED - OLR is resumed at this IMS after being stopped for some reason such as a TERMINATE OLREORG command or a user abend. v OPTREL - Ownership of the OLR is released if IMS terminates. v OPTNOREL - Ownership of the OLR is retained if IMS terminates. v NOTOWNED - OLR is not owned by this IMS. The /DISPLAY DB OLR command can be issued to obtain the above information for an OLR that has been stopped for some reason such as a TERMINATE OLREORG command or a user abend. The data associated with the terminated OLR is maintained and provided under any of the following conditions: v The TERMINATE OLR command is issued. v Abnormal OLR termination occurs (for example, DFS2971W message is issued) v IMS is normally shut down. Note: If the partition or HALDB master has been taken offline with a /DBR command, or if IMS has been restarted to resume the OLR and the OLR ownership is requested before IMS restart, the status will not be available through the /DISPLAY DB OLR command until the OLR is resumed. The status, however, can be obtained through the LIST.DB or LIST.RECON command. The OLR attribute cannot be specified on the /DISPLAY DB command with any other attribute such as STOPPED or ALLOC. If additional attributes are specified, the command is rejected and message, DFS0135 is displayed. If a /DISPLAY DB OLR command is issued on an RSR tracker or an XRF alternate, the message, DFS132I - ALL PARAMETERS ARE INVALID is displayed. Attributes are reserved parameters for the /DISPLAY DB command and cannot be used to name databases. Attributes listed with the following table can be used with the DB keyword. Databases are selected for display based on the attribute or Chapter 26. /DISPLAY commands 495 attributes specified. The attribute display format is the same as the standard DB display. Attributes usually correspond to the conditions displayed for databases. Table 237. /DISPLAY DB command attributes ALLOCF BACKOUT INQONLY NOTINIT OFR QSC STOPPED ALLOCS EEQE LOCK NOTOPEN OLR RECALL ALLOCF Displays the databases whose allocation failed. ALLOCS Displays the databases whose allocation was successful. BACKOUT Displays the databases with incomplete backouts, which prevent the use of the databases. EEQE Displays the databases that are associated with one or more error queue elements. INQONLY Displays the databases for which a /DBDUMP command was issued. LOCK Displays the databases that are locked. NOTINIT Displays the databases for which directory initialization failed. NOTOPEN Displays the databases that are not in open status. This status is not applicable to MSDBs. OFR Displays the databases that are currently being recovered by online forward recovery (OFR). Note: The OFR attribute is valid only when issued from an RSR tracking subsystem. OLR Displays the databases that have online reorganization in progress. Restriction: The OLR attribute cannot be entered with any other attribute. QSC Displays the databases that have the status of quiesced or quiescing. RECALL Displays the databases that are in recall. STOPPED Displays the databases that are stopped. 496 Commands, Volume 1: IMS Commands A - M Usage notes If you use the /DISPLAY command to identify OLRs that are terminated using the TERMINATE OLREORG command, it does not report status for partitions that have not been authorized. Alternately, use the commands QUERY OLREORG STATUS (NOTOWNED) with ROUTE(*) on the command request, and /RMLIST DBRC='DB DBD(partname)'. If all systems on the PLEX show status NOTOWNED, and the DBRC database record shows an OLR active cursor, then OLR has been terminated. When you enter this command, the database name can be an existing non-HALDB, a HALDB master, or a HALDB partition. A command against a HALDB partition operates exactly like a command against a non-HALDB except for the /START DB and the UPDATE DB START(ACCESS) command. A HALDB partition is not allocated during the command unless it was previously authorized but not allocated, the OPEN keyword was specified, or the partition has EEQEs. The partition is allocated at first reference. The HALDB partition reflects conditions such as STOPPED, LOCKED, or NOTOPEN. When a HALDB partition is stopped, it must be explicitly started again. Commands with the keyword ALL and commands against a HALDB master do not change the STOPPED and LOCKED indicators in each HALDB partition. When the command target is a HALDB master, processing acts on all HALDB partitions. For example, if the IMS command is /DBR on the HALDB master, all of the HALDB partitions are closed, deallocated, and deauthorized. Only the HALDB master displays STOPPED (each HALDB partition does not display STOPPED unless it was itself stopped). If a /DBR command was issued against a HALDB master, the display output of a /DISPLAY DB command shows the HALDB master (as STOPPED), but does not display the status of the partitions. Each partition inherits the access limitations of its HALDB master. If the /DBD command is issued against a HALDB master, all of its partitions close. A subsequent reference to any of the partitions results in the partition opening for input, although the partition's access might be UPDATE or EXCLUSIVE. The DBRC authorization state reflects the limited access. Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY DB command and the IMS type-2 commands that perform similar functions. Table 238. Type-2 equivalents for the /DISPLAY DB command Task /DISPLAY DB command Similar IMS type-2 command Displays the status of a database. /DISPLAY DB dbname1 ...dbnamen | ALL QUERY DB Output fields The following output fields are displayed for the /DISPLAY DB command: DB Name of the database. TYPE Type of database: v DL/I Chapter 26. /DISPLAY commands 497 v v v v v DEDB DHISNDX (refers to Fast Path secondary index databases) MSNR (refers to MSDB non-related databases) MSRD (refers to MSDB-related dynamic databases) MSRF (refers to MSDB-related fixed databases) v v v v v PHIDAM PHDAM PSINDEX PART blank (if the database status is NOTINIT) TOTAL SEQ DEPEND Total control intervals defined for sequential dependent space, which applies to areas associated with DEDBs. This column appears only if Fast Path is installed. UNUSED SEQ DEPEND Unused control intervals for sequential dependent space. This column appears only if Fast Path is installed. TOTAL DIRECT ADDRESS Total control intervals for independent overflow part of direct addressable space, which applies to areas associated with DEDBs. This column appears only if Fast Path is installed. UNUSED DIRECT ADDRESS Total unused control intervals for independent overflow part of a direct addressable space, which applies to areas associated with DEDBs. This column appears only if Fast Path is installed. This IOVF count is updated on a timed basis, with a default timer of 2 hours. ACC Type of access to the database, which can be one of the following: RO Read only RD Read UP Update EX Exclusive CONDITIONS Status conditions of the database, which can be one or more of the following: v ALLOCF v ALLOCS v BACKOUT v EEQE v INQONLY v v v v v v v 498 LOCK NOTINIT NOTOPEN OFR OLR QUIESCED QUIESCING Commands, Volume 1: IMS Commands A - M v v v v RECALL RECOVERY RNL STOPPED The /DISPLAY DB command with the BKERR keyword displays error queue elements associated with a DL/I database and displays incomplete backouts. The following output fields are displayed by the /DISPLAY DB command with the BKERR keyword: DATABASE Name of the database with error queue elements or backout pending data. ERROR DD DDNAME of the data set with the error queue element TYPE Type of error queue element, which is one of the following: BACK PSB PSB needing backout BLOCK OSAM block number or VSAM CI RBA DATE Date IDT In-doubt IDT+WRT In-doubt and write error IDT+IOT In-doubt and I/O toleration IOT I/O toleration IOT/VSO I/O toleration for VSO areas PRM DBRC permanent RD Read error TIME Time USE DBRC user created WRT Write error BLOCK The /DISPLAY DB command with BKERR does not display individual RBAs for I/O tolerated non-SDEP CIs of a DEDB area defined with the Virtual Storage Option (VSO). Instead, a single entry with a value of 00000001 is displayed; the EEQE type is set to IOT/VSO. I/O tolerated SDEP CIs for the area are displayed individually by RBA. The EEQE information might not be current if the database is registered with DBRC and is not open, because IMS updates EEQE information from DBRC when the database is opened. Chapter 26. /DISPLAY commands 499 Examples The following are examples of the /DISPLAY DB command. Example 1 for /DISPLAY DB command Entry ET: /DISPLAY DB ALL Response ET: DATABASE TYPE TOTAL UNUSED TOTAL UNUSED ACC CONDITIONS DD41M702 DL/I EX NOTOPEN DD41M803 DL/I EX NOTOPEN DEDBJN21 DEDB SEQ DEPEND DIRECT ADDRES EX NOTOPEN DB21AR0 AREA N/A N/A N/A N/A NOTOPEN DB21AR1 AREA N/A N/A N/A N/A NOTOPEN DB21AR2 AREA N/A N/A N/A N/A NOTOPEN DB21AR3 AREA N/A N/A N/A N/A NOTOPEN DB21AR4 AREA N/A N/A N/A N/A NOTOPEN DB21AR5 AREA N/A N/A N/A N/A NOTOPEN DB21AR6 AREA N/A N/A N/A N/A NOTOPEN DB21AR7 AREA N/A N/A N/A N/A NOTOPEN DB21AR8 AREA N/A N/A N/A N/A NOTOPEN DB21AR9 AREA N/A N/A N/A N/A NOTOPEN DB21AR10 AREA N/A N/A N/A N/A NOTOPEN DB21AR11 AREA N/A N/A N/A N/A NOTOPEN DEDBJN22 DEDB SEQ DEPEND DIRECT ADDRES EX NOTOPEN DB22AR0 AREA N/A N/A N/A N/A NOTOPEN DB22AR1 AREA N/A N/A N/A N/A NOTOPEN DEDBJN23 DEDB SEQ DEPEND DIRECT ADDRES EX NOTOPEN DB23AR0 AREA N/A N/A N/A N/A NOTOPEN DB23AR1 AREA N/A N/A N/A N/A NOTOPEN DIMSRNO1 DL/I EX NOTOPEN DIMSRNO2 DL/I EX NOTOPEN DIMSRNO3 DL/I EX NOTOPEN *89184/142639* Entry ET: /DISPLAY DB DD41M803 BKERR Response ET: DATABASE DD41M803 ERROR DD TYPE DD41M803 IOT *90135/161902* BLOCK 0000003F Explanation: An I/O toleration error queue element exists for database DD41M803 on a newly created active system in an XRF environment. Following an /UNLOCK SYSTEM command on the above system, the /DISPLAY DB DD41M803 BKERR command would yield the following display: DATABASE DD41M803 NO EEQE OR INCOMPLETE BACKOUT INFORMATION AVAILABLE *90135/163500* Example 2 for /DISPLAY DB command Entry ET: 500 Commands, Volume 1: IMS Commands A - M /DIS DB BE3ORDER BE3PARTS. Response ET: DATABASE BE3ORDER TYPE DL/I TOTAL UNUSED TOTAL UNUSED ACC EX BE3PARTS DL/I *94277/124039* EX CONDITIONS STOPPED, LOCK, NOTOPEN, RECALL NOTOPEN, RECALL Example 3 for /DISPLAY DB command Entry ET: /DIS DB RECALL. Response ET: DATABASE BE3ORDER TYPE DL/I TOTAL UNUSED TOTAL UNUSED ACC EX BE3PARTS DL/I IVPDB1 DL/I EX UP IVPDB2 DL/I *94277/124119* UP CONDITIONS STOPPED, LOCK, NOTOPEN, RECALL NOTOPEN, RECALL STOPPED, LOCK, NOTOPEN, RECALL NOTOPEN, RECALL Example 4 for /DISPLAY DB command Entry ET: /DISPLAY DB DEDBJN21 BKERR Response ET: DATABASE DEDBJN21 ERROR DD DB21AR0 DB21AR0 DB21AR1 DB21AR1 TYPE IOT IOT/VSO IOT IOT/VSO BLOCK 00015000 00000001 00054000 00000001 Explanation: The /DISPLAY DB command with the BKERR keyword does not display individual RBAs for I/O tolerated non-SDEP CIs of a DEDB area defined with the Virtual Storage Option (VSO). Instead, a single entry with a value of 00000001 is displayed and the EEQE type is set to IOT/VSO. I/O tolerated SDEP CIs for the area are displayed individually by RBA. Example 5 for /DISPLAY DB command Entry ET: /DISPLAY DB OFR Response ET: DATABASE TYPE TOTAL UNUSED BE2PCUST DL/I BE3ORDER DL/I BE3ORDRX DL/I BE3PARTS DL/I BE3PSID1 DL/I *91240/132406* SYS3 TOTAL UNUSED ACC EX EX EX EX EX CONDITIONS ALLOCS OFR ALLOCS OFR ALLOCS OFR ALLOCS OFR ALLOCS OFR Example 6 for /DISPLAY DB command Chapter 26. /DISPLAY commands 501 If a full function database data set is undergoing recovery with Online Recovery Service, the output of the /DISPLAY DB command includes this information in the command response. Entry ET: /DISPLAY DB DD41M702 Response ET: DATABASE DD41M702 TYPE DL/I TOTAL UNUSED TOTAL UNUSED ACC EX CONDITIONS STOPPED, LOCK, NOTOPEN RECOVERY *97184/142639* Example 7 for /DISPLAY DB command Display the HALDB master for the PHIDAM database called PARTMAST. Entry ET: /DIS DB PARTMAST Response ET: DATABASE TYPE TOTAL UNUSED PARTMAST PHIDAM PART1 PART PART2 PART PART3 PART *99166/092514* TOTAL UNUSED ACC UP UP UP UP CONDITIONS ALLOCS NOTOPEN STOPPED Example 8 for /DISPLAY DB command Display the HALDB partition for PHIDAM PART2. Entry ET: /DIS DB PART2 Response ET: DFS000I DATABASE TYPE DFS000I PARTMAST PHIDAM DFS000I PART2 PART *99166/092737* TOTAL UNUSED TOTAL UNUSED ACC UP UP CONDITIONS NOTOPEN Example 9 for /DISPLAY DB command Display output for an online reorganization with ownership retention. If ownership is not retained during a termination, OPTREL is replaced with OPTNOREL. Entry ET: /DIS DB OLR Response ET: DATABASE PART RATE STATUS DBHDOJ01 PDHDOJB 1 WAITRATE, OPTNODEL DBHDOJ01 PDHDOJA 1 502 Commands, Volume 1: IMS Commands A - M BYTES SEGS ROOTS STARTTIME 0 0 0 07295/143354 3330 17 1 07295/143354 WAITRATE, OPTDEL, OPTREL DBHDOJ01 PDHDOJC 1 WAITLOCK, OPTNODEL *07295/143358* 1400 5 2 07295/143354 Explanation: Issue the /DISPLAY DB OLR command to obtain information about all HALDB online reorganizations that are running in cursor-active status. The following information is returned: v v v v v v v Master database name Partition name OLR rate Number of bytes moved Number of segments moved Number of roots moved Start time of the OLR when it was first started v Status of the progress of OLR v OLR inactive data set option v Date/Time stamp when the command was processed v OLR options, including whether OLR ownership is released if IMS terminates before completing the reorganization v OLR wait status, if any Note: For partitions in NOTOWNED status, if the OLR statistics information is unavailable, only the master database name, partition name, and status are displayed. Example 10 for /DISPLAY DB command Entry ET: /DISPLAY DB QSC Response ET: DATABASE TYPE TOTAL UNUSED AUTODB DL/I DBHIDJ03 PHIDAM POHIDJC PART DBOHIDK5 PHIDAM POHIDKA PART POHIDKB PART POHIDKC PART POHIDKD PART DBOVLFPC DL/I TOTAL UNUSED ACC UP UP UP UP UP UP UP UP UP CONDITIONS NOTOPEN, QUIESCING NOTOPEN, QUIESCED NOTOPEN, NOTOPEN, NOTOPEN, NOTOPEN, NOTOPEN, QUIESCED ALLOCS, QUIESCED QUIESCED QUIESCED QUIESCED QUIESCING Explanation: Issue the /DISPLAY DB QSC command to obtain information about all databases that have the status of quiesced or quiescing. Example 11 for /DISPLAY DB command In this example, TYPE is set to DHISNDX for a HISAM or a SHISAM secondary index database. Entry ET: /DISPLAY DB ALL Response ET: Chapter 26. /DISPLAY commands 503 DATABASE TYPE DBHDOJ01 PHDAM PDHDOJA PART PDHDOJB PART PDHDOJC PART PDHDOJD PART DEDBJN24 DEDB DB24A000 AREA DB24A001 AREA DB24A239 AREA DEHSJX24 DHISNDX *09043/155658* TOTAL UNUSED SEQ N/A N/A N/A TOTAL UNUSED ACC CONDITIONS UP UP NOTOPEN UP NOTOPEN UP NOTOPEN UP NOTOPEN DEPEND DIRECT ADDRES UP NOTOPEN N/A N/A N/A NOTOPEN N/A N/A N/A NOTOPEN N/A N/A N/A NOTOPEN UP NOTOPEN IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 Explanation: DBHDOJ01 is a PHDAM database with four partitions: PDHDOJA, PDHDOJB, PDHDOJC, and PDHDOJD. DEDBJN24 is a DEDB database with three areas: DB24A000, DB24A001, and DB24A239. DEHSJX24 is a HISAM or a SHISAM secondary index database. The local access of each database is UPDATE. Related reference: “Status and attributes for the /DISPLAY command” on page 435 Parameter descriptions for IMS procedures (System Definition) QUERY DB command (Commands) /DISPLAY DBD command Use the /DISPLAY DBD command to display, for databases that are being accessed, their type, the PSBs accessing them, and the type of access. Subsections: v v v v “Environment” “Syntax” “Equivalent IMS type-2 commands” “Examples” on page 505 Environment The /DISPLAY DBD command is valid in DB/DC and DBCTL environments. Syntax /DISPLAY /DIS DBD dbdname Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY DBD command and the IMS type-2 commands that perform similar functions. Table 239. Type-2 equivalents for the /DISPLAY DBD command Task /DISPLAY DBD command Displays the programs being accessed /DISPLAY DBD dbdname by databases. 504 Commands, Volume 1: IMS Commands A - M Similar IMS type-2 command QUERY DB NAME(dbname) SHOW(PGM) Examples Entry ET: /DISPLAY DBD MSDBLM01 MSDBLM02 MSDBLM03 MSDBLM04 Response ET: DBD-NAME MSDBLM01 TYPE MSDB MSDBLM02 MSDB MSDBLM03 MSDB MSDBLM04 MSDB PSB-NAME DDLTLM06 DDLTLM07 DDLTLM06 DDLTLM07 DDLTLM06 DDLTLM07 DDLTLM06 DDLTLM07 ACCESS R/W R/W R/W R/W R/W R/W R/W R/W *91068/110958* Related reference: QUERY DB command (Commands) /DISPLAY DESC command Use the /DISPLAY DESC command to display LU 6.2 descriptors. All specified values are displayed, as are defaults/blanks for values not specified in the descriptor. Subsections: v “Environment” v “Syntax” v “Output fields” v “Examples” on page 506 Environment The /DISPLAY DESC command is valid in DB/DC and DCCTL environments. Syntax /DISPLAY /DIS DESC descriptor ALL Output fields The following output fields are displayed for the /DISPLAY DESC command: DESC Name of the descriptor. LUNAME LU name value in the descriptor. The network-qualified LU name is optional for the LUNAME keyword. MODE VTAM LOGON mode table entry value in the descriptor. Chapter 26. /DISPLAY commands 505 OUTBNDLU Shows which local-LU will be used for APPC outbound processing when the descriptor is used. SIDE APPC z/OS side table entry value in the descriptor. SYNCLEVEL APPC synchronous level in the descriptor; either NONE or CONFIRM. TPNAME TP name value in the descriptor. If the tpname is too long, a + is appended at the end, and the rest is continued on a second line. TYPE APPC conversation type value in the descriptor; it is either BASIC or MAPPED. Examples Entry ET: /DISPLAY DESC ALL Response ET: DESC LUNAME MODE SIDE SYNCLEVEL TYPE LU62DES1 NID2.LUNAME4 ALPHA SIDENME1 CONFIRM MAPPED TPNAME: ACCOUNT LU62DES2 LUNAME7 BETHA SIDENME2 NONE BASIC TPNAME: APPLE67890123456789012345 *92232/114253* OUTBNDLU MYLU02 /DISPLAY FDR command Use the /DISPLAY FDR command to display the current status for IMS Fast Database Recovery regions. IMS rejects this command if the active IMS subsystem is not connected to a Fast Database Recovery region. Subsections: v “Environment” v “Syntax” v “Output fields” v “Examples” on page 507 Environment The /DISPLAY FDR command is valid in DB/DC and DBCTL environments. Syntax /DISPLAY /DIS FDR Output fields The following output fields are displayed for the /DISPLAY FDR command: 506 Commands, Volume 1: IMS Commands A - M FDR-REGION Status of the Fast Database Recovery region to which the IMS subsystem is connected. The status can be ACTIVE or NO_ACTIVE. GROUPNAME The z/OS cross-system coupling facility (XCF) group name specified in the DFSFDRxx member of IMS.PROCLIB. TIMEOUT The failure-detection timeout value specified in the DFSFDRxx member or set by a /CHANGE FDR command. Examples Entry ET: /DISPLAY FDR Response ET: FDR-REGION GROUPNAME TIMEOUT ACTIVE FDBRSYS3 055 *96232/114253* /DISPLAY FPV command Use the /DISPLAY FPV command to display the areas loaded into a z/OS data space or coupling facility. That is, those areas that have been specified with the virtual storage option (VSO) are displayed with this command. Subsections: v “Environment” v “Syntax” v “Output fields” v “Examples” on page 508 Environment The /DISPLAY FPV command is valid in DB/DC and DBCTL environments. Syntax /DISPLAY /DIS FPV Output fields Each data space is displayed, along with each of the areas that reside in the data space. All numbers shown are in decimal values. The following output fields are displayed by the /DISPLAY FPV command: DATASPACE Data space number. MAXSIZE(4K) Maximum available size, in 4 KB blocks. This is the amount of space available in the data space for user data. Chapter 26. /DISPLAY commands 507 AREANAME Name of the area located in the data space or in the coupling facility. AREASIZE(4K) Actual storage available for a particular area, in 4 KB blocks. The actual space usage can be significantly less than what is reserved if a VSO dataspace is not preloaded. OPTION A data space option (which can be DREF) or an area option (which can be PREL or PREO). Area options are defined to DBRC with the INIT.DBDS or CHANGE.DBDS command. STRUCTURE Name of the coupling facility structure allocated for this area. ENTRIES Number of area CIs in the structure. CHANGED Number of area CIs in the structure that have been updated. IMS writes these updated CIs to DASD (and resets this value) when you enter any of the following commands: v /CHECKPOINT v /STOP AREA v /VUNLOAD AREACI# Total number of area CIs that can be loaded into the structure. POOLNAME Name of the private buffer pool used by the area. Examples Entry ET: /DISPLAY FPV Response ET: DATASPACE MAXSIZE(4K) AREANAME AREASIZE(4K) OPTION SYS3 001 524188 DB21AR1 76 PREO DB21AR11 152 000 524188 DREF DB21AR0 19 PREO, PREL DB21AR10 19 PREO, PREL DB21AR2 38 PREO, PREL *93076/173254* Entry ET: /DISPLAY FPV Response ET: DATASPACE MAXSIZE(4K) AREANAME AREASIZE(4K) OPTION 000 524263 DREF DB21AR4 167 PREO, PREL DB21AR2 42 PREO, PREL 001 524263 DB21AR3 84 PREO DB21AR1 84 508 Commands, Volume 1: IMS Commands A - M CF POOL CACHE CF1 4K N CF2 512 Y *95225/173254* AREANAME AREASIZE(4K) OPTION AREAFR01 1000 PREO, PREL AREA2 100 PREO, PREL Entry ET: /DISPLAY FPV Response ET: DATASPACE MAXSIZE(4K) AREANAME AREASIZE(4K) OPTION SYS3 000 524238 DREF SYS3 DB21AR1 19 PREO, PREL DB21AR0 19 PREO, PREL DB23AR1 19 PREO, PREL 001 524238 SYS3 NO AREAS LOADED INTO NORM DATASPACE 001. SYS3 002 524238 SYS3 NO AREAS LOADED INTO NORM DATASPACE 002. SYS3 AREANAME STRUCTURE ENTRIES CHANGED AREA CI# POOLNAME OPTIONS NO BLOCK LEVEL SHARED AREAS EXIST. SYS3 *03129/145840* SYS3 SYS2 Entry ET: /DISPLAY FPV Response ET: AREANAME STRUCTURE ENTRIES CHANGED AREA CI# POOLNAME OPTIONS DB33FR01 DB33FR01STRUCTUR 0000150 0000018 00000150 FR01 PREO, PREL DB21AR9 MAS1KSTR 0000043 0000043 00000270 MAS1K PREO DB21AR8 MAS1KSTR 0000044 0000044 00000150 MAS1K PREO DD01AR0 DD01AR0STR1 0000045 0000025 00000045 DD01 PREO, PREL DB21AR10 MAS512STR 0000084 0000084 00000150 V$$$512 PREO DB21AR3 MAS2KSTR 0000150 0000015 00000150 MAS2K PREO, PREL DB21AR1 MAS2KSTR 0000150 0000126 00000150 MAS2K PREO, PREL DB21AR0 MAS512STR 0000150 0000001 00000150 V$$$512 PREO, PREL DB21AR4 MAS4KSTR 0000010 0000010 00000150 MAS4K PREO DB21AR11 MAS4KSTR 0000010 0000010 00000150 MAS4K PREO DB21AR5 MAS1KSTR 0000044 0000044 00000150 MAS1K PREO DB21AR6 MAS512STR 0000077 0000077 00000150 V$$$512 PREO DB21AR7 MAS1KSTR 0000040 0000040 00000150 MAS1K PREO DB21AR2 MAS1KSTR 0000044 0000044 00000150 MAS1K PREO Explanation: Each area using a multi-area structure is listed individually with its own statistics. Column AREACI# displays the total number of CIs in the root addressable part. This is the total number of CIs loaded into the structure if the entire Area was preloaded. /DISPLAY HSB command Use the /DISPLAY HSB command to display the system-related information in an Extended Recovery Facility (XRF) environment. If the command is entered on the active system, information about the active system is displayed. If the command is entered on the alternate system, information about both systems is displayed. Subsections: v “Environment” on page 510 v “Syntax” on page 510 Chapter 26. /DISPLAY commands 509 v “Output fields” v “Examples” on page 511 Environment The /DISPLAY HSB command is valid in DB/DC and DCCTL environments. Syntax /DISPLAY /DIS HSB Output fields The following output fields are displayed for the /DISPLAY HSB command: RSENAME Recoverable service element name. STATUS System entering command (ACTIVE or BACKUP). MODETBL Indication of whether (IOT) or not (blank) the system is in I/O toleration mode. This field is displayed only if the command is entered on the active system. PHASE Displays only if the command is entered on the alternate system; indicates the phase of the alternate system. The following phases can be displayed: INIT Initialization phase SYN Processing SNAPQ checkpoint TRK Tracking active system TKO Taking over workload from active IMS-ID IMS identifier of system entering command. VTAM UVAR VTAM generic name. ACT-ID IMS identifier of active system; field is displayed only if the command is entered on the alternate system. LOG-TIME Time associated with the log record currently being read by the alternate system in the process of tracking the active system. The length of time the alternate system lags behind the active system in reading the log is the difference between the current time, as shown by the time stamp, and the log time. Some of this time difference might be caused by differences in the synchronization of the clocks of the processors. SURVEILLANCE Indicates one of the following surveillance mechanisms: LNK 510 IMS ISC link Commands, Volume 1: IMS Commands A - M LOG IMS system log RDS IMS restart data set INTERVAL The surveillance interval, in seconds, for the specific surveillance mechanism TIMEOUT The surveillance timeout value, in seconds, for the specific surveillance mechanism STATUS The status of the specific surveillance mechanism (ACTIVE or INACTIVE). TAKEOVER CONDITIONS The following takeover conditions may apply: ALARM The alarm on the alternate processor will be sounded when takeover is requested. AUTO Automatic takeover is in effect. Following the display line of ALARM, AUTO, or both, the takeover conditions specified on the SWITCH control statement of the DFSHSBxx PROCLIB member are shown. (xx is the SUF= parameter of the IMS procedure.) There are two groups per line and each group is separated by an asterisk. Each group can include one or more of the following: VTAM VTAM TPEND exit LNK IMS ISC link LOG IMS system log RDS IMS restart data set Examples Entry ET (Active System): /DISPLAY HSB Response ET: RSENAME STATUS DFSRSENM ACTIVE SURVEILLANCE INTERVAL LOG 10 LNK 3 RDS 10 *89340/094236* MODE IMS-ID IMSA TIMEOUT STATUS 99 ACTIVE 9 ACTIVE 99 ACTIVE VTAM UVAR USERVAR1 Entry ET (Active System - MNPS environment): /DISPLAY HSB Response ET: RSENAME STATUS DFSRSENM ACTIVE SURVEILLANCE INTERVAL MODE IMS-ID IMSA TIMEOUT STATUS MNPS NAME USERVAR1 Chapter 26. /DISPLAY commands 511 LOG LNK RDS *89340/094236* 10 3 10 99 ACTIVE 9 ACTIVE 99 ACTIVE Entry ET (Alternate System): /DISPLAY HSB Response ET: RSENAME DFSRSENM STATUS PHASE IMS-ID BACKUP TRK IMSB BACKUP SYSTEM SURVEILLANCE INTERVAL TIMEOUT STATUS LOG 10 99 INACTIVE LNK 3 9 INACTIVE RDS 10 99 INACTIVE TAKEOVER CONDITIONS - ALARM VTAM *RDS LOG *89340/094256* VTAM UVAR ACT-ID USERVAR1 IMSA ACTIVE SYSTEM INTERVAL TIMEOUT 10 99 3 9 10 99 LOG-TIME 09:42:56 STATUS INACTIVE INACTIVE INACTIVE Entry ET (Alternate System - MNPS environment): /DISPLAY HSB Response ET: RSENAME DFSRSENM STATUS PHASE IMS-ID BACKUP TRK IMSB BACKUP SYSTEM SURVEILLANCE INTERVAL TIMEOUT STATUS LOG 10 99 INACTIVE LNK 3 9 INACTIVE RDS 10 99 INACTIVE TAKEOVER CONDITIONS - ALARM VTAM *RDS LOG *89340/094256* MNPS NAME ACT-ID USERVAR1 IMSA ACTIVE SYSTEM INTERVAL TIMEOUT 10 99 3 9 10 99 LOG-TIME 09:42:56 STATUS INACTIVE INACTIVE INACTIVE /DISPLAY HSSP command Use the /DISPLAY HSSP command to display information about the current HSSP (high-speed sequential processing) activities. Subsections: v “Environment” v “Syntax” v “Output fields” on page 513 v “Examples” on page 513 Environment The /DISPLAY HSSP command is valid in DB/DC and DBCTL environments. Syntax 512 /DISPLAY /DIS HSSP Commands, Volume 1: IMS Commands A - M Output fields The following output fields are displayed for the /DISPLAY HSSP command: RGN Region ID as displayed in the /DISPLAY ACTIVE command (three digit PST number) TYP Region type (BMP only) JOBNAME Job name PSB Program Specification Block name DB Database name AREAS-OPTIONS Information on the SETO statement: AREA Area name PCB Information on whether the named area has updated intent. PROCOPT Whether PROCOPT H is specified. IC Image Copy in process. UPD Information on whether the area is updated, which is one of the following: N The PCB has no update intent on the named area. Y The PCB has update intent on the named area. OPTION Information on the execution IC Image Copy in process Examples Entry ET (Active System): /DISPLAY HSSP Response ET: RGN TYP JOBNAME PSB 1 BMP CSSP020B BMPFPE02 *89122/094325* SYS3 DATABASE AREAS-OPTIONS SYS3 DEDBJN21 IC=(1,C) SYS3 /DISPLAY LINE command The /DISPLAY LINE command, when followed by a valid line number or ALL, displays the status and queue counts for the specified communication line or lines and physical terminal. The queue count for /DISPLAY LINE is reset to zero after an IMS cold start. Subsystems: v “Environment” on page 514 v “Syntax” on page 514 v “Keywords” on page 514 Chapter 26. /DISPLAY commands 513 v v v v “Reserved parameters” on page 515 “Usage notes” on page 516 “Output fields” on page 516 “Examples” on page 516 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 240. Valid environments for the /DISPLAY LINE command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X LINE X X QCNT X X PTERM X X Syntax /DISPLAY /DIS LINE line# QCNT line# PTERM pterm# ALL ALL DEACT IDLE LOOPTEST NOIN NOOUT NOQUEUE NOTOPEN PSTOPPED PUR RESP RESPINP STOPPED TKOTRA TRA Keywords The following keywords are valid for the /DISPLAY LINE command: QCNT Specifies that global queue count information is to be displayed. If QCNT is not specified, local queue counts are displayed; when it is specified, no local queue counts are displayed. This keyword is valid only in a shared-queues environment. 514 Commands, Volume 1: IMS Commands A - M PTERM Is used to refer to a relative physical terminal. Valid parameters are number corresponding to the relative position of the terminal on the line. When used without the LINE keyword on the /DISPLAY command, valid parameters are physical terminal attributes. Reserved parameters Lines are selected for display based on the attributes specified. Attributes that can be used with the LINE keyword are shown in the following table. The attribute display format is the same as the standard LINE display. The attributes correspond to the conditions displayed for lines. For example, /DISPLAY LINE LOOPTEST displays all lines that are currently in looptest mode. Table 241. /DISPLAY LINE command attributes DEACT NOIN NOTOPEN RESP TKOTRA IDLE NOOUT PSTOPPED RESPINP TRA LOOPTEST NOQUEUE PUR STOPPED DEACT Displays the lines that have been permanently deactivated. Message DFS2473 in the system console log might contain information regarding the reason this status was set. DFS2473 can occur more than once in the system console log. IDLE Displays the lines for which no activity of any kind is in progress for them. LOOPTEST Displays the lines that are in looptest mode. NOIN Displays the lines that are stopped for input. NOOUT Displays the lines that are stopped for output. NOQUEUE Displays the lines that have had message queuing stopped for message switching. NOTOPEN Displays the lines that are not in open status. PSTOPPED Displays the lines that have been stopped by the /PSTOP command. This status might indicate that a different, necessary resource is unavailable. PUR Displays the lines that are purging all of their output. RESP Displays the lines that are in input response mode and the response reply message is available for output or in the process of being sent. RESPINP Displays the lines that are in full-function input response mode and the response mode input is still in-doubt; for example, the response reply message is not available for output. Chapter 26. /DISPLAY commands 515 STOPPED Displays the lines that are stopped. TKOTRA Displays the lines that are to be traced only during takeover to help diagnose XRF terminal switch problems. TRA Displays the lines that are being traced. Usage notes In a shared-queues environment, use the QCNT keyword to obtain the current message queue counts on the shared queues structure. The local queue counts (ENQCT, DEQCT, and QCT) value that is returned on this command when the QCNT keyword is not specified represents the messages being processed by the IMS system where this command is issued. Do not use local queue counts for queue evaluation purposes. | | | | | | Output fields The following output fields are displayed by the /DISPLAY LINE command. v LIN/PTE v TYPE v ADDR v RECD v ENQCT v DEQCT v QCT v SENT v Status – IDLE – NOTOPEN – STOPPED – COMPINOP Examples Entry ET: /DISPLAY LINE 1, 3, 10 Response ET: LINE TYPE ADDR 1 CONSOLE **** 3 3270 R 0C9 *85098/141118* RECD ENQCT DEQCT 0 1 0 43 51 43 QCT SENT 1 6 8 79 RECD ENQCT DEQCT 4 1 1 43 51 43 0 0 0 20 22 20 0 0 0 0 0 0 QCT SENT 0 6 8 79 0 0 STOPPED IDLE 2 0 0 0 STOPPED IDLE 0 0 STOPPED IDLE Entry ET: /DISPLAY LINE ALL Response ET: LINE 1 2 3 4 5 6 516 TYPE CONSOLE 3270 R 3270 L 3270 L RDR/PTR RDR/PTR ADDR **** 0C9 **** 1234 **** **** Commands, Volume 1: IMS Commands A - M 7 RDR/PTR **** 8 RDR/PTR **** 9 DIAL POOL *85098/141244* 0 0 0 0 0 0 0 0 0 0 STOPPED IDLE 0 0 STOPPED IDLE 0 POOL STOPPED IDLE Entry ET: /DISPLAY LINE 5 PTERM ALL Response ET: LIN/PTE TYPE 51 3270 R 52 3270 R 53 3270 R 54 3270 R 55 3270 R 56 3270 R *85098/141412* ADDR RECD ENQCT DEQCT 404081 3 6 6 C14081 0 6 6 C1C181 40 30 28 C1C281 0 3 0 C1C381 0 3 0 C1C481 0 3 3 QCT SENT 0 8 0 7 2 61 3 0 COMPINOP 3 0 COMPINOP 0 3 Entry ET: /DISPLAY LINE PSTOPPED, PUR Response ET: LINE TYPE ADDR 4 3270 R **** 18 3270 R 022 *85098/141283* RECD ENQCT DEQCT 4 8 8 0 4 4 QCT SENT 0 33 0 4 PUR IDLE NOTOPEN PSTOPPED IDLE /DISPLAY LINK command The /DISPLAY LINK command, when followed by a valid link number or ALL, displays the status and queue counts for the specified logical link. The queue count for the /DISPLAY LINK command is reset to zero after an IMS cold start. In addition, the /DISPLAY LINK command shows if the logical link is assigned to a physical link and the partner identification that is assigned to it during system definition. Subsections: v v v v v v “Environment” “Syntax” on page 518 “Keywords” on page 518 “Usage notes” on page 518 “Output fields” on page 519 “Examples” on page 519 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 242. Valid environments for the /DISPLAY LINK command and keywords Command / Keywords /DISPLAY DB/DC DBCTL DCCTL X X X Chapter 26. /DISPLAY commands 517 Table 242. Valid environments for the /DISPLAY LINK command and keywords (continued) Command / Keywords DB/DC DBCTL DCCTL LINK X X MODE X X OPTION X X QCNT X X Syntax /DISPLAY /DIS link# ALL LINK link# MODE OPTION BUFSIZE QCNT Keywords The following keywords are valid for the /DISPLAY LINK command: MODE Displays various modes in which VTAM terminals can operate. OPTION Specifies the following: BUFSIZE Displays the link parameters such as the link number, link name, bandwidth, buffer size, and the link status. QCNT Specifies that global queue count information is to be displayed. If QCNT is not specified, local queue counts are displayed; when it is specified, no local queue counts are displayed. This count represents the message counts of messages that can be processed by the IMS system where the command is issued. This count includes messages that can be processed by any IMS system (messages with no affinity), plus messages that can be processed by the IMS system where the command is issued (messages with an affinity to the IMS system that issued the command). This keyword is valid only in a shared-queues environment. Usage notes The /DISPLAY LINK link# MODE command, when entered from the primary IMS system, displays in the ACT MODETBL field the mode table name from the /RESTART command or LOGON exit. The same field does not display on the secondary IMS system. Note: N/A is displayed by /DISPLAY LINK ALL MODE for non-VTAM MSC links. In a shared-queues environment, use the QCNT keyword to obtain the current message queue counts on the shared queues structure. The local queue counts | | 518 Commands, Volume 1: IMS Commands A - M | | | | (ENQCT, DEQCT, and QCT) value that is returned on this command when the QCNT keyword is not specified represents the messages being processed by the IMS system where this command is issued. Do not use local queue counts for queue evaluation purposes. Output fields The following output fields are displayed by the /DISPLAY LINK command: ACT MODETBL Mode table name actually used to initiate the session. This name is displayed only if the MODE keyword is specified and only while the session is active. The field is blank at normal session termination. BUFSIZE Link buffer size. The link buffer size is displayed only if the OPTION BUFSIZE keyword is specified. DEF MODETBL Default mode table name set by system definition or /CHANGE command. This name can be overridden with the /RSTART command or, for non-IMS session initiations, the LOGON exit. This name is displayed only if the MODE keyword is specified. DEQCT Count of messages dequeued. ENQCT Count of messages enqueued. LINK Logical link number. LINKNAME Name of the logical link. The link name is displayed only if the OPTION BUFSIZE keyword is specified on the /DISPLAY LINK command. PARTNER The identification specified during IMS system definition for this multiple system partnership. QCT The current count of messages queued. RECD Count of messages received. SENT Count of messages sent. STATUS Displays the link status. Examples The following are example of the /DISPLAY LINK command. Example 1 for /DISPLAY LINK command Entry ET: /DISPLAY LINK ALL Response ET: LINK PARTNER 1 AB 2 AC RECD 0 8 ENQCT 0 21 DEQCT 0 12 QCT 0 9 SENT 0 PSTOPPED IDLE COLD 12 NOTIDLE-C0C ACTV TRA Chapter 26. /DISPLAY commands 519 3 AD 4 BC 5 AE *91293/171240* 4 0 0 6 0 3 6 0 0 0 0 3 6 IDLE ACTV TRA 0 PSTOPPED IDLE COLD 0 PSTOPPED IDLE Example 2 for /DISPLAY LINK command Entry ET: /DISPLAY LINK 1 3 Response ET: LINK PARTNER RECD 1 AB 0 3 AD 0 *90280/072548* ENQCT 1 0 DEQCT 0 0 QCT 1 0 SENT 0 IDLE 0 PSTOPPED IDLE Example 3 for /DISPLAY LINK command Entry ET: /DISPLAY LINK ALL MODE Response ET: LINK PARTNER 1 AB 2 AC 3 AD 4 AE 5 AK 6 AL *90179/102238* DEF MODETBL N/A N/A N/A N/A MSC12V MS12V ACT N/A N/A N/A N/A MODETBL Explanation: N/A is displayed in the mode table name fields of non-VTAM MSC links. MSC12V and MS12V are mode table names defined at system definition or established using the /CHA command. Example 4 for /DISPLAY LINK command Entry ET: /DISPLAY LINK 10 OPTION BUFSIZE Response ET: DFS000I DFS000I DFS000I LINK LINKNAME 10 LNK12V02 *06108/153639* BUFSIZE 4096 STATUS IDLE ACTV PRI FORCE TRA BANDWIDTH Explanation: The link buffer size of 4096 and the bandwidth status are displayed. Example 5 for /DISPLAY LINK command The following two examples show the output of the /DISPLAY LINK command when a link uses TCP/IP as the physical link type. TCP/IP link types always use MSC bandwidth mode, so in the second example, BANDWIDTH indicates that the bandwidth mode is used by the link. Entry ET: /DIS LINK 4 520 Commands, Volume 1: IMS Commands A - M Response ET: DFS000I DFS000I LINK PARTNER 4 TA RECD 0 ENQCT 0 DEQCT 0 QCT 0 SENT 0 PSTOPPED IDLE COLD Entry ET: /DIS LINK 4 OPTION BUFSIZE Response ET: DFS000I DFS000I LINK 4 LINKNAME LNK12T01 BUFSIZE 8192 STATUS PSTOPPED IDLE COLD BANDWIDTH /DISPLAY LTERM command Use the /DISPLAY LTERM command to display status and queue counts for the specified logical terminal name. Subsections: v “Environment” v “Syntax” v “Keywords” on page 522 v “Usage notes” on page 522 v “Equivalent IMS type-2 commands” on page 523 v “Output fields” on page 523 v “Examples” on page 523 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 243. Valid environments for the /DISPLAY LTERM command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X EMHQ X X LTERM X X QCNT X X Syntax /DISPLAY /DIS LTERM ltermname ltermname* ltermname QCNT EMHQ ALL QCNT EMHQ Chapter 26. /DISPLAY commands 521 Keywords The following keywords can be specified for the /DISPLAY LTERM command: EMHQ Specifies that global queue count information on the Expedited Message Handler Queues (EMHQ) displays when both EMHQ and QCNT are specified. If EMHQ is specified, QCNT must also be specified. This keyword is only valid in a shared-queues environment. QCNT Specifies that global queue count information is to be displayed. If QCNT is not specified, local queue counts are displayed; when it is specified, no local queue counts are displayed. If QCNT is specified and EMHQ is not, global queue count information on the shared message queues (MSGQ) is displayed. This count represents the message counts of messages that can be processed by the IMS system where the command is issued. This count includes messages that can be processed by any IMS system (messages with no affinity), plus messages that can be processed by the IMS system where the command is issued (messages with an affinity to the IMS system that issued the command). IMS does not check if the specified name is a valid LTERM in the IMS subsystem on which the command is entered. The /DISPLAY LTERM ALL QCNT command displays all of the LTERMs on the shared queues with a global queue count. This command does not display queue counts for Fast Path output messages for the NODE unless EMHQ and QCNT are specified. This keyword is only valid in a shared-queues environment. For IMS subsystems in a shared-queues environment with the time control option, TCO, enabled, AFFIN has been added to the queue names of TCO LTERMs. When the /DISPLAY LTERM DFSTCFI QCNT command is issued, the queue count of messages for the DFSTCFI LTERM pertains to the TCO LTERM on the local IMS subsystem. The queue count is zero prior to adding AFFIN to the queue names. Usage notes The LTERM parameter can be generic where the generic parameter specifies lterms that already exist. /DISPLAY LTERM ALL does not display lterms in alphabetical order. In a shared-queues environment, there are certain situations that cause an LTERM message to be retrieved from the global queue and moved to the local queue, but the message has not been delivered. If this occurs, the global queue count is zero and you need to display the local queue to see the output message. In a shared-queues environment, use the QCNT keyword to obtain the current message queue counts on the shared queues structure. The local queue counts (ENQCT, DEQCT, and QCT) value that is returned on this command when the QCNT keyword is not specified represents the messages being processed by the IMS system where this command is issued. Do not use local queue counts for queue evaluation purposes. | | | | | | 522 Commands, Volume 1: IMS Commands A - M Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY LTERM command and the IMS type-2 commands that perform similar functions. Table 244. Type-2 equivalents for the /DISPLAY LTERM command. Task /DISPLAY LTERM command Similar IMS type-2 command Displays logical link path for remote lterms. /DISPLAY LTERM ltermname QUERY LTERM SHOW(MSNAME) Displays the lterm message queue count. /DISPLAY LTERM ltermname QUERY LTERM SHOW(QCNT) Displays status of the lterm. /DISPLAY LTERM ltermname QUERY LTERM SHOW(STATUS) Displays queue count in the EMH queues. /DISPLAY LTERM ltermname QCNT EMHQ QUERY LTERM SHOW(EMHQ) /DISPLAY LTERM ltermname QCNT Output fields The status displayed can be one of the following: v LOCK v v v v v PSTOP PUR QERR QLOCK STATIC v STOP Examples The following are examples of the /DISPLAY LTERM command. Example 1 for /DISPLAY LTERM command Entry ET: /DISPLAY LTERM DIALQ1 INQUIRY1 L2740S1 L2740SM1 MASTER WTOR Response ET: LTERM ENQCT DIALQ1 0 INQUIRY1 0 L2740S1 1 L2740SM1 1 MASTER 12 WTOR 0 *90295/123755* DEQCT 0 0 1 0 12 0 QCT 0 0 0 1 0 0 STOP STOP Example 2 for /DISPLAY LTERM command Entry ET: /DISPLAY LTERM ALL Response ET: Chapter 26. /DISPLAY commands 523 LTERM ENQCT DSPLY1 0 DSPLY2 0 DSPLY3 0 MASTER 8 WTOR 0 2740AA1 0 2740AA2 0 2740AA3 0 2740C1 0 2740C2 0 2740SM1 2 2740SM2 2 2740S1 1 2740S2 1 LU6A 1 *91276/125448* DEQCT 0 0 0 8 0 0 0 0 0 0 2 2 1 1 1 QCT 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 STOP STOP QERR QLOCK Example 3 for /DISPLAY LTERM command Entry ET: /DISPLAY LTERM LTERMA LTERM123 ABCD QCNT Response ET: LTERM GBLQCT LTERMA 1000000000 LTERM123 25 ABCD 0 *95200/170817* Example 4 for /DISPLAY LTERM command Entry ET: /DISPLAY LTERM EMHQ QCNT (one user is on the queue) Response ET: LTERM GBLQCT FPE0001 1 *98203/145857* Example 5 for /DISPLAY LTERM command Entry ET: /DIS LTERM ALL QCNT EMHQ Response ET: LTERM GBLQCT IMSUS01 1 IMSUS02 1 *04310/132048* SYS3 SYS3 SYS3 SYS3 Related reference: “Status and attributes for the /DISPLAY command” on page 435 QUERY LTERM command (Commands) 524 Commands, Volume 1: IMS Commands A - M /DISPLAY LUNAME command Use the /DISPLAY LUNAME command to display information about a specific LU 6.2 application program. After restart and any checkpoint, only LU 6.2 resources with status or messages queued are displayed. If you use a side information entry name to place messages on queues, specify the side information entry name for the LU name and the character string DFFSIDE for the TP name to display those messages. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 526 v “Output fields” on page 526 v “Examples” on page 527 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 245. Valid environments for the /DISPLAY LUNAME command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X INPUT X X LUNAME X X OUTPUT X X QCNT X X TPNAME X X Syntax /DISPLAY /DIS LUNAME luname ALL luname luname INPUT OUTPUT QCNT TPNAME tpname ALL QCNT Keywords The following keywords are valid for the /DISPLAY LUNAME command: Chapter 26. /DISPLAY commands 525 LUNAME The LU name of the LU 6.2 application program about which you want to display information. INPUT Displays the count of LU 6.2 inbound conversations and synchronous outbound activities for the specified LU names and their status. /DISPLAY LUNAME INPUT can indicate that a command such as the /STO LU ALL INPUT command or the /TRACE SET ON LU ALL INPUT command was entered before the display that applies to all future LU 6.2 inbound conversations. OUTPUT Displays the count of asynchronous output messages that are being enqueued and dequeued for the LU name and the count of LU 6.2 asynchronous outbound conversations for that LU name. The /DISPLAY LUNAME OUTPUT command can indicate that a command such as the /STO LU ALL OUTPUT command or the /TRACE SET ON LU ALL OUTPUT command was entered that applies to all future LU 6.2 outbound conversations. QCNT Displays the number of output messages on the global queue for the specified LU name. QCNT specifies that global queue count information is to be displayed. Local queue counts are not displayed. This count represents the message counts of messages that can be processed by the IMS system where the command is issued. This count includes messages that can be processed by any IMS system (messages with no affinity), plus messages that can be processed by the IMS system where the command is issued (messages with an affinity to the IMS system that issued the command). The /DISPLAY LUNAME QCNT form of the command is only valid in a shared-queues environment. TPNAME Displays the number of asynchronous output messages being enqueued and dequeued and their status. If the LU name includes a network identifier, you must specify the network-qualified LU name when using the TPNAME keyword. A network-qualified LU name refers to a different resource than a non-qualified LU name. Usage notes In a shared-queues environment, use the QCNT keyword to obtain the current message queue counts on the shared queues structure. The local queue counts (ENQCT, DEQCT, and QCT) value that is returned on this command when the QCNT keyword is not specified represents the messages being processed by the IMS system where this command is issued. Do not use local queue counts for queue evaluation purposes. | | | | | | Output fields The following output fields are displayed for the /DISPLAY LUNAME command: 526 Commands, Volume 1: IMS Commands A - M LUNAME LU name of the LU 6.2 application program #APPC-CONV The number of LU 6.2 inbound conversations ENQCT Total number of messages enqueued on this LU name. In a shared-queues environment, only shows messages enqueued for the local subsystem. DEQCT Total number of messages dequeued from this LU name. In a shared-queues environment, only shows messages dequeued for the local subsystem. QCT Total number of messages still in the queue. In a shared-queues environment, only shows messages enqueued for the local subsystem. CONVCT Number of LU 6.2 asynchronous outbound conversations. Status can be stopped (STO), traced (TRA), or stopped and traced. The CONVCT output field only applies if the OUTPUT keyword was specified. GBLQCNT The total number of APPC output messages on the global queue. The global queue count includes messages that were placed on the global queue prior to the latest cold start of the owning IMS. Synchronous and asynchronous APPC output messages are included in the global queue count. AFFINITY The IMSID (or the first seven bytes of the RSENAME if XRF capable) of the IMS to which the output messages have affinity. Status The status displayed can be none, stopped (STO), traced (TRA), or both stopped and traced. The status information does not have a header. Examples Entry ET: /DISPLAY LU luname1 luname2 INPUT Response ET: LUNAME #APPC-CONV LUNAME1 15 TRA LUNAME2 5 *90332/114253* Entry ET: /DISPLAY LU luname1 luname3 BADLUNME OUTPUT Response ET: LUNAME ENQCT LUNAME1 5 LUNAME3 5 BADLUNME IS INVALID *90332/114253* DEQCT 3 4 QCT 2 1 CONVCT 2 1 Chapter 26. /DISPLAY commands 527 Entry ET: /DISPLAY LU LUNAME1 TPNAME TPNAME1 BADTPNME Response ET: LUNAME/TPNAME ENQCT LUNAME1 -TPNAME1 0 BADTPNME IS INVALID *90332/114253* DEQCT QCT 0 0 STO Entry ET: /DISPLAY LU LUNAME1 TPNAME ALL OUTPUT Response ET: LUNAME/TPNAME LUNAME1 -TPNAME1 -TPNAME7890123456+ 789END -DFSSIDE *90332/114253* ENQCT DEQCT QCT 0 5 0 3 0 STO 2 TRA,STO 2 2 0 LUNAME/TPNAME ENQCT DEQCT NO TPNAME(S) ASSOCIATED WITH LUNAME *90332/114253* QCT Entry ET: /DISPLAY LU LUNAME2 TPNAME ALL Response ET: Entry ET: /DISPLAY LU ’network1.luname1’ luname3 ’nid2.luname4’ OUTPUT Response ET: LUNAME NETWORK1.LUNAME1 LUNAME3 NID2.LUNAME4 *92232/114253* ENQCT 5 5 0 DEQCT 3 4 0 QCT 2 1 0 Entry ET: /DISPLAY LU ’network1.luname1’ TPNAME tpname1 badtpnme Response ET: LUNAME/TPNAME NETWORK1.LUNAME1 -TPNAME1 -BADTPNME *92232/114253* ENQCT DEQCT 0 0 IS INVALID Entry ET: /DISPLAY LU ALL INPUT Response ET LUNAME NET1.LU1 NET2.LU1 LU3 528 #APPC-CONV 0 STO,TRA 0 0 STO,TRA Commands, Volume 1: IMS Commands A - M QCT 0 STO CONVCT 2 1 0 NET4.LU3 NET5.LU5 FUTURE INPUT: STO,TRA *93069/114435* 0 STO 0 TRA Entry ET: /DISPLAY LU ALL OUTPUT Response ET: LUNAME NET1.LU1 NET2.LU1 LU3 NET4.LU3 NET5.LU5 FUTURE OUTPUT: *93069/114435* ENQCT 0 0 0 0 0 STO,TRA DEQCT 0 0 0 0 0 QCT 0 0 0 0 0 CONVCT 0 STO 0 TRA 0 STO,TRA 0 TRA 0 STO Entry ET: /DISPLAY LU L62MVS1 LU1 CTA73 QCNT Response ET: LUNAME DEBVMU00.CTA73 L62MVS1 CTA73 NTWKA.CTA73 L62MVS1 NTWKA.CTA73 LU1 *03202/143132* GBLQCT 8 22 6 16 26 4 0 AFFINITY SYS3 SYS3 SYS3 SYS3 IMS2 IMS2 Entry ET: /DIS LU CTA73 TPNAME ALL QCNT Response ET: LUNAME/TPNAME GBLQCT AFFINITY DEBVMU00.CTA73 -DFAASYNC 8 SYS3 CTA73 -TPNM012345678901+ 6 SYS3 234567890123456789012345678901234567890123456789 NTWKA.CTA73 -TP100 4 IMS2 -TP100 16 SYS3 *03202/143204* Entry ET: /DIS LU LU100 TPNAME TP100 TP300 TP200 QCNT Response ET: LUNAME/TPNAME NTWK2.LU100 -TP100 NTWK1.LU100 -TP100 -TP200 LU100 -TP300 *03202/143201* GBLQCT AFFINITY 8 IMS2 8 10 IMS2 IMS2 0 Chapter 26. /DISPLAY commands 529 Entry ET: /DIS LU SIDENAME TPNAME DFSSIDE QCNT Response ET: LUNAME/TPNAME SIDENAME -DFSSIDE *03202/143231* GBLQCT 9 AFFINITY IMS2 Related reference: Chapter 2, “Command keywords and their synonyms,” on page 63 /DISPLAY MASTER command Use the /DISPLAY MASTER command to display the logical terminal name and the line and physical terminal number associated with the master terminal. If the 3270 master terminal capability was generated during IMS system definition, the logical terminal name, line, and physical terminal number of the secondary master terminal are also displayed. Subsections: v “Environment” v “Syntax” v “Equivalent IMS type-2 commands” v “Examples” Environment The /DISPLAY MASTER command is valid in DB/DC and DCCTL environments. Syntax /DISPLAY /DIS MASTER Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY MASTER command and the IMS type-2 commands that perform similar functions. Table 246. Type-2 equivalents for the /DISPLAY MASTER command Task /DISPLAY MASTER command Similar IMS type-2 command Displays the primary and secondary master terminal. /DISPLAY MASTER QUERY LTERM STATUS(MTO,SMTO) Examples Entry ET: /DISPLAY MASTER Response ET: 530 Commands, Volume 1: IMS Commands A - M LTERM MASTER PTERM 31 *89117/130245* Related reference: QUERY LTERM command (Commands) /DISPLAY MODIFY command Use the /DISPLAY MODIFY command to display online change status for this IMS, which is participating in a local or global online change. The command displays the following information: v Online change libraries v Work in progress for resources to be deleted or changed by a /MODIFY COMMIT or a INITIATE OLC PHASE(PREPARE) command v Resources to be added, changed, and deleted by a /MODIFY COMMIT or an INITIATE OLC PHASE(COMMIT) command Subsections: v “Environment” v “Syntax” on page 532 v “Keywords” on page 532 v v v v “Usage notes” on page 534 “Equivalent IMS type-2 commands” on page 534 “Output fields” on page 534 “Examples” on page 539 Environment The /DISPLAY MODIFY command is valid in DB/DC, DBCTL, and DCCTL environments. The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 247. Valid environments for the /DISPLAY MODIFY command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X MODIFY X X X ADDS X X X ALL X X X CHNGS X X X DBS X X DELS X X DMS X X FMS X MODS X X X PDS X X X PSS X X X X X Chapter 26. /DISPLAY commands 531 Table 247. Valid environments for the /DISPLAY MODIFY command and keywords (continued) Command / Keywords DB/DC DBCTL DCCTL RCS X X TRS X X Syntax /DISPLAY /DIS MODIFY ADDS ALL CHNGS DBS DELS DMS FMS MODS PDS PSS RCS TRS Keywords The following keywords are valid for the /DISPLAY MODIFY command: <blanks> Displays the status of online change libraries. ADDS Displays the resources to be added by online change. Each display line contains a resource type, resource name, and a status of ADDED. The resource type can be: DATABASE, DMB, FORMAT, PROGRAM, PSB, RT CODE, or TRAN. ALL Displays the status of online change libraries and any work in progress for database, program, routing code, or transaction resources to be deleted or changed by the /MODIFY COMMIT or the INITIATE OLC PHASE(COMMIT) command. For DBCTL, transactions do not apply. For DCCTL, databases do not apply. CHNGS Displays the resources to be changed by online change. Each display line contains a resource type, resource name, and a status of CHANGED. Resource type can be: DATABASE, DMB, FORMAT, PROGRAM, PSB, RT CODE, or TRAN. DBS Displays the databases to be changed or deleted with work in progress that would prevent /MODIFY COMMIT from succeeding. If DBS is specified with the ADDS, CHNGS, DELS, or MODS parameters, the databases in MODBLKS to be added, changed, or deleted display. Each display line contains a resource type of DATABASE, the database name, and a status of ADDED, CHANGED, or DELETED. 532 Commands, Volume 1: IMS Commands A - M DELS Displays the resources to be deleted by online change. Each display line contains a resource type, resource name, and a status of DELETED. The resource type can be: DATABASE, DMB, FORMAT, PROGRAM, PSB, RT CODE, or TRAN. DMS If DMS is specified with the ADDS, CHNGS, DELS, or MODS parameters, the DMBs in ACBLIB to be added, changed, or deleted display as ADDED, CHANGED, or DELETED. If the status of the associated database in MODBLKS is ADDED, DMS displays a DMB as ADDED. If the status of the associated database in MODBLKS is DELETED, DMS displays a DMB as DELETED. FMS If FMS is specified with the ADDS, CHNGS, DELS, or MODS parameters, the MFS formats to be added, changed, or deleted in FMTLIB display. Each display line contains a resource type of FORMAT, the format name, and a status of ADDED, CHANGED, or DELETED. MODS Displays the resource to be modified by online change, which are resources to be added, changed, and deleted. Each display line contains the resource type, resource name, and a status of ADDED, CHANGED, or DELETED. The resource type can be: DATABASE, DMB, FORMAT, PROGRAM, PSB, RT CODE, or TRAN. /DISPLAY MODIFY MODS shows all of the resources to be added, changed, or deleted by /MODIFY COMMIT, which is equivalent to the output from /MODIFY PREPARE with the LTERM keyword specified. PDS Displays the programs to be changed or deleted in MODBLKS with work in progress that would prevent a /MODIFY COMMIT or an INITIATE OLC PHASE(COMMIT) command from succeeding. If PDS is specified with the ADDS, CHNGS, DELS, or MODS parameters, the programs in MODBLKS to be added, changed, or deleted display. Each display line contains a resource type of PROGRAM, the program name, and a status of ADDED, CHANGED, or DELETED. PSS If PSS is specified with the ADDS, CHNGS, DELS, or MODS parameters, the PSBs in ACBLIB to be added, changed, or deleted display as ADDED, CHANGED, or DELETED. If the status of the associated program in MODBLKS is ADDED, PSS displays a PSB as ADDED. If the status of the associated program in MODBLKS is DELETED, PSS displays a PSB as DELETED. RCS Displays the routing codes to be changed or deleted in MODBLKS with work in progress that would prevent a /MODIFY COMMIT or an INITIATE OLC PHASE(COMMIT) command from succeeding. If RCS is specified with the ADDS, CHNGS, DELS, or MODS parameters, RTCODEs in MODBLKS to be added, changed, or deleted display. TRS Displays the transactions to be changed or deleted in MODBLKS with work in progress that would prevent a /MODIFY COMMIT or an INITIATE OLC Chapter 26. /DISPLAY commands 533 PHASE(COMMIT) command from succeeding. If TRS is specified with the ADDS, CHNGS, DELS, or MODS parameters, transactions in MODBLKS to be added, changed, or deleted display. Usage notes The /DISPLAY MODIFY command with one or more keywords (not including ALL) is only valid if IMS is in the MODIFY PREPARE state, which means that a /MODIFY PREPARE command or an INITIATE OLC PHASE(PREPARE) command completed successfully. If IMS cannot access the global queue counts, IMS displays the GLOBAL QUEUE COUNT INTERNAL ERROR status. If IMS cannot obtain sufficient storage to query global queue counts, IMS displays the GLOBAL QUEUE COUNT STORAGE ERROR status. In either case, online change will fail if there are global queue counts for resources being changed or deleted. For an IMS that has online change for MODBLKS disabled and no MODBLKS data sets are included in the IMS JCL, no information about active and inactive MODBLKS data sets is displayed. Equivalent IMS type-2 commands The following table shows variations of the /DISPLAY MODIFY command and the IMS type-2 commands that perform similar functions. Table 248. Type-2 equivalents for the /DISPLAY MODIFY command. Task /DISPLAY MODIFY command Displays work in progress for runtime /DISPLAY MODIFY ALL resource definitions that would cause a DELETE, /MODIFY COMMIT, INITIATE OLC PHASE(COMMIT), or UPDATE command to change resource definitions to fail. Similar IMS type-2 command QUERY DB NAME(dbname) SHOW(WORK) QUERY PGM NAME(pgmname) SHOW(WORK) QUERY RTC NAME(rtcode) SHOW(WORK) QUERY TRAN NAME(tranname) SHOW(WORK) Output fields The online change libraries are described in the output in the following order: the word “LIBRARY”, the library name, the library status displayed as A for active, I for inactive, or U for unallocated, and the data set in which the library resides. If the ACBLIB data sets are allocated by JCL, the status displayed for each library is displayed as A for active or I for inactive. It is followed by the DD names and data set names that make up the library. If the ACBLIB data sets are allocated by DFSMDA, the status of the inactive ACBLIB data sets is displayed as U for unallocated. The data set names displayed are those specified in the DFSMDA member for that ACBLIB DD statement. Status information is displayed for the following libraries: v IMSACBA and IMSACBB v FORMATA and FORMATB v MODBLKSA and MODBLKSB 534 Commands, Volume 1: IMS Commands A - M The following output fields are displayed for the /DISPLAY MODIFY command. Resource type Resource type can be LIBRARY, DATABASE, PROGRAM, RTCODE, or TRAN. Resource name The name of the library, database, program, routing code, or transaction. Status Status of the resource or data set name, for a library. The following status terms are displayed by the /DISPLAY MODIFY command: ACTIVE The routing code rtcode is active. ADDED One of the following: v The database, DMB, MFS format, program, PSB, Fast Path routing code (RTCODE), or transaction resource is to be added by online change. v The DMB already exists in ACBLIB and its associated database is to be added to MODBLKS, making the database usable. v The PSB already exists in ACBLIB and its associated program is to be added to MODBLKS, making the program usable. AREAS OPEN: A DEDB database has open areas. One or more lines listing the open areas follow this line. CHANGED One of the following: v The database, DMB, MFS format, program, PSB, Fast Path routing code (RTCODE), or transaction resource is to be changed by online change. The prepare command has stopped queuing to transactions affected by the online change. Affected transactions are rejected from an input terminal until the online change is committed or aborted. Program-to-program switches are not rejected. Commit will fail for the resource to be changed, if it has work in progress. v The program is not to be changed, but is associated with a PSB whose JAVA attribute is to be changed. The program is treated as if it is to be changed, because a PSB scheduling attribute is changing. v The routing code is not to be changed, but references a PSB that is to be deleted. The routing code is treated as if it is to be changed, because it will no longer be usable. v The transaction is not to be changed, but references a PSB that is to be deleted. The transaction is treated as if it is to be changed, because it will no longer be usable. CHANGED (DSID CHANGED) The area is to be changed and the data set ID (area number) is to be changed. Attention: Actions must be taken to prevent damage to the area. See Online change, DEDBs, and Availability of IFP and MPP Regions (Database Administration). Chapter 26. /DISPLAY commands 535 CHANGED (TIMESTAMP ONLY) The PSB is to be changed, but only the time stamp is to be changed. The PSB is considered to be affected by the online change, even though nothing is really changing. CONVERSATION TERM/USER The transaction to be changed or deleted or the transaction referencing a program or database to be changed or deleted is in conversation. The terminal originating the conversational transaction and the conversation ID are also displayed. The terminal information displayed is: v nodename for VTAM terminals v nodename and username if an ETO user is signed on to the node v username for ETO users that signed off while in conversation v lin#-pte# (line and pterm number) for IMS-supported terminals v 1-SC for the system console CONVERSATION LUNAME An APPC logical unit originated the conversational transaction that is to be changed or deleted or that references a program or database to be changed or deleted. The LUNAME and conversation ID are also displayed. The LUNAME information is in the format of luname, or networkid.luname, if networkid-qualified. CONVERSATION TMEM/TPIP An OTMA tmember/tpipe originated a conversational transaction that is to be changed or deleted or that references a program or database to be changed or deleted. The tmember, tpipe and conversation ID are also displayed. The tmember and tpipe information is in the format of tmember.tpipe, where the tmember name can be up to 8 characters. DATABASE IN USE The database is in use by one or more active regions referencing the database. /DBD ACTIVE A /DBDUMP command is in progress for a database to be changed or deleted. /DBR ACTIVE A /DBRECOVERY command is in progress for a database to be changed or deleted. /DBR OR /STOP IN PROGRESS A /DBRECOVERY command or /STOP command is in progress for a DEDB database. DBR NEEDED FOR PARTITION A /DBRECOVERY command must be issued for the DB partition before the database can be changed or deleted by online change DELETED One of the following: v The database, DMB, MFS format, program, PSB, Fast Path routing code (RTCODE), or transaction resource is to be deleted 536 Commands, Volume 1: IMS Commands A - M by online change. The prepare command has stopped queuing to transactions affected by the online change. Affected transactions are rejected from an input terminal until the online change is committed or aborted. Program-to-program switches are not rejected. Commit will fail for the resource to be deleted, if it has work in progress. v The DMB is not to be changed, but references a database that is to be deleted. The DMB is treated as if it is to be deleted, because IMS will no longer have any information about the DMB. v The PSB is not to be changed, but references a program that is to be deleted. The PSB is treated as if it is to be deleted, because IMS will no longer have any information about the PSB. ELIGIBLE FOR SCHEDULING The transaction is eligible for scheduling and cannot be deleted or changed by online change. The transaction itself is being changed or deleted, or the program it references is being changed. Stop the transaction before attempting another online change commit. If the only thing being changed is the PSB associated with the program that the transaction references, the transaction might not need to be stopped. IN USE Queuing is in progress for this transaction (either terminal input or program-to-program switch). NOT CHANGED (DMB CHANGED ONLY) The PSB is not to be changed, but references a DMB that is to be changed or deleted. The PSB is considered to be affected by the online change, where commit will fail for work in progress. NOT CHANGED (PDIR/PSB CHANGE ONLY) One of the following: v The routing code is not to be changed, but references a PDIR or PSB that is to be changed. The routing code is considered to be affected by the online change, where commit will fail for work in progress. v The transaction is not to be changed, but references a PSB that is to be changed. This status does not apply to PSB attribute changes that affect scheduling, such as the JAVA attribute. The transaction is not affected by online change, so commit will succeed even if there is work in progress. NOT OPEN, BUT DBR NEEDED ON TRACKER The database is not open, but the area can be open, so the database needs to be taken offline by use of the /DBRECOVERY command. This can happen if the area is not stopped and the database is not open and prepared to be online changed on a tracker environment. The area can be open if log records type 5701 or 5950 are routed to the RSR tracking IMS from the active IMS while online change is in progress. It is then required that the database be taken offline in the case of database level change. The tracking suspend point (Suspended Log Sequence Number) is registered in the RECON data set when the area is stopped. After the online change committed successfully, and when the /STA AREA command is Chapter 26. /DISPLAY commands 537 entered, the online forward recovery (OFR) will open the area and all log records from the suspended point will be applied to the area. PSB SCHEDULED A program referencing a database to be changed or deleted is scheduled. QUEUING nn Messages are queued to the transaction or program; nn is the number of messages queued. Global queue counts represent the number of messages on the coupling facility list structure for the transaction or program. Q STRUCTURE IS UNAVAILABLE The queue structure is unavailable. IMS is unable to check the global queue count for transactions to be added, changed, or deleted. Commit is not permitted to proceed. The structure may be unavailable for one of the following reasons: v CQS is unavailable. v The MSGQ structure failed and it has not been rebuilt yet. v CQS lost connectivity to the MSGQ structure. RANDOMIZER: rndmname A DEDB database that has no work in progress lists the randomizer name (rndmname). The randomizer display lines are information only, not work in progress that would prevent online change commit from succeeding. This line is followed by a line with the randomizer name and status of LOADED or NOT LOADED. If the randomizer is shared by one or more DEDBs, another line is displayed with 'DEDBS SHARING RANDOMIZER:' followed by the randomizer name. Online change will not delete a randomizer that is shared by other DEDBs. This line is followed by one line for each DEDB sharing the same randomizer. RECOVERY IN PROGRESS A /RECOVER START command is in progress to recover one or more databases with the database recovery service. SAME (DSID CHANGED) The area is not to be changed, but the data set ID (area number) is to be changed. Attention: Actions must be taken to prevent damage to the area. See Online change, DEDBs, and Availability of IFP and MPP Regions (Database Administration). SCHEDULED The named resource (a transaction or program to be changed or deleted, or a program referencing a database to be changed or deleted) is scheduled. SUSPENDED The transaction to be changed or deleted is on the suspend queue. Work in progress for resources to be deleted or changed causes the /MODIFY COMMIT command to fail. You must wait for the work in progress to complete, or 538 Commands, Volume 1: IMS Commands A - M force it to complete (for example, by issuing a command), before issuing /MODIFY COMMIT. The following table lists the resource type, resource name, and the status displays for work in progress that would prevent the /MODIFY COMMIT command from completing successfully: Table 249. Work in progress for resources that prevent a successful /MODIFY COMMIT Resource type Resource name Status DATABASE dbname AREA areaname PROGRAM pgmname RTCODE TRAN rtcode tranname AREAS OPEN: /DBD ACTIVE /DBR ACTIVE /DBR OR /STOP IN PROGRESS DATABASE IN USE DBR NEEDED FOR PARTITION nnnn PSB SCHEDULED RANDOMIZER: rndmname RECOVERY IN PROGRESS OPEN RECOVERY IN PROGRESS SCHEDULED QUEUING nn GLOBAL QUEUE COUNT INTERNAL ERROR GLOBAL QUEUE COUNT STORAGE ERROR ACTIVE IN USE QUEUING nn SCHEDULED SUSPENDED CONVERSATION TERM/USER nodename ID= nnnn nodename username ID= nnnn username ID= nnnn lin#-pte# ID= nnnn 1- SC ID= nnnn GLOBAL QUEUE COUNT INTERNAL ERROR GLOBAL QUEUE COUNT STORAGE ERROR ELIGIBLE FOR SCHEDULING In a shared-queues environment, /DISPLAY MODIFY only shows local work in progress, except for the TRAN QUEUING status and the PROGRAM QUEUING status, for which this command shows the sum of local and global queue counts. That is, /DISPLAY MODIFY does not show whether there is work in progress for other IMS subsystems sharing the message queues. If the /DISPLAY MODIFY command shows no work in progress for the IMS subsystem which the command was issued, a /MODIFY COMMIT command can be issued for that IMS subsystem. Examples The following are examples of the /DISPLAY MODIFY command. Example 1 for /DISPLAY MODIFY command In these examples for /DISPLAY MODIFY, /MODIFY PREPARE has already succeeded. Entry ET: Chapter 26. /DISPLAY commands 539 /DISPLAY MODIFY ALL Response ET: LIBRARY IMSACBA (A) OLC.ACBLIB.ALL LIBRARY FORMATA (I) IMSQA.FMT1 LIBRARY MODBLKSA (A) I41RTS42.CMODBLKS LIBRARY IMSACBB (I) OLC.ACBLIB.ALL LIBRARY FORMATB (A) IMSQA.FMT1 LIBRARY MODBLKSB (I) I41RTS42.CMODBLK1 DATABASE OLCDB088 /DBR ACTIVE DATABASE OLCDB101 PSB SCHEDULED PROGRAM OLCPB021 SCHEDULED PROGRAM OLCPB109 SCHEDULED RTCODE OLCRC056 ACTIVE TRAN OLCTB105 QUEUING 1 TRAN CDEBTRN5 CONVERSATION TERM/USER 42 ID= 0009 TRAN OLCTB109 SCHEDULED TRAN CDEBTRN8 CONVERSATION TERM/USER L3270D ID= 0002 TRAN OLCTB111 QUEUING 5 TRAN CDEBTRN2 CONVERSATION TERM/USER DYNT0001 IMSUS01 ID= 0005 TRAN CDEBTRN3 CONVERSATION TERM/USER 121 ID= 0008 TRAN CDEBTRN1 CONVERSATION TERM/USER IMSUS12 ID= 0001 DISPLAY MODIFY COMPLETE *93336/093025* Entry ET: /DISPLAY MODIFY DBS Response ET: DATABASE CALENDER AREAS OPEN: AREA FEBRUARY AREA APRIL AREA JULY AREA AUGUST AREA SEPTEMBR AREA OCTOBER AREA DECEMBER DATABASE CALENDER RANDOMIZER: RMOD3 DEDBS SHARING RANDOMIZER: RMOD3 DATABASE DEDBJN21 RANDOMIZER: RMOD3 RMOD3 NOT LOADED DATABASE DEDBJN22 RANDOMIZER: RMOD5 RMOD5 NOT LOADED DISPLAY MODIFY COMPLETE *95299/161529* Entry ET: /DISPLAY MODIFY TRS Response ET: TRAN TRAN PROGRAM TRAN TRAN DISPLAY OLCFT112 QUEUING 2 OLCFT115 QUEUING 23 OLCFP115 QUEUING 1 CDEBTRN8 GLOBAL QUEUE COUNT INTERNAL ERROR OLCFT116 QUEUING 6 MODIFY COMPLETE *96193/135935* Explanation: Work is in progress that will cause online change to fail, because several transactions and a FP program have a global queue count on the shared queues. The global queue count for transaction CDEBTRN8 could not be determined because of an internal error. Example 2 for /DISPLAY MODIFY command 540 Commands, Volume 1: IMS Commands A - M Entry ET: /DISPLAY MODIFY MODS Response ET: DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I FORMAT 0C01_FF02A _O ADDED FORMAT 0C01_FF02B _O ADDED FORMAT 0C7F_FN01A _O CHANGED FORMAT 0C7F_FN01B _O CHANGED FORMAT 0C7F_FN01C _O CHANGED FORMAT 0C7F_FF04A _O DELETED FORMAT MF04E DELETED DATABASE OLCDB101 ADDED DATABASE OLCDB102 ADDED DATABASE OLCDB103 ADDED DATABASE OLCDB104 ADDED DATABASE OLCDB157 ADDED DATABASE OLCDB111 DELETED DATABASE OLCDB159 DELETED DATABASE OLCDI105 DELETED DATABASE OLCDI106 DELETED DMB OLCDB101 ADDED DMB OLCDB102 ADDED DMB DEDBJN24 CHANGED AREA DB24A000 CHANGED DMB OLCDB105 DELETED PROGRAM OLCFP107 ADDED PROGRAM OLCFP108 ADDED PROGRAM OLCPB101 ADDED PROGRAM OLCFP109 CHANGED PROGRAM OLCFP110 CHANGED PROGRAM OLCFP111 CHANGED PROGRAM OLCPB105 DELETED PROGRAM OLCPB106 DELETED PSB OLCFP107 ADDED PSB OLCFP108 ADDED PSB CDEBS CHANGED PSB OLCPB105 DELETED PSB OLCPB106 DELETED RT CODE OLCFT108 ADDED RT CODE OLCFR119 CHANGED RT CODE OLCFR117 DELETED TRAN OLCFT108 ADDED TRAN OLCTBG17 ADDED TRAN CDEBTRNA CHANGED TRAN CDEBTRN1 CHANGED TRAN CONV31X DELETED DISPLAY MODIFY COMPLETE *98356/094452* SYS3 Explanation: Displays resources to be modified (added, changed, or deleted) by online change. Example 3 for /DISPLAY MODIFY command Entry ET: /DISPLAY MODIFY ALL Response ET: LIBRARY LIBRARY IMSACBA (A) (A) (A) (A) FORMATA (A) (A) IMSTESTG.DELTALIB IMSTESTL.TNUC2 IMSTESTG.IMS61RC.ACBLIB IMSTESTG.IMS61R.ACBLIB IMSTESTG.MFS.OVERRIDE.FORM IMSTESTG.MFS.FORMAT Chapter 26. /DISPLAY commands 541 (A) IMSQA.FMT1 MODBLKSA (A) IMSBLD.I61RTS25.CMODBLKS IMSACBB (I) IMSTESTG.DELTALIB (I) IMSTESTL.TNUC3 (I) IMSTESTG.IMS61RC.ACBLIB (I) IMSTESTG.IMS61R.ACBLIB LIBRARY FORMATB (I) IMSTESTG.MFS.OVERRIDE.FORM (I) IMSTESTG.MFS.FORMAT (I) IMSQA.FMT1 LIBRARY MODBLKSB (I) IMSBLD.I61RTS25.CMODBLKS DATABASE DEDBJN21 RANDOMIZER: RMOD3 (1) RMOD3 LOADED (2) DEDBS SHARING RANDOMIZER: RMOD3 (3) DEDB DEDBJN22 DEDB DEDBJN23 DEDB DEDB3301 DATABASE DEDBJN22 RANDOMIZER: RMOD3 RMOD3 NOT LOADED DEDBS SHARING RANDOMIZER: RMOD3 DEDB DEDBJN21 DEDB DEDBJN23 DEDB DEDB3301 DATABASE DEDBJN23 RANDOMIZER: RMOD3 RMOD3 LOADED DEDBS SHARING RANDOMIZER: RMOD3 DEDB DEDBJN21 DEDB DEDBJN22 DEDB DEDB3301 NO WORK PENDING *99328/110535* SYS3 LIBRARY LIBRARY Explanation: In this example: v DEDB databases DEDBJN21, DEDBJN22, and DEDBJN23 have undergone Online Change. v After a database line for DEDBS displays, a line follows containing randomizer status (loaded or not loaded). v After the randomizer status displays, a line might follow containing DEDBS SHARING RANDOMIZER; this line is followed by DEDB lines listing the DEDBs that share the randomizer. Example 4 for /DISPLAY MODIFY command Entry ET: /DISPLAY MODIFY ALL Response ET: LIBRARY IMSACBA LIBRARY FORMATA LIBRARY LIBRARY MODBLKSA IMSACBB LIBRARY FORMATB LIBRARY MODBLKSB DATABASE DEDBJN21 542 (A) (A) (A) (A) (A) (A) (A) (A) (I) (I) (I) (I) (I) (I) (I) (I) Commands, Volume 1: IMS Commands A - M IMSTESTG.DELTALIB IMSTESTL.TEMPA.ACBLIB IMSTESTG.IMS800C.ACBLIB IMSTESTG.IMS800.ACBLIB IMSTESTG.MFS.OVERRIDE.FORMAT IMSTESTG.MFS.FORMAT IMSQA.FMT1 TEMPA.MODBLKS IMSTESTG.DELTALIB IMSTESTL.TEMPB.ACBLIB IMSTESTG.IMS800C.ACBLIB IMSTESTG.IMS800.ACBLIB IMSTESTG.MFS.OVERRIDE.FORMAT IMSTESTG.MFS.FORMAT IMSQA.FMT1 TEMPB.MODBLKS NOT OPEN, BUT DBR NEEDED ON TRACKER (1) DATABASE RMOD3 DATABASE RMOD5 DATABASE RMOD4 DATABASE DBFHDC44 DISPLAY DEDBJN21 RANDOMIZER: RMOD3 NOT LOADED DEDBJN22 RANDOMIZER: RMOD5 NOT LOADED DEDBJN24 RANDOMIZER: RMOD4 NOT LOADED THFP1WEB RANDOMIZER: DBFHDC44 NOT LOADED MODIFY COMPLETE *01303/085213* SYS3 Explanation: The DEDB database DEDBJN21 is prepared to be online changed on a tracker environment. If the AREA is not stopped and the database is not open, the AREA can be open if log records type 5701 or 5950 are routed to the RSR tracking IMS from the active IMS while Online Change is in progress. It is then required that the database be taken offline by use of the /DBRECOVERY command in the case of database level change. The tracking suspend point (Suspended Log Sequence Number) is registered in RECON when the AREA is stopped. After the online change committed successfully, and when the /STA AREA command is entered, the Online Forward Recovery will open the AREA and all log records from the suspended point will be applied to the AREA. Example 5 for /DISPLAY MODIFY command Entry ET: /DISPLAY MODIFY ALL Response ET: LIBRARY LIBRARY LIBRARY LIBRARY LIBRARY LIBRARY DISPLAY IMSACBA (A) IMSTESTG.DELTA1 (A) IMSTESTG.IMS10AC.ACBLIB1 (A) IMSTESTG.IMS10A.ACBLIB1 FORMATA (A) IMSTESTG.MFS.FORMAT1 (A) IMSTESTG.MFS.FORMAT2 (A) IMSQA.FMT1 MODBLKSA (A) IMSBLD.I10ATS17.COMBLKS1 IMSACBB (U) IMSTESTG.DELTA2 (U) IMSTESTG.IMS10AC.ACBLIB2 (U) IMSTESTG.IMS10A.ACBLIB2 FORMATB (I) IMSTESTG.MFS.FORMAT3 (I) IMSTESTG.MFS.FORMAT4 (I) IMSQA.FMT1 MODBLKSB (I) IMSBLD.I10ATS17.COMBLKS2 MODIFY COMPLETE *07003/110121* SYS3 TSO SPOC output: MBRNAME MESSAGES -------- ----------------------SYS3 LIBRARY IMSACBA (A) IMSTESTG.DELTA1 SYS3 (A) IMSTESTG.IMS10AC.ACBLIB1 SYS3 (A) IMSTESTG.IMS10A.ACBLIB1 SYS3 LIBRARY FORMATA (A) IMSTESTG.MFS.OVERRIDE.FORMAT1 SYS3 (A) IMSTESTG.MFS.FORMAT1 SYS3 (A) IMSQA.FMT1 SYS3 LIBRARY MODBLKSA (A) IMSBLD.I10ATS17.COMBLKS1 SYS3 LIBRARY IMSACBB (U) IMSTESTG.DELTA2 SYS3 (U) IMSTESTG.IMS10AC.ACBLIB2 SYS3 (U) IMSTESTG.IMS10A.ACBLIB2 SYS3 LIBRARY FORMATB (I) IMSTESTG.MFS.OVERRIDE.FORMAT2 SYS3 (I) IMSTESTG.MFS.FORMAT2 SYS3 (I) IMSQA.FMT2 SYS3 LIBRARY MODBLKSB (I) IMSBLD.I10ATS17.COMBLKS2 SYS3 DISPLAY MODIFY COMPLETE *07003/114249* Chapter 26. /DISPLAY commands 543 Explanation: In this example, IMSACBA is the active ACBLIB; IMSACBB is the inactive ACBLIB. The inactive ACBLIB data sets are displayed even though they are not allocated. The “U” indicates that they are unallocated. Example 6 for /DISPLAY MODIFY command Entry ET: /DISPLAY MODIFY ALL Response ET: DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I DFS000I LIBRARY LIBRARY LIBRARY LIBRARY LIBRARY LIBRARY DISPLAY IMSACBA (A) IMSTESTG.DELTALIB (A) IMSTESTG.IMS10AC.ACBLIB (A) IMSTESTG.IMS10A.ACBLIB FORMATA (A) IMSTESTG.MFS.FORMAT1 (A) IMSTESTG.MFS.FORMAT2 (A) IMSQA.FMT1 MODBLKSA (A) IMSBLD.I10ATS17.COMBLKS1 IMSACBB ( ) NO DFSMDA MEMBER FORMATB (I) IMSTESTG.MFS.FORMAT3 (I) IMSTESTG.MFS.FORMAT4 (I) IMSQA.FMT1 MODBLKSB (I) IMSBLD.I10ATS17.COMBLKS1 MODIFY COMPLETE *07003/110121* SYS3 Explanation: In this example, IMSACBA is the active ACBLIB; IMSACBB is the inactive ACBLIB. There is no DFSMDA member for the inactive ACBLIB data sets. The data set name field contains “NO DFSMDA MEMBER”. The status field is left blank. | Example 7 for /DISPLAY MODIFY command | | The following example shows an online HALDB database, DBVHDJ05, that is currently being altered. | | Entry ET: | | | | | | | | TSO SPOC output: /DISPLAY MODIFY DBS MbrName Messages -------- ----------------------IMS1 DATABASE DBOHIDK5 IMS1 DATABASE DBVHDJ05 IMS1 DATABASE DBVHDJ05 IMS1 DATABASE DBVHDJ05 DBR NEEDED FOR PARTITION ALTER INCOMPLETE 4 PSBS SCHEDULED DATABASE IN USE Related tasks: Online change, DEDBs, and Availability of IFP and MPP Regions (Database Administration) Related reference: “Status and attributes for the /DISPLAY command” on page 435 QUERY DB command (Commands) QUERY PGM command (Commands) QUERY RTC command (Commands) QUERY TRAN command (Commands) 544 Commands, Volume 1: IMS Commands A - M /DISPLAY MSNAME command Use the /DISPLAY MSNAME command to display the queue counts for the specified logical link path. Generic parameters are supported for the MSNAME keyword. Subsections: v “Environment” v “Syntax” v “Keywords” v “Usage notes” on page 546 v “Examples” on page 546 Environment The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords. Table 250. Valid environments for the /DISPLAY MSNAME command and keywords Command / Keywords DB/DC DBCTL DCCTL /DISPLAY X X X MSNAME X X QCNT X X Syntax /DISPLAY /DIS MSNAME msname msname* msname ALL QCNT Keywords The following keyword can be specified for the /DISPLAY MSNAME command: QCNT Specifies that global queue count information is to be displayed. If QCNT is not specified, local queue counts are displayed; when it is specified, no local queue counts are displayed. This count represents the message counts of messages that can be processed by the IMS system where the command is issued. This count includes messages that can be processed by any IMS system (messages with no affinity), plus messages that can be processed by the IMS system where the command is issued (messages with an affinity to the IMS system that issued the command). This keyword is valid only in a shared-queues environment. Chapter 26. /DISPLAY commands 545 Usage notes In a shared-queues environment, use the QCNT keyword to obtain the current message queue counts on the shared queues structure. The local queue counts (ENQCT, DEQCT, and QCT) value that is returned on this command when the QCNT keyword is not specified represents the messages being processed by the IMS system where this command is issued. Do not use local queue counts for queue evaluation purposes. | | | | | | Examples Entry ET: /DISPLAY MSNAME ALL Response ET: MSNAME ENQCT SYSTEM2A 0 SYSTEM2B 0 FRESNO 0 BOSTON 0 ALBANY 0 TEST1 0 *91350/053859* DEQCT 0 0 0 0 0 0 QCT 0 0 0 0 0 0 Entry ET: /DISPLAY MSNAME ALL Response ET: MSNAME ENQCT LINK23B4 0 LINK12V1 0 LINK23U2 0 ELINK211 0 LINK13B3 0 LINK13V 0 LINK12V 0 LINK13C2 0 LINK13X 0 LINK12V2 0 LINK13M2 0 LINK13V2 0 ELINK124 0 LINK23V1 0 LINK12B1 0 LINK12B2 0 LINK12Y 0 ELINK120 0 LINK13B4 0 LINK21V3 0 ELINK1MS 0 LINK12M1 0 LINK23V 0 LINK13U2 0 LINK23B3 0 ELINK224 0 LINK23X 0 LINK23V2 0 ELINK121 0 LINK23C2 0 LINK12U1 0 LINK23M2 0 ELINK122 0 546 DEQCT 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Commands, Volume 1: IMS Commands A - M QCT 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 IMS1 DYNAMIC IMS1 DYNAMIC DYNAMIC IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 DYNAMIC IMS1 IMS1 IMS1 IMS1 IMS1 DYNAMIC IMS1 IMS1 DYNAMIC IMS1 DYNAMIC DYNAMIC DYNAMIC DYNAMIC IMS1 DYNAMIC IMS1 DYNAMIC IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 IMS1 ELINK222 0 LINK12C1 0 LINK13V1 0 ELINK123 0 PTH3TSTB 0 *97258/175636* 0 0 0 0 0 0 0 0 0 0 DYNAMIC IMS1 IMS1 IMS1 IMS1 IMS1 /DISPLAY NODE command The /DISPLAY NODE command, when followed by a valid node name or ALL, displays status, queue counts, and number of messages sent to and received from the specified node. Subsections: v “Environment” v “Syntax” v “Keywords” on page 549 v “Usage notes” on page 551 v “Equivalent IMS type-2 commands” on page 552 v “Output fields” on page 552 v “Examples” on page 553 Environment The following table lists the ">
/
Scarica
Solo un promemoria. Puoi visualizzare il documento qui. Ma soprattutto, la nostra IA l''ha già letto. Può spiegare cose complesse in termini semplici, rispondere alle tue domande in qualsiasi lingua e aiutarti a navigare rapidamente anche nei documenti più lunghi o complicati.
Pubblicità