INGLKUP

Purpose

INGLKUP has three purposes:

  1. The INGLKUP command displays all jobs that are not controlled by SA z/OS®. You can either stop, cancel, or force those jobs with the corresponding MVS command.

    You can list all active jobs, started tasks (STCs), and APPC/MVS transaction programs. You can define an exclude list to tailor the list that is displayed.

  2. The INGLKUP command can also be used to obtain diagnostic information about a particular resource if you want to perform debugging.
  3. The INGLKUP command queries the automation manager and the various agents for the reasons why the resource concerned could not be brought into the desired status.

Syntax

1. Syntax for JOB display

Read syntax diagramSkip visual syntax diagram INGLKUP REQ=JOBQUAL=ALLQUAL=(*)APPCJOBSTCTIMEOUT= nnnCOMMAND=command1TARGET=system_namedomain_idsaplex_nameOUTDSN= dsnameOUTMODE=LINEAUTONETLOG
Notes:
  • 1 Line Mode only

2. Syntax for diagnostic display

Read syntax diagramSkip visual syntax diagram INGLKUP resource REQ=COLLECTTARGET=system_namedomain_idsaplex_nameOUTDSN= dsnameOUTMODE=LINEAUTONETLOG

3. Syntax for analyse function

Read syntax diagramSkip visual syntax diagram INGLKUP resource REQ=ANALYSESTATE=UPDOWNTARGET=system_namedomain_idsaplex_nameOUTDSN= dsnameOUTMODE=LINEAUTONETLOGTIMEOUT= nnnWAIT= nnn

Parameters

REQ
Specifies the type of request to be performed.
JOB
Displays all jobs, started tasks, and APPC/MVS transaction programs that are not controlled by SA z/OS. Note that the term JOB includes batch jobs, started tasks, and APPC/MVS programs.
COLLECT
Causes diagnostic information to be displayed in the netlog if OUTDSN is not specified.
ANALYSE (deprecated)
Reports possible reasons why the resource concerned could not be brought into the desired state.

Use INGWHY command instead.

resource
Specifies the name of the resource to be processed. The format is name{/type{/system}}. Wildcard is supported. If more than one resource matches the wildcard specification, a selection panel is displayed.

Not all resource types are supported. Message ING178I is issued if no resource matches the specified pattern or if the resource type is not supported.

A resource specification is valid only with REQ=COLLECT or REQ=ANALYSE.

QUAL
Specifies the type of "job" to be displayed. QUAL can be ALL, JOB, STC, APPC, or *. The default is ALL. You can specify more than one qualifier by enclosing the qualifiers in parentheses.
COMMAND
Specifies the command to be issued in order to terminate the jobs/started tasks (STC). Valid entries are STOP, CANCEL, or FORCE. These commands may be abbreviated. This parameter is used with Line Mode only.
STATE
Specifies the state the resource should be in:
UP
Resource is available.
DOWN
Resource is in a "DOWN" state.
TIMEOUT
Specifies the maximum number of seconds the INGLKUP command waits for responses from the remote system that the command was sent to. The maximum is 999 seconds. The default is 30 seconds.
WAIT
Specifies the number of seconds to wait before reporting that a timeout occurred if the automation manager does not provide the requested data. The maximum time interval is 999 seconds. If omitted, the time interval is 30 seconds.
TARGET
For information on the TARGET parameter, see TARGET Parameter.
OUTDSN
For information on the OUTDSN parameter, see OUTDSN Parameter. The record length must be at least 80 bytes if a resource is specified or 256 bytes if no resource is specified.
OUTMODE
For information on the OUTMODE parameter, see OUTMODE Parameter.

Restrictions and Limitations

INGLKUP issues the MVS D J,L command to get all active jobs. Then the REXX system address spaces are added to this list through the MVS D A,AXR* command.

With the DISPSTAT command, the list of subsystems managed by System Automation is obtained. For the INGLKUP display, the two lists are compared, also taking the user-defined exclude list into consideration. System address spaces other than AXR* are not displayed.

INGLKUP may display subsystem address spaces if the subsystems are NON-MVS subsystems but are represented by an MVS address space. This occurs, for example, in the case of the IMS PPI dependent region.

Usage

1. Exclude List for REQ=JOB: An exclude list may be built by using User Entry Type (UET) pairs. The exclude list allows the automation administrator to reduce the list of active jobs that are shown when REQ=JOB.

The UET data is specified in the policy database as follows:
Entry
INGLKUP
Type
EXCLUDE
Keyword/Data
JOB
Data
Is JOB=jobname (where jobname specifies the JOB or STC to be excluded from the display). Wildcard is supported in jobname. For more information, refer to IBM Z System Automation Defining Automation Policy.
2. Output for REQ=COLLECT: If you specify a resource name with REQ=COLLECT, the output from one or more of the following commands is collected depending on the resource type:
  • INGINFO
  • INGRELS
  • INGSCHED
  • DISPAPG
  • DISPINFO
  • DISPMTR
  • DISPTRG

If you do not specify a resource name with REQ=COLLECT, the output from the following commands is collected:

  • INGLIST
  • INGSESS
  • DISPMTR
  • DISPSTAT

Whether you specify a resource name or not, output from the following commands is always displayed with REQ=COLLECT:

  • INGAMS
  • INGHIST
  • INGVOTE

Examples

If you specify inglkup and cancel a job with command code C, a panel similar to Figure 1 is displayed.
Figure 1. INGLKUP Command Dialog Panel
 INGKYLU0                  SA z/OS  - Command Dialogs      Line  1    of 24     
 Domain ID   = IPSFP     ---------- INGLKUP  ----------    Date = 04/12/12      
 Operator ID = NETOP1          System  = KEY4              Time = 14:36:17      
                                                                                
 Cmd:  C cancel job       F force job       P stop job                          
                                                                                
 Cmd Job       Step      Procedure Type  ASID  System                           
 --- --------  --------  --------- ----  ----  --------                         
     AMST      AMST      AMPROC    SO          KEY4                             
     AMST2     AMST2     AMPROC    SO          KEY4                             
     APPC      APPC      APPC      S           KEY4                             
     ASCH      ASCH      ASCH      S           KEY4                             
     BTSO      BTSO      AAAZSSEM  S           KEY4     ** CANCELLED **         
     CU12      STEP1     CU12      AO    0049  KEY4                             
     CU12      STEP1     CU12      AO    005A  KEY4                             
     CU129     STEP1     CU12      AO          KEY4                             
     FTPD1     STEP1     FTPOE     AO          KEY4                             
     FTPOE1    STEP1     FTPOE     AO          KEY4                             
                                                                                
 Command ===>                                                                   
    PF1=Help     PF2=End        PF3=Return                      PF6=Roll        
                 PF8=Forward    PF9=Refresh                    PF12=Retrieve

This panel displays all active jobs, started tasks (STC) and APPC/MVS transaction programs that are not controlled by SA z/OS. You can either stop or cancel or even force the job (or jobs).

For each job the following information is shown:

  • The Cmd field lets you specify the command codes shown on the panel. Type the appropriate letter next to the job name and press Enter. The following command codes are available:
    C
    Cancel the job.
    F
    Force the job.
    P
    Stop the job.
  • The Job field shows the job name.
  • The Step field the step name.
  • The Procedure field shows the procedure step name.
  • The Type field shows the job type.
  • The ASID field shows the address space ID (this is only present if the job name is not unique).
  • The System field shows the name of the system that the job is running on.

The SORT, FIND, and RFIND subcommands are supported. See Varying the Format of the Command Output for information.

If you specify REQ=ANALYSE for the INGLKUP command, the following panel is displayed:
Figure 2. INGLKUP Command Dialog Panel for the ANALYSE Option
 INGKYLU2                  SA z/OS  - Command Dialogs      Line                 
 Domain ID   = IPUNA     ---------- INGLKUP  ----------    Date = 12/14/11      
 Operator ID = OPER1           Sysplex = AOCAPLEX          Time = 14:13:25      
                                                                                
  Resource  =>  PMTRB3/MTR/AOC5                      Examined State ==>  UP     
  Target    =>              System name, domain ID or sysplex name              
                                                                                
 Name        Type System    Cat  Problem                                        
 ----------- ---- --------  ---  ---------------------------------------------- 
 PMTRB3      MTR  AOC5      Pot  AM Observed status is UNKNOWN                  
 PMTRB3      MTR  AOC5      Pot  AM Automation status is UNKNOWN                
 PAPLMTRA    APL  AOC5      Pot  AM Observed status is UNKNOWN                  
 PAPLMTRA    APL  AOC5      Pot  AM Automation status is UNKNOWN                
 PAPLMTRB    APL  AOC5      Pot  AM Observed status is UNKNOWN                  
 PAPLMTRB    APL  AOC5      Pot  AM Automation status is UNKNOWN                
                                                                                
                                                                                
                                                                                
  Command ===>                                                                  
    PF1=Help     PF2=End        PF3=Return                      PF6=Roll        
                                PF9=Refresh                    PF12=Retrieve