IOAGATE

Overview
IOAGATE EXEC Parameters
IOAGATE Modify Commands
Diagnostic SNAP Modify Commands

OverviewLink copied to clipboard

This chapter contains a brief overview of the IOAGATE and its components, followed by the parameters and commands that an administrator needs to operate IOAGATE.

IOAGATE is a mainframe software communications gateway (middleware) that enables INCONTROL mainframe applications to communicate with other mainframe and non-mainframe applications over the network.

Client applications access INCONTROL products by means of an application server through IOAGATE.

The following figure shows IOAGATE components:

Figure 98 IOAGATE Components

IOAGATE supports multiple concurrent application servers of different applications and their clients. A single IOAGATE can support Control‑M, Control‑D/Page On Demand, Control‑D File Transfer option, and Control‑O applications.

BMC recommends that you read the detailed explanation of all aspects of IOAGATE installation and configuration that is provided in "IOAGATE Installation and Configuration Considerations", in the INCONTROL for z/OS Installation Guide: Installing.

Link copied to clipboard

IOAGATE EXEC ParametersLink copied to clipboard

This section describes the startup EXEC parameters in the IOAGATE STC job or in the start command that are used to alter IOAGATE behavior.

TRACELink copied to clipboard

PurposeLink copied to clipboard

Handling of IOAGATE traces.

SyntaxLink copied to clipboard

Table 257 Syntax for Parameter TRACE

Syntax	Description
TRACE=<trace list>	Samples of trace list formats:
TRACE=20	Turn ON trace level 20
TRACE=(21,200)	Turn ON trace levels 21 AND 200
TRACE=-200	Turn OFF trace levels 200
TRACE=(-21,-40)	Turn OFF trace levels 21 AND 40
TRACE=(1:512)	Turn ON all trace levels
TRACE=(-1:-512)	Turn OFF all trace levels
TRACE=SHOW	Show current trace levels

For example, to set TRACE parameter to ‘SHOW’ and PSFX parameter to ‘W’, do one of the following:

In an STC Job, enter the following commands:

Copy

    //IOAGATE JOB MSGLEVEL=1               
    //         JCLLIB  ORDER=IOAP.V610.PROCLIB  
    //         INCLUDE MEMBER=IOASET            
    //IOAGATE  EXEC  IOAGATE,                   
    //         REG=0M,                          
    //         TRACE=SHOW,                      
    //         PSFX=W

In a start command, enter the following:
CopyCopied to clipboard
```
/S IOAGATE,TRACE=SHOW,PSFX=W
```

Start command EXEC parameters overrides the STC job parameters.

PSFXLink copied to clipboard

PurposeLink copied to clipboard

Defines the parameter member (ECAPARM) suffix.

If this parameter is omitted, member ECAPARM is loaded.

For example, PSFX=D causes IOAGATE to load the ECAPARMD member.

SyntaxLink copied to clipboard

Copy

PSFX=#

where # is any valid character for the member name suffix.

Overriding Channel DefinitionsLink copied to clipboard

The user can override link definitions of a selected channel using the EXEC parameters described in the following topics.

CHANLink copied to clipboard

PurposeLink copied to clipboard

Identify the channel that is to be affected by the PORT or APPLID parameters.

If this parameter is omitted, the first channel in member ECAPARMx is affected.

User must provide the PORT or APPLID parameters to match the channel protocol (TCP/SNA).

SyntaxLink copied to clipboard

Copy

CHAN=xx

where xx is the Channel ID (defined in member ECAPARMx under the CHANNEL entry).

DescriptionLink copied to clipboard

If CHAN is not defined in member ECAPARMx, the PORT/APPLID is ignored.

PORTLink copied to clipboard

PurposeLink copied to clipboard

Alter the TCP/IP port defined for a channel. The channel ID is specified by the CHAN parameter.

SyntaxLink copied to clipboard

Copy

PORT=nnnnn

where nnnnn is a number between 1024 and 65534.

APPLIDLink copied to clipboard

PurposeLink copied to clipboard

Alter the SNA LUs defined for a channel. The channel ID is specified by the CHAN parameter.

SyntaxLink copied to clipboard

Table 258 Syntax for APPLID Parameter

Statement	Description
APPLID=<luname>	Single LU name for multi-connection channel.
APPLIDS=(luname1,luname2)	Two LUs (Send and Receive) for Dual-connection channel.

where luname, luname1 and luname2 are valid SNA lu names.

IOAGATE Modify CommandsLink copied to clipboard

The following modify commands are available to the IOAGATE operator. These commands enable the operator to diagnose the IOAGATE and applications server address space status. The operator can then execute commands such as starting and stopping components.

IDLLink copied to clipboard

PurposeLink copied to clipboard

The IDL modify command passes on the command specified as a parameter, to the IDL facility for processing. For more information, refer to Modify commands.

SyntaxLink copied to clipboard

Copy

F IOAGATE,IDL= <modify command>

Copy

IOAL00I IDL FACILITY RECEIVED REQUEST(REFRSUMMARY)
IOAL2ZI SUMMARY TABLE HAS BEEN REFRESHED SUCCESSFULLY,
ADDRESS(175F3000)
IOAL0RI IDL REQUEST(REFRSUMMARY) PROCESSED SUCCESSFULLY, 000.03 sec

SVCDUMPLink copied to clipboard

PurposeLink copied to clipboard

Initiates an SVC dump.

SyntaxLink copied to clipboard

Copy

F IOAGATE,SVCDUMP

Copy

ECAG0AI MODIFY COMMAND ISSUED FROM CONSOLE(consoleid)
SVCDUMP request has been performed
ECAG0AI MODIFY COMMAND ISSUED FROM CONSOLE(N03)
ACCEPTCOMMAND(SVCDUMP)
IEA794I SVC DUMP HAS CAPTURED:
DUMPID=009 REQUESTED BY JOB (started task)
SVCDUMP request has been performed

TRACELink copied to clipboard

SynonymsLink copied to clipboard

DEBUG

PurposeLink copied to clipboard

Handling IOAGATE traces. Trace data is written to the DATRACE DD statement.

SyntaxLink copied to clipboard

To start or stop trace levels

Copy

F IOAGATE,TRACE=<trace list>

To show trace level status

Copy

F IOAGATE,TRACE=SHOW

Table 259 Samples of Trace List Formats

Statement	Description
TRACE=20	Turn ON trace level 20
TRACE=(21,200)	Turn ON trace levels 21 AND 200
TRACE=-200	Turn OFF trace levels 200
TRACE=(-21,-40)	Turn OFF trace levels 21 AND 40
TRACE=(1:512)	Turn ON all trace levels
TRACE=(-1:-512)	Turn OFF all trace levels

Copy

F IOAGATE,TRACE=(120,-20)

This command produces the following output (JESMSGLG):

Copy

IOAD01I TRACE/DEBUG LEVELS SET AS FOLLOWS:
IOAD02I 0120 - TURNED ON
IOAD02I 0020 - TURNED OFF

Copy

F IOAGATE,TRACE=SHOW

This command produces the following output (JESMSGLG):

Copy

IOAD03I PRESENT TRACE/DEBUG LEVELS ARE AS FOLLOWS: 
IOAD04I 0001:0019 - OFF                            
IOAD04I 0020       - ON                             
IOAD04I 0021:0512 - OFF

Table 260 Subset of IOAGATE Trace Levels

Trace Level	Trace Output
20	Communications general trace
21	Send or Receive buffers If data compression is enabled in the application server, the send buffer of that server is printed in compressed format. Use level 23 to display uncompressed data.
22	Send or Receive message header summary
23	Send or Receive uncompressed buffers Disables data compression for all application servers while ON.
40	SNA communication trace
150	Application server management trace. This modify TRACE command must be issued for the application server address space and not on the IOAGATE address space.
200	TCP/IP communication modules trace

STATUSLink copied to clipboard

SynonymsLink copied to clipboard

SHOWASID

STATASID

ASID

PurposeLink copied to clipboard

Display application server task status.

SyntaxLink copied to clipboard

To list all application servers tasks

Copy

F IOAGATE,STATUS

To list tasks of a specific application server address space

Copy

F IOAGATE,STATUS=<ASID>

where ASID is the application server ID. The application server ID is the sequence number of the address space at IOAGATE startup.

Sample OutputLink copied to clipboard

Copy

F IOAGATE,STATUS

This command lists the server tasks of IOAGATE and produces the following output (JESMSGLG):

Copy

ECAG0AI MODIFY(STATUS) ACCEPTED
ECAG34I SERVER TASK    S T A T U S    CHANNEL/SIID PROCEDURE.STC/MODULE UTILIZATION
ECAG35I  CM O001.01    READY              MCC1       H5OAS   H5OAS001    0.0%  
ECAG35I  CS O002.01    READY              MCC1               CTOGATS     0.0%  
ECAG35I  CD O003.01    READY              MCC1               CTOGATR     0.0%  
ECAG34I SERVER TASK    S T A T U S    CHANNEL/SIID PROCEDURE.STC/MODULE UTILIZATION
ECAG35I  CM M007.03    READY              DCC3       H5MAS   H5MAS003    0.0%  
ECAG35I  CS M008.03    READY              DCC3               CTWSRVR     0.0%  
ECAG35I  CD M009.03    UP                 DCC3               CTWDET      0.0%  
ECAG35I  CU M010.03    READY              DCC3               CTWUPD      0.0%  
ECAG34I SERVER TASK    S T A T U S    CHANNEL/SIID PROCEDURE.STC/MODULE UTILIZATION
ECAG35I  CM D011.04    READY              MCC4       H5AAS   H5AAS004    0.0%  
ECAG35I  CS D012.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D013.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D014.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D015.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D016.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D017.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D018.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D019.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D020.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CS D021.04    READY              MCC4               IOAASR      0.0%  
ECAG35I  CD D022.04    READY              MCC4               IOAASC      0.0%

Table 261 Description of Output Fields

Output Field	Description
SERVER	Server type.
TASK	Task identification specified in the format snnn.mm. s - Short application code nnn - Unique Server ID mm - Address space ID
STATUS	Server current working status. Possible statuses are: READY - Server ready to receive requests. BUSY - Server is busy handling a transaction. START - Server is in starting process. UP - Server is up (server without mailbox). FAILED - Server failed. DOWN - Server is down. SUSPEND - Server recovery was suspended. WAIT - Server is waiting for main task (CM) readiness. PENDING - Server is not responsive.
CHANNEL/SIID	For a non-busy task, this field displays the channel name in the format TTNN, where TT is the channel type (DC/MC) and NN is the channel ID. For busy tasks, this field displays the current serviced instance ID
PROCEDURE. STC/MODULE	For a CM task, this field displays the procedure name of the application server in the format XXXXXFMM. XXXXX - Procedure prefix name. F - ECAPARM suffix name. MM - Address space ID. For other tasks, this field displays the server program name
UTILIZATION	The server service handling utilization

For details, see messages ECAG34I and ECAG35I in the INCONTROL for z/OS Messages Manual.

SHOWCHANLink copied to clipboard

SynonymsLink copied to clipboard

CHAN

PurposeLink copied to clipboard

Display channels status.

SyntaxLink copied to clipboard

To list all channels

Copy

F IOAGATE,SHOWCHAN

To list only enabled channels

Copy

F IOAGATE,SHOWCHAN,E

Output Examples

Copy

F IOAGATE,CHAN

Output (JESMSGLG):

Copy

ECAA0AI CHAN PROT TASK VENDOR  SUBS PORT/LU  STATUS   LINKS LINKS% APPL
ECAA0BI MCD1 TCP  LSNR IBM      -    13368   UP/OPEN   1285  20.1% D
ECAA0BI MCDD TCP  LSNR IBM      -    13366   UP/OPEN      0     0% D
ECAA0BI MCF1 TCP  LSNR IBM      -    13367   UP/OPEN      0     0% F
ECAA0AI CHAN PROT TASK VENDOR  SUBS PORT/LU  STATUS   LINKS LINKS% APPL
ECAA0BI DCM1 TCP  SNDR IBM      -    22622   LISTENING    -     -  M
ECAA0BI DCM1 TCP  RCVR IBM      -    22623   LISTENING    -     -  M
ECAA0AI CHAN PROT TASK VENDOR  SUBS PORT/LU  STATUS   LINKS LINKS% APPL
ECAA0BI DCM1 TCP  SNDR IBM      -    22622   CONNECTED    1 100.0% M
ECAA0BI DCM1 TCP  RCVR IBM      -    22623   CONNECTED    1 100.0% M

Table 262 Description of Output Fields

Header	Description
CHAN	Channel in the format TTNN, where TT is the channel type (DC/MC) and NN is the channel ID.
PROT	Channel protocol. Valid values are SNA and TCP, for SNA protocols and TCP/IP protocols, respectively.
TASK	Channel Task identity. Valid values are SNDR (Sender) or RCVR (Receiver) for DC Channel, and LSNR for MC channel.
VENDOR	TCP/IP vendor. Valid values are IBM and CA.
SUBS	Sub-system name. Valid only for vendor CA and protocol TCP/IP.
PORT/LU	Port /LU defined to the channel.
STATUS	Current status of the channel. Possible values are: DISABLED – Channel is disabled for use. LISTENING – Channel is listening for connections. Displayed for DC channel. CONNECTED – Channel is connected. Displayed for DC channel. UP/OPEN – Channel communication is open for incoming connections. Displayed for MC channel. UP/CLOSED – Channel communication is UP but unavailable (CLOSED) for incoming connections. Displayed for MC channel. DOWN – Channel communication is down.
LINKS	Current number of connections to the channel (TCP/IP only).
LINKS%	Percentage of connections utilized out of all supported connections.
APPL	Applications (in short name format) supported by this channel.

SHOWTOKENLink copied to clipboard

PurposeLink copied to clipboard

Displays IOAGATE MVS token

SyntaxLink copied to clipboard

To show IOAGATE MVS tokens, enter the following:

Copy

F IOAGATE,SHOWTOKEN

The contents of the current IOAGATE token are displayed in a ECAG3HI message.

Output Examples

Copy

F IOAGATE,SHOWTOKEN

Output (JESMSGLG):

Copy

ECAG0AI MODIFY COMMAND ISSUED FROM CONSOLE(N03)       
ACCEPTED, COMMAND(SHOWTOKEN)
ECAG3HI IOAGATE Token: Name=<MVS token name>  
LX=<Linkage Index> Obtained=<Date LX was obtained> System=<systemname>

STARTASIDLink copied to clipboard

SynonymsLink copied to clipboard

SASID

PurposeLink copied to clipboard

Start application server address space.

The command can be issued after the application server was shut down due to operator command STOPASID or address space failure.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STARTASID=<ASID>

where ASID is the application server address space ID.

DescriptionLink copied to clipboard

The ID is the sequence number of the address space that has been assigned by IOAGATE at startup. This number is the suffix of the application server procedure step. You can find it by using the STATUS command, and in message ECAB50I (in DD DAIGLOG). For example, the ASID 01 startup message:

Copy

ECAB50I APPL.SERVER(CONTROLW.01.A60AS.A60ASW01-MCM1) STARTED SUCCESSFULLY

Output Example

Copy

F IOAGATE,STARTASID=01

This command produces the following output (DAIGLOG):

Copy

ECAG47I START FOR APPLICATION SERVER(CONTROLW.01) INITIATED
ECAB50I APPL.SERVER(CONTROLW.01.A60AS.A60ASW01-MCM1)         
STARTED SUCCESSFULLY

STOPASIDLink copied to clipboard

SynonymsLink copied to clipboard

PASID

PurposeLink copied to clipboard

Stop an application server address space.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STOPASID=<ASID>

where ASID is the application server address space ID.

DescriptionLink copied to clipboard

Copy

ECAB50I APPL.SERVER(CONTROLW.01.A60AS.A60ASW01-MCM1) STARTED SUCCESSFULLY

Output Example

Copy

F IOAGATE,STOPASID=01

This command produces the following output (DAIGLOG):

Copy

ECAG37I STOP FOR APPL.SERVER(CONTROLW.01) INITIATED

STARTTIDLink copied to clipboard

SynonymsLink copied to clipboard

STID

PurposeLink copied to clipboard

Start server task under an application server address space.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STARTTID=<Task ID>

Table 263 Syntax for Command STARTID

Field	Description
Task ID	Unique ID of the server task in the format snnn. s - Short application code. nnn - Server number.

Field

Description

Task ID

Unique ID of the server task in the format snnn.

s - Short application code.

nnn - Server number.

DescriptionLink copied to clipboard

You can find the server task ID by using the STATUS command, and in the messages ECAB27I, ECAB49I, ECAG4DE and ECAG41E.

Copy

ECAB27I START FOR SERVER TASK(CD.M003.01) INITIATED
ECAB49I SERVER TASK(CONTROLM.CS.M002.01) STARTED SUCCESSFULLY
ECAG4DE SERVER TASK(CONTROLM.CM.M001.01) FAILED
ECAG41E SERVER TASK(CONTROLM.CS.M002.01) FAILED WHEN HANDLING A REQUEST, 
                   USER(GATEWAY ) SIID(185233003)

STOPTIDLink copied to clipboard

SynonymsLink copied to clipboard

PTID

PurposeLink copied to clipboard

Stop server task under an application server address space.

Stopping a task can cause the application server address space to shut down.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STOPTID=<Task ID>

DescriptionLink copied to clipboard

Table 264 Syntax for Command STOPTID

Field	Description
Task ID	Unique ID of the server task in the format snnn. s - Short application code. nnn - Server number.

Field

Description

Task ID

Unique ID of the server task in the format snnn.

s - Short application code.

nnn - Server number.

You can find the server task ID by using the STATUS command, and in the messages ECAB27I, ECAB49I, ECAG4DE and ECAG41E.

Copy

ECAB27I START FOR SERVER TASK(CD.M003.01) INITIATED
ECAB49I SERVER TASK(CONTROLM.CS.M002.01) STARTED SUCCESSFULLY
ECAG4DE SERVER TASK(CONTROLM.CM.M001.01) FAILED
ECAG41E SERVER TASK(CONTROLM.CS.M002.01) FAILED WHEN HANDLING A REQUEST, 
USER(GATEWAY ) SIID(185233003)

Output Example

Copy

F IOAGATE,STOPTID=D003

This command produces the following output (DAIGLOG):

Copy

ECAG4AI STOP FOR SERVER TASK(CONTROLD.CS.D003.01) INITIATED   
ECAG4GI SERVER TASK(CONTROLD.CS.D003.01) HAS BEEN STOPPED BY OPERATOR

MODASIDLink copied to clipboard

SynonymsLink copied to clipboard

FASID

PurposeLink copied to clipboard

Send a modify command to an application server that can receive and perform such a command.

SyntaxLink copied to clipboard

To send a command to all application servers that can receive modify commands:

Copy

F IOAGATE,MODASID <command>

To send a command to a specific address space that can receive modify commands

Copy

F IOAGATE,MODASID=<ASID> <command>

Table 265 Syntax for Command MODASID

Field	Description
ASID	Application server address space ID. Optional. If not specified, the command is applied on all application servers.
command	Application server supported command. The following commands are available: MODAPPL: Passes the MODIFY command to the IOAAS application server. LOADTREE: Loads the Recipient and Approval Tree. See Loading the Recipient and Approval Tree. DISPLAY: Displays a list of active users in the Application Server. See Displaying a List of All Active Users (for Control-D) or Displaying a List of All Active Users (for Control-O). LOGOUT: Forces logout from a user session in IOAAS. See Forced user session logout. SHARPTRC: Adjusts performance trace levels for IOAAS. See Adjusting the scope of the performance trace in IOAAS.

Field

Description

ASID

Application server address space ID. Optional.

If not specified, the command is applied on all application servers.

command

Application server supported command.

The following commands are available:

MODAPPL: Passes the MODIFY command to the IOAAS application server.
LOADTREE: Loads the Recipient and Approval Tree. See Loading the Recipient and Approval Tree.
DISPLAY: Displays a list of active users in the Application Server. See Displaying a List of All Active Users (for Control-D) or Displaying a List of All Active Users (for Control-O).
LOGOUT: Forces logout from a user session in IOAAS. See Forced user session logout.
SHARPTRC: Adjusts performance trace levels for IOAAS. See Adjusting the scope of the performance trace in IOAAS.

Sample OutputLink copied to clipboard

Copy

F IOAGATE,MODASID=02,LOADTREE

This command produces the following output (DAIGLOG):

Copy

ECAE52I MODIFY FOR SERVER(CONTROLD.CD.D003.01) SUBMITTED

STOPLink copied to clipboard

PurposeLink copied to clipboard

Stop IOAGATE and all its application servers.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STOP

OutputLink copied to clipboard

Copy

ECAG07I SHUT DOWN UPON REQUEST FROM OPERATOR

SHOWMAPLink copied to clipboard

SynonymsLink copied to clipboard

MAP

PurposeLink copied to clipboard

List the map used by the Control‑O Gateway to Gateway connections.

SyntaxLink copied to clipboard

Copy

F IOAGATE,SHOWMAP

Sample Output (JESMSGLG)Link copied to clipboard

Copy

ECAP20I IOAGATE-TO-IOAGATE TCP CONNECTIONS NODE=R5NODE   MAP=TCPMAP   APPL=ControlO
ECAP23I CHAN TASK PARTNER  PORT  CONNECTOR S T A T U S  SOCKET    HOST         
ECAP24I ---- ---- -------  ----- --------- -----------  ------    ----         
ECAP24I MCC1      Y2KNODE        PARTNER   WAITING FOR CONNECTION

Table 266 Description of Output Fields

Header	Description
CHAN	Channel in format MCID, where MC is the type and ID is the channel ID
TASK	ID of the communication task that handles the connection
PARTNER	NODE of the partner IOAGATE
PORT	Port of the partner IOAGATE
CONNECTOR	LOCAL or PARTNER
STATUS	Statuses are: READY TO CONNECT - Temporary initial status RECONNECTED - Connection established after it has been lost DISCONNECTED - Passive side lost connection DISABLED - Invalid MAP entry disabled CONNECTION IN PROGRESS - Connect in progress RETRYING - Connect failed and will be retried CONNECTED - Connection established WAITING FOR CONNECTION - Passive side awaiting connection
SOCKET	Socket number used for the connection
HOST	Hostname or IP address where partner IOAGATE runs as defined in MAP

For more details see messages ECAP20I, ECAP21I and ECAP22I in the INCONTROL for z/OS Messages Manual.

ALLOCSLink copied to clipboard

PurposeLink copied to clipboard

List all address space allocated files.

SyntaxLink copied to clipboard

Copy

F IOAGATE,ALLOCS

Sample OutputLink copied to clipboard

Output (JESMSGLG):

Copy

IOA000I LIST OF ALLOCATED DDNAMES :                 
IOA000I  STEPLIB   JCL  IOAP.V900.TLOAD             
IOA000I  DAPARM    JCL  IOAP.V900.PARM              
IOA000I  DAMAP     JCL  IOAP.V900.PARM              
IOA000I  ECACOPRM  JCL  IOAP.CTMS.GTWPARM            
IOA000I  ECATMSG   JCL  IOAP.V900.MSGENG     
IOA000I  DAMSG     DYN  IOAP.V900.MSGENG

Table 267 Description of Output Fields

Header	Description
DYN	Dynamic allocated file.
JCL	Static allocated file.

STORSUMLink copied to clipboard

PurposeLink copied to clipboard

Print virtual storage summary.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STORSUM

Sample OutputLink copied to clipboard

Figure 99 Sample Output DAPRENV

Copy

IOA000I STORAGE MAP BY TCB, STORAGE KEY AND SUBPOOL :                         
 
IOA000I STORAGE MAP BY TCB, STORAGE KEY AND SUBPOOL :                         
IOA000I  009FE240          01 229  ALLOC  TOTAL    00003000 00000000 00003000
IOA000I                            FREE   TOTAL    00000000                  
IOA000I  009FE240          05 229  ALLOC  TOTAL    00019000 00000000 00019000
IOA000I                            FREE   TOTAL    00000000                  
IOA000I  009FE240          00 230  ALLOC  TOTAL    00007000 00003000 00004000
IOA000I                            FREE   TOTAL    000021B0                  
IOA000I  009FE240          01 230  ALLOC  TOTAL    0000A000 00004000 00006000
IOA000I                            FREE   TOTAL    00001A58

SHOWSIBSLink copied to clipboard

SynonymsLink copied to clipboard

SIBS

PurposeLink copied to clipboard

Print the total number of Service Instance Control Blocks in IOAGATE queues.

These blocks represent the messages held in IOAGATE.

SyntaxLink copied to clipboard

Copy

F IOAGATE,SHOWSIBS

Sample Output (in JESMSGLG)Link copied to clipboard

Copy

THERE ARE 00012 ACTIVE SIBS IN THIS CO-GATEWAY

STATONLink copied to clipboard

PurposeLink copied to clipboard

Start the IOAGATE communication statistics collection.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STATON,INTERVAL=nnn

where nnn is the time interval (a number from 001 through 999).

DescriptionLink copied to clipboard

If the time interval is omitted, the interval is set to 10 minutes. The time interval is the time between each storing of the collected communications statistics data. Only data for the last six time intervals are saved.

Output (DAIGLOG)Link copied to clipboard

Copy

ECAB60I STATISTICS COLLECTION STARTED. INTERVAL IS 10 MINUTES

STATOFFLink copied to clipboard

PurposeLink copied to clipboard

Stop IOAGATE communication statistics collection.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STATOFF

Output (DAIGLOG)Link copied to clipboard

Copy

ECAB61I STATISTICS COLLECTION STOPPED

STATRESETLink copied to clipboard

PurposeLink copied to clipboard

Reset communication statistics.

SyntaxLink copied to clipboard

Copy

F IOAGATE,STATRESET

Output (DAIGLOG)Link copied to clipboard

Copy

ECAB62I STATISTICS DATA WAS RESET

STATALLLink copied to clipboard

PurposeLink copied to clipboard

Print detailed statistics data.

(Table line levels are: Time interval, Channel, Application, and Message type level).

SyntaxLink copied to clipboard

Copy

F IOAGATE,STATALL

Output (DATRACE)Link copied to clipboard

Figure 100 Sample Output (DATRACE)

Copy

#================================================================== . . .# 
|    |    |    |           #  Total  |    1    |    2    |    3          |
|Chan|Appl|TRAN| Data      #  11:28  |  13:28- |  13:38- |  13:48-       |
| ID |Name| ID | Type      #  14:25  |  13:38  |  13:48  |  13:58        |
+----+----+----+-----------#---------+---------+---------+--------- . . .+
|DCM1| M  | D  |COUNTERS:  #         |         |         |               |
|    |    |    |TRANS      #      2  |      0  |      1  |      0        |
|    |    |    |MSGS -IN   #      5  |      0  |      3  |      0        |
|    |    |    |MSGS -OUT  #     89  |      0  |     44  |      0        |
|    |    |    |BYTES-IN   #    165  |      0  |     90  |      0        |
|    |    |    |BYTES-OUT  # 21,210  |      0  | 11,650  |      0        |
|    |    |    |---------- #---------|---------|---------|--------- . . .+
|    |    |    |AVRG TIME: #         |         |         |               |
|    |    |    |INP-Q.TIME #   .002s |   .000s |   .003s |   .000s       |
|    |    |    |OUT-Q.TIME #   .000s |   .000s |   .000s |   .000s       |
|    |    |    |SRVER-RESP #   .055s |   .000s |   .080s |   .000s       |
|    |    |    |PRTNR-RESP #  6.685s |   .000s |  9.601s |   .000s       |
|    |    |    |OTHER-RESP #   .657s |   .000s |   .414s |   .000s       |
|    |    |    |TOTAL-RESP #  7.401s |   .000s | 10.019s |   .000s       |
|    |    |----+-----------#---------+---------+---------+---------      |
|    |    | F  |COUNTERS:  #         |         |         |               |
|    |    |    |TRANS      #      0  |      0  |      0  |      0        |
.    .    .    .           .         .         .         .               .
.    .    .    .           .         .         .         .               .
.    .    .    .           .         .         .         .               .
#================================================================== . . .#

Table 268 Output Format Table

Header	Description	Remarks
Chan ID	Channel ID.	List the Enabled channels only.
Appl Name	Application short name.	List the applications supported by the channel.
TRAN ID	Transaction ID.	The main transaction IDs are listed in the table below.
Data Type	Statistics data type included in the table line.	See Data Types
Total hh:mm- (1) hh:mm (2)	Total accumulating statistics from statistics collection start time (1) until now (2).
n hh:mm- (1) hh:mm (2)	Statistics collected in time interval n, from interval start (1) until interval end (2).	Currently up to 6 time intervals are available for display. You can modify the time interval by using parameter INTERVAL in the STATON command.

Table 269 Main Transaction ID List

Application	IDs
Control‑D/Page On Demand and Control‑D File Transfer option	IDs: M - Management messages R - User request
Control‑M	IDs: 1 - Send User Dailies request A - Calendar list request B - Global Prefixes request D - Download F - Definitions download G - Table list request I - Information request J - Remote Forcejob request L - Folder Library List request O - Order or force request P - Upload R - User request S - Synchronization T - Definitions upload U - Database update V - Workload update W - Workload sync
Control‑O	IDs: B - Rules (receive) G - Rules (send)

Application

IDs

Control‑D/Page On Demand and Control‑D File Transfer option

IDs:

M - Management messages
R - User request

Control‑M

IDs:

1 - Send User Dailies request
A - Calendar list request
B - Global Prefixes request
D - Download
F - Definitions download
G - Table list request
I - Information request
J - Remote Forcejob request
L - Folder Library List request
O - Order or force request
P - Upload
R - User request
S - Synchronization
T - Definitions upload
U - Database update
V - Workload update
W - Workload sync

Control‑O

IDs:

B - Rules (receive)
G - Rules (send)

Data TypesLink copied to clipboard

Table 270 Data Types

Data Type	Description
COUNTERS:	Numeric Counters section. Counters are displayed in the format nn,nnn$ where $ is ‘K’ for Kilo (x 1,024), ‘M’ for Mega (x 1,024K) TRANS - Number of transactions MSGS -IN - Number of incoming messages MSGS –OUT - Number of outgoing messages BYTES-IN - Number of incoming bytes BYTES-OUT - Number of outgoing bytes
AVRG TIME:	Average transaction response time section. Timers are displayed in the format xx.xxx$ where $ is ‘s’ for seconds, ‘m’ for minute, ‘h’ for hours and ‘d’ for days. INP-Q.TIME - Input queue duration OUT-Q.TIME - Output queue duration SRVER-RESP - Application server response time PRTNR-RESP - Partner response time OTHER.TIME - Other transaction states duration TOTAL-RESP - Total transaction response time

Data Type

Description

COUNTERS:

Numeric Counters section.

Counters are displayed in the format nn,nnn$ where $ is ‘K’ for Kilo (x 1,024), ‘M’ for Mega (x 1,024K)

TRANS - Number of transactions

MSGS -IN - Number of incoming messages

MSGS –OUT - Number of outgoing messages

BYTES-IN - Number of incoming bytes

BYTES-OUT - Number of outgoing bytes

AVRG TIME:

Average transaction response time section.

Timers are displayed in the format xx.xxx$ where $ is ‘s’ for seconds, ‘m’ for minute, ‘h’ for hours and ‘d’ for days.

INP-Q.TIME - Input queue duration

OUT-Q.TIME - Output queue duration

SRVER-RESP - Application server response time

PRTNR-RESP - Partner response time

OTHER.TIME - Other transaction states duration

TOTAL-RESP - Total transaction response time

STATSUMLink copied to clipboard

PurposeLink copied to clipboard

Print summary statistics data

(Table line levels are: Channel, Application, Counter type).

SyntaxLink copied to clipboard

Copy

F IOAGATE,STATSUM

Output (DATRACE)Link copied to clipboard

Figure 101 Sample Output DATRACE

Copy

#================================================================== . . .# 
|      |     |             #  Total  |    1    |    2    |    3          |
| Chan |Appl | Data        #   9:47- |  13:07- |  13:17- |  13:27-       |
|  ID  |Name | Type        #  13:59  |  13:17  |  13:27  |  13:37        |
+------+-----+-------------#---------+---------+---------+--------- . . .+
| MCM2 |  D  | COUNTERS:   #         |         |         |               |
|      |     | TRANS       #    140  |     56  |     30  |     17        |
|      |     | MSGS -IN    #    140  |     76  |     30  |     14        |
|      |     | MSGS -OUT   #    140  |     56  |     30  |     17        |
|      |     | BYTES-IN    # 33,080  | 18,568  |  8,256  |  3,488        |
|      |     | BYTES-OUT   #  1,246K |    157K |    381K |    291K       |
|      |     | ----------  #---------|---------|---------|--------- . . .+
|      |     | AVRG TIME:  #         |         |         |               |
|      |     | INP-Q.TIME  #   .004s |   .005s |   .004s |   .011s       |
|      |     | OUT-Q.TIME  #   .012s |   .001s |   .013s |   .006s       |
|      |     | SRVER-RESP  #  7.032s |  1.313s |  8.872s |  4.013s       |
|      |     | PRTNR-RESP  #   .000s |   .000s |   .000s |   .000s       |
|      |     | OTHER-RESP  #   .002s |   .002s |   .003s |   .003s       |
|      |     | TOTAL-RESP  #  7.052s |  1.322s |  8.894s |  4.032s       |
|      |-----+-------------#---------+---------+---------+--------- . . .+
|      |  O  | COUNTERS:   #         |         |         |               |
|      |     | TRANS       #      4  |     12  |     44  |     10        |
.    .    .    .           .         .         .         .               .
.    .    .    .           .         .         .         .               .
.    .    .    .           .         .         .         .               .
#================================================================== . . .#

Table 271 Output Format Table

Header	Description	Remarks
Chan ID	Channel ID.	List the ‘Enabled’ channels only.
Appl Name	Application short name	List the applications supported by the channel.
Data Type	Statistics data type included in the table line.	See Data Types
Total hh:mm- (1) hh:mm (2)	Total accumulating statistics from statistics collection start time (1) until now (2).
n hh:mm- (1) hh:mm (2)	Statistics collected in time interval n, from interval start (1) until interval end (2).	Currently up to 6 time intervals are available for display.
n hh:mm- (1) hh:mm (2)	You can modify the time interval by using the INTERVAL parameter in the STATON command.

CLOSELink copied to clipboard

SynonymsLink copied to clipboard

SyntaxLink copied to clipboard

To stop handling incoming connections for the specific channel:

Copy

F IOAGATE,CLOSE=channel_id

To stop handling incoming connections for all channels:

Copy

F IOAGATE,CLOSE=ALL

To stop handling incoming connections and shutdown IOAGATE when all clients have been disconnected:

Copy

F IOAGATE,CLOSE=channel_id/ALL,SHUT

Output Example - CLOSE one channel

Copy

F IOAGATE,CLOSE=D1

This command produces the following output (JESMSGLG):

Copy

ECAG0AI MODIFY(CLOSE=D1) ACCEPTED                                        
ECAG5CI CHANNEL(MCD1.TCP) CLOSED FOR INCOMING CONNECTIONS, APPLICATION(D)

Output Example - CLO
SE ALL channels
Link copied to clipboard

Copy

F IOAGATE,CLOSE=ALL

This command produces the following output (JESMSGLG):

Copy

ECAG0AI MODIFY(CLOSE=ALL ACCEPTED                                        
ECAG5CI CHANNEL(MCD1.TCP) CLOSED FOR INCOMING CONNECTIONS, APPLICATION(D)
ECAG5CI CHANNEL(MCF1.TCP) CLOSED FOR INCOMING CONNECTIONS, APPLICATION(F)

Output Example - shutdown IOAGATE

Copy

F IOAGATE,CLOSE=ALL,SHUT

This command produces the following output (JESMSGLG):

Copy

ECAG0AI MODIFY(CLOSE=ALL,SHUT) ACCEPTED                                       
ECAG5CI CHANNEL(MCD1.TCP) CLOSED FOR INCOMING CONNECTIONS, APPLICATION(D)     
ECAG5CI CHANNEL(MCF1.TCP) CLOSED FOR INCOMING CONNECTIONS, APPLICATION(F)     
ECAG5DI IOAGATE WILL BE SHUT DOWN AS SOON AS ALL CLIENTS HAVE DISCONNECTED    
ECAG5HI IOAGATE GOES DOWN DUE TO COMMAND "CLOSE=.,SHUT" ISSUED EARLIER        
-                                        CPU (Total)  Elapsed      CPU (TCB)  
-Jobname  Stepname ProcStep    RC    I/O hh:mm:ss.th  hh:mm:ss.th  hh:mm:ss.th
-A61GATED IOAGATE  GATEWAY     00   7398    02:23.78  23:32:03.38     01:54.00
IEF404I A61GATED - ENDED - TIME=13.31.13

OPENLink copied to clipboard

SynonymsLink copied to clipboard

OPEN

PurposeLink copied to clipboard

Resume handling incoming connections.

SyntaxLink copied to clipboard

To resume handling incoming connections by the specific channel that was previously closed:

Copy

F IOAGATE,OPEN=channel_id

To resume handling incoming connections all channels that were previously closed:

Copy

F IOAGATE,CLOSE=ALL

Output Example - OPEN one channel

Copy

F IOAGATE,OPEN=D1

This command produces the following output (JESMSGLG):

a) Channel D1 was previously closed:

Copy

ECAG0AI MODIFY(OPEN=D1) ACCEPTED
ECAG5CI CHANNEL(MCD1.TCP) OPENED FOR INCOMING CONNECTIONS, APPLICATION(D)

b) Channel D1 was not previously closed:

Copy

ECAG0AI MODIFY(OPEN=D1) ACCEPTED
ECAG0KW MODIFY(OPEN)  REJECTED, SPECIFIED CHANNEL WAS NOT CLOSED

Output Example - OPEN ALL channels

Copy

F IOAGATE,OPEN=ALL

This command produces the following output (JESMSGLG):

a) All channels were previously closed:

Copy

ECAG0AI MODIFY(OPEN=ALL) ACCEPTED                         
ECAG5CI CHANNEL(MCD1.TCP) OPENED FOR INCOMING CONNECTIONS, APPLICATION(D)
ECAG5CI CHANNEL(MCF1.TCP) OPENED FOR INCOMING CONNECTIONS, APPLICATION(F)

b) Some channel was not previously closed:

Copy

ECAG0AI MODIFY(OPEN=ALL) ACCEPTED
ECAG5CI CHANNEL(MCF1.TCP) OPENED FOR INCOMING CONNECTIONS, APPLICATION(F)

LOGINMSGLink copied to clipboard

PurposeLink copied to clipboard

Controls the destinations where ECAG62I messages will be sent. These messages indicate that a user successfully logged on to IOAGATE over a multiple connection (MC) TCP channel.

SynonymsLink copied to clipboard

Copy

LOGINMSG

SyntaxLink copied to clipboard

To show the current values of the LOGINMSG parameter in all MC channels, enter the following modify command:

Copy

F IOAGATE,LOGINMSG=SHOW

This command produces the following output (JESMSGLG):

Copy

ECAG0LI CHANNELchannel-idCURRENT LOGINMSG VALUE:value

To dynamically override the value of the LOGINMSG parameter in all MC channels to one of the values listed below, enter the following modify command:

Copy

F IOAGATE,LOGINMSG=value

In the preceding syntax statement, value can have the following meanings:

YES – The ECAG62I message is issued to LOG (DAIGLOG) and WTO

NO – The ECAG62I message is issued to LOG (DAIGLOG) only

OFF – The ECAG621 message is not issued

WTO – The ECAG62I message is issued to WTO only

LOG – The ECAG62I message is issued to LOG (DAIGLOG) only

LOG+WTO – The ECAG62I message is issued to both LOG (DAIGLOG) and WTO

WTO+LOG – The ECAG62I message is issued to both LOG (DAIGLOG) and WTO

To dynamically override the value of the LONGINMSG parameter in a specific MC channel, enter the following modify command:

Copy

F IOAGATE,LOGINMSG=value,CHAN=channel-id
F ioagate,LONGINMSG=value,CHAN=channel-id

In the preceding syntax statement, value can have the meanings shown above, and channel-id is the specific MC channel whose value you want to change.

REFRESHLink copied to clipboard

PurposeLink copied to clipboard

REFRESH (reload) ECAIPLSx, which is the list of valid IP addresses from which IOAGATE can accept connection establishment requests (IP list).

SyntaxLink copied to clipboard

Copy

F IOAGATE, REFRESH=ECAIPLSx

Where x is the suffix (optional) of ECAIPLS member.

Output example - REFRESH

Copy

ECAG0AI MODIFY COMMAND ISSUED FROM CONSOLE(...)   ACCEPTED, COMMAND(REFRESH=ECAIPLS)
ECAP90I ECAIPLS( ) IP LIST HAS BEEN REFRESHED SUCCESSFULLY FOR CHANNEL(DCM1)

Link copied to clipboard

Diagnostic SNAP Modify CommandsLink copied to clipboard

The following commands are for diagnostic usage. Use only when asked by a BMC representative.

Area SNAPs are written to the DATRACE DD statement.

PRINTSSTLink copied to clipboard

SynonymsLink copied to clipboard

PSST

PurposeLink copied to clipboard

Print Servers Status Table area.

This table represents all the applications address space tasks communicating with IOAGATE.

SyntaxLink copied to clipboard

To print all SST entries

Copy

F IOAGATE,PRINTSST

To print SST entry of a specific task

Copy

F IOAGATE,PRINTSST=<Task ID>

PRINTSDTLink copied to clipboard

SynonymsLink copied to clipboard

PSDT

PurposeLink copied to clipboard

Print Server Descriptor Table area.

This table represent all the servers tasks initialization definitions (built based on member ECAPARM)

SyntaxLink copied to clipboard

To print all SDT entries

Copy

F IOAGATE,PRINTSDT

To print SDT entry of a specific server task

PRINTSTDLink copied to clipboard

SynonymsLink copied to clipboard

PSTD

PurposeLink copied to clipboard

Print Subtask Descriptor Table area. This table represent all the IOAGATE tasks.

SyntaxLink copied to clipboard

To print all STD entries

Copy

F IOAGATE,PRINTSTD

To print STD entry number nn

Copy

F IOAGATE,PRINTSTD=<nn>

PRINTCMTLink copied to clipboard

SynonymsLink copied to clipboard

PCMT

PurposeLink copied to clipboard

Print Communication Table area. This table represents the TCP/IP communication tasks.

SyntaxLink copied to clipboard

To print all CMT entries

Copy

F IOAGATE,PRINTCMT

To print CMT entry number nn

Copy

F IOAGATE,PRINTCMT=<nn>

PRINTALLLink copied to clipboard

SynonymsLink copied to clipboard

PALL

PurposeLink copied to clipboard

Print all tables areas.

SyntaxLink copied to clipboard

Copy

F IOAGATE,PRINTALL

PRINTWCTLink copied to clipboard

SynonymsLink copied to clipboard

PWCT

PurposeLink copied to clipboard

Print gateWay master Control Table. This table includes internal IOAGATE data.

SyntaxLink copied to clipboard

Copy

F IOAGATE,PRINTWCT

PRINTSIBLink copied to clipboard

SynonymsLink copied to clipboard

PSIB

PurposeLink copied to clipboard

Print Service Instance control Blocks area. These blocks represent the messages held in IOAGATE.

SyntaxLink copied to clipboard

To print all SIB entries:

Copy

F IOAGATE,PRINTSIB