INGIMS
Purpose
The INGIMS command lets you:
- Issue both type-1 and type-2 IMS commands, and to issue those commands against an IMSplex and its members.
- Broadcast messages to all or selected IMS users.
- Issue a list of defined transactions or commands and view the output.
- Display the output of IMS transactions in fullscreen or pipeable line mode.
Syntax
Parameters
- resource
- The resource specifies the name of the IMS subsystem that the command is issued to.
The format is subsystem[/APL[/system]], where the subsystem is the
specific name of the desired IMS subsystem
and system is the name of the system that the IMS is running on. Note: If you specify REQ=XCMD or REQ=XINFO, SA z/OS® determines the IMSplex name that the IMS subsystem belongs to and routes the command to that IMS.
- REQ
- Specifies the request to be issued to the IMS subsystem. It can be one of the following:
- CMD
- Issues the specified IMS command
or transaction and displays the results. The command is forwarded
to IMS using its console interface.
Enclose the command in single or double quotation marks if the command and parameters contain spaces.
REQ=CMD is the default.
Note: Do not specify the prefix character, forward slash (/), for IMS commands. - XCMD
- This is the same as CMD but the command is forwarded to IMS via the IMS Operations Manager if either the IMSPLEX
parameter is specified or an IMSplex name for the given resource is
available in the policy. IMS type
2 commands are also supported in that case. Otherwise the console
interface is used that supports only type-1 commands. However, the
output is formatted in the same way in either case. Note: Do not specify the prefix character, forward slash (/), for IMS commands.
- INFO
- Issues a set of predefined commands and displays the results. The list of commands is obtained from the user-defined keyword-data pairs for the IMSINFO message ID in the policy of the subsystem that is specified by the resource name. The individual commands are executed as with CMD.
- XINFO
- This is the same as INFO but the individual commands are executed as with XCMD.
- BROADCAST
- Issues an IMS broadcast to all or selected users.
- DEP
- Displays the dependent region associated with the control region.
- TCO
- Displays the details about the IMS Timed Control Operations function.
- IMSPLEX
- Specifies the IMSplex name.
- MEMBERS
- Identifies a list of members where the command should be executed.
It can be:
- Asterisk (*), which causes the command to be forwarded to all registered command processing clients in the IMSplex.
- Percent sign (%), which causes the command to be forwarded to one registered command processing client with MASTER capability.
- A list of member names or type identifiers, or both. The type identifiers are subcategories of the category IMS (that is, DBCTL, DCCTL, DBDC, or FDBR) and must be preceded by an asterisk, for example, *DCCTL or *FDBR. *CTL can be used as shorthand for "*DBCTL *DCCTL *DBDC".
- RESP
- Specifies whether output should be returned to the caller or not. RESP is optional and the default is YES
- CMDWAIT
- Specifies the maximum wait time for a command to complete. CMDWAIT is optional and the default is the value of CGLOBAL WAITTIME.
- MSG
- Specifies the message to be sent to all or selected IMS terminals or users for the REQ=BROADCAST
request. Enclose the message in single or double quotation marks.
For REQ=CMD the MSG parameter can be used to contain a list of words that will be used to end processing if they are received anywhere in the output results. The words will normally be a required message ID. If no words are entered the CMD will be processed until any result is received.
- ROUTE
- Specifies the IMS routing information used to select the IMS terminals or users are to receive the message for a REQ=BROADCAST request. The contents of the ROUTE parameter are the parameters to be supplied to the /BRO transaction to route messages to IMS terminals or users. See the /BRO transaction for the details of the parameters for that transaction.
- TARGET
- For information on the TARGET parameter, see TARGET Parameter.
- OUTDSN
- For information on the OUTDSN parameter, see OUTDSN Parameter.
- OUTMODE
- For information on the OUTMODE parameter, see OUTMODE Parameter.
Restrictions and Limitations
To use the INGIMS command, system operations must be initialized. IMS subsystems must be enabled for system console commands using the MCS/E-MCS Console.
Usage
The INGIMS command operates sysplexwide. For an overview see Overview of Commands that Operate Sysplexwide.
Examples
ingims a
panel similar to Figure 1 is displayed. EVIKYCMD SA z/OS - Command Dialogs Line
Domain ID = IPSFM ---------- INGIMS ---------- Date = 06/08/09
Operator ID = NETOP1 Time = 15:08:38
Resource => SREL1 -or- IMSPlex name =>
IMS Members =>
Target => System name, domain ID or sysplex name
Request => XCMD CMD or XCMD, INFO or XINFO, BROADCAST, DEP, TCO
IMS Command =>
Response => YES Yes/No Command wait time => 60 (seconds)
IMS Route =>
IMS Message =>
=>
Command ===>
PF1=Help PF2=End PF3=Return PF6=Roll
PF9=Refresh PF12=Retrieve
- The Resource field shows the name of the IMS subsystem to be used for issuing the requests. The format is name/type[/system]. Wildcards are supported.
- The IMSPlex name field shows the name of the IMSplex.
- The IMS Members field identifies the members where the commands should be processed. The IMS is either named by its subsystem ID or its type identifier. Type identifiers are DB, DC, FDBR, CQS, and so on. You must prefix the type identifier with an asterisk (*), for example, *DBDC. You can use *CTL as shorthand for *DB *DC *DBDC.
- The Target field shows the name of the system (system name, domain ID, or sysplex name) that the command should be routed to. Specifying this is only necessary if the resources do not reside in the local sysplex.
- The Request field shows the request to be carried
out. It can be CMD, BROADCAST, INFO, XCMD, or XINFO. Note: If you specify XCMD or XINFO, you must use either the IMSPlex name or IMS Members field, or both, to specify the destination of the request.
- The IMS Command field shows the IMS transaction to be executed on the IMS subsystem specified by the resource field.
- The Response field indicates whether the output should be returned to the caller.
- The Command wait time field specifies the maximum wait time for a command to complete. The default is the value of WAITTIME common global variable.
- The IMS Route field shows the routing parameters for the /BRO command when the request is BROADCAST.
- The IMS Message field shows the message to be sent to users/terminals for the BROADCAST request.
The output from the IMS transaction appears in the blank area below the IMS Message field.
INGIMS EIMSDBRC REQ=BROADCAST a panel similar to
Figure 2 is displayed.
EVIKYCMD SA z/OS - Command Dialogs Line
Domain ID = IPSFM ---------- INGIMS ---------- Date = 06/08/09
Operator ID = NETOP1 Time = 15:11:23
Resource => EIMSDBRC/APL/AOC8 -or- IMSPlex name =>
IMS Members =>
Target => System name, domain ID or sysplex name
Request => BROADCAST CMD or XCMD, INFO or XINFO, BROADCAST, DEP, TCO
IMS Command => BROADCAST
Response => Yes/No Command wait time => (seconds)
IMS Route => ACTIVE
IMS Message =>
=>
Command ===>
PF1=Help PF2=End PF3=Return PF6=Roll
PF9=Refresh PF12=Retrieve
INGIMS
REQ=XCMD CMD=’DIS ACT’ output similar to the following is
displayed in a NetView window
(which allows you to scroll through the output): OM=IMSAA1OM Rc=00000000 Rsn=00000000
Master=MAC1 User=STCUSER Cmd=DIS ACT
MbrName MsgData
MAA1 REGID JOBNAME TYPE TRAN/STEP PROGRAM STATUS CLASS
MAA1 4 IMSAA1M1 TP WAITING 1
MAA1 JMPRGN JMP NONE
MAA1 JBPRGN JBP NONE
MAA1 BATCHREG BMP NONE
MAA1 1 IMSAA1F1 FPM NO MSG. DFSIVP4
MAA1 3 IMSAA1F3 FPM NO MSG. DBFSAMP3
MAA1 DBTRGN DBT NONE
MAA1 IMSAA1RC DBRC
MAA1 IMSAA1DL DLS
MAA1 VTAM ACB OPEN -LOGONS ENABLED
MAA1 IMSLU=N/A.N/A APPC STATUS=DISABLED TIMEOUT= 0
MAA1 OTMA GROUP=N/A STATUS=NOTACTIVE
MAA1 APPC/OTMA SHARED QUEUE STATUS - LOCAL=INACTIVE GLOBAL=INACTIVE
MAA1 APPC/OTMA RRS MAX TCBS - 40 ATTACHED TCBS - 1 QUEUED RRSWKS-
MAA1 APPLID=IPXAGIA1 GRSNAME= STATUS=DISABLED
MAA1 LINE ACTIVE-IN - 1 ACTIV-OUT - 0
MAA1 NODE ACTIVE-IN - 0 ACTIV-OUT - 0
MAA1 *09139/155812*If
you specify, for example, INGIMS REQ=XINFO output
similar to the following is displayed: QUERY CQS DATA--------------------------------------------------------------
OM=IMSAA1OM Rc=00000000 Rsn=00000000
Master=MAC1 User=STCUSER Cmd=DIS CQS
MbrName MsgData
MAA1 DFS4444I DISPLAY FROM ID=MAA1
MAA1 JOBNAME VERS# STATUS
MAA1 IMSAA1SQ 1.5 CONNECTED
MAA1 *09148/174750*
DISPLAY COORDINATOR CONTROLLERS---------------------------------------------
OM=IMSAA1OM Rc=00000000 Rsn=00000000
Master=MAC1 User=STCUSER Cmd=DIS CCTL
MbrName MsgData
MAA1 DFS4444I DISPLAY FROM ID=MAA1
MAA1 CCTL STATUS
MAA1 IMSAA1SQ 1.5 CONNECTED
MAA1 *09148/174715*Note that a separator line
is inserted between the individual command outputs.INGIMS IMSPLEX=IMXPLEX_1 MEMBERS=*CTL REQ=XCMD CMD=’QUERY AREA’ OUTMODE=LINEIf you wish to view IMS dependent regions, use the INGIMS command dialog with REQ=DEP and the following screen is displayed:
EVIKYDP0 SA z/OS - Command Dialogs Line 1 of 5
Domain ID = IPSFP ---- Dependent Regions ----- Date = 08/03/07
Operator ID = OPER Time = 12:44:37
Control Reg.= IMSCTL/APL/KEY4
CMD: A Update B Start C Stop D INGRELS E INGVOTE F INGINFO
H DISPTRG I INGSCHED N /ASSIGN P /PSTOP / scroll
CMD Name Type System Reg.Id Type Trans/Step Program IMS Status
--- ----------- ---- ------ ------ ---- ---------- -------- ----------------
IMSDBRC APL KEY4 DBRC
IMSDLS APL KEY4 DLS
IMSFP1 APL KEY4 1 FPME NO MSG. DFSIVP4
IMSMP1 APL KEY4 2 TP WAITING
IMSPPI APL KEY4 3 BMP IMS941PP EVIRYPPI
Command ===>
PF1=Help PF2=End PF3=Return PF6=Roll
PF9=Refresh PF10=Previous PF11=Next PF12=Retrieve
