DISPLAY APING command

Read syntax diagramSkip visual syntax diagram
>>-DISPLAY-- --NET--,--APING--,--ID--=--resource_name----------->

   .-,--CONSEC--=--1-----------------------------.   
>--+---------------------------------------------+-------------->
   '-,--CONSEC--=--number_of_consecutive_packets-'   

   .-,--ECHO--=--YES-----.   
>--+---------------------+-------------------------------------->
   '-,--ECHO--=--+-NO--+-'   
                 '-YES-'     

   .-,--ITER--=--2-------------------------------------.   
>--+---------------------------------------------------+-------->
   '-,--ITER--=--number_of_send_and_receive_iterations-'   

   .-,--LIST--=--ALL-----.   
>--+---------------------+-------------------------------------->
   '-,--LIST--=--SUMMARY-'   

   .-,--LOGMODE--=--#INTER----------.                    
>--+--------------------------------+--+-------------+---------->
   '-,--LOGMODE--=--logon_mode_name-'  '-,--PASSWORD-'   

   .-,--SIZE--=--100------------.   
>--+----------------------------+------------------------------->
   '-,--SIZE--=--size_of_packet-'   

   .-,--TP--=--APINGD-------------------.   
>--+------------------------------------+----------------------->
   '-,--TP--=--transaction_program_name-'   

>--+----------------------+------------------------------------><
   '-,--USERID--=--userid-'   

Abbreviations

Operand Abbreviation
DISPLAY D

Purpose

The DISPLAY APING command tests whether a route to another LU 6.2 resource or control point is available and displays performance information for the route if the resource supports an APING server.

More than one D APING command can be executing at a time. The default limit for APING command TP instances is 10. The limit may be adjusted using the MODIFY APINGTP command. Information about the APING TP and its sessions may be displayed using the DISPLAY APINGTP command.

Note: Issuing an APING command to the same partner and with the same logmode may result in a failure with RCPRI=2C and RCSEC=11. This failure occurs because the second command was issued before completion of session setup for the first APING command. This condition is temporary and a subsequent APING command should work. If you want, you can issue the APING to the same partner and specify a different logmode.

See z/OS Communications Server: SNA Network Implementation Guide for more information about APING.

Operands

CONSEC=number_of_consecutive_packets
Specifies the number of consecutive packets to be sent per iteration. The value for CONSEC can be any integer in the range 0–32763. The default is 1.

If you specify CONSEC=0, no data is sent or returned; only a version exchange between the transaction programs occurs.

ECHO
Specifies whether data is returned to the sending transaction program, if the server transaction program supports ECHO.
ECHO=NO
Specifies that data is not returned to the sending transaction program.
ECHO=YES
Specifies that data is returned to the sending transaction program.
ID=resource_name
Specifies the name of the resource for which the APING transaction is requested.
ITER=number_of_send_and_receive_iterations
Specifies the number of times that consecutive packets are sent to the receiving transaction program and returned. The value for ITER can be any integer in the range 0–32763. The default is 2.

If you specify ITER=0, no data is sent or returned; only a version exchange between the transaction programs occurs.

LIST
Specifies whether detailed statistics for iteration data exchanged should be displayed.
LIST=ALL
Specifies that all output messages should be displayed.
LIST=SUMMARY
Specifies that iteration statistics messages should be suppressed. All other messages will be included.
LOGMODE=logon_mode_name
Specifies the logon mode name from the default logon mode table (ISTINCLM) to be used when the session is started.
Note: The logon mode names CPSVCMG, CPSVRMGR, and SNASVCMG are not valid for LOGMODE.
PASSWORD
Specifies the password if conversation level security is requested.

This operand is valid only from an MVS™ console. A command with the PASSWORD operand will be rejected if it is entered from a Program Operator Application (POA) because there is no capability to suppress the password from being displayed by the Program Operator Interface.

When this operand is entered from a system console, the operator will be prompted to enter the password with message IST1660A ENTER PASSWORD FOR DISPLAY APING. When the password is entered in reply to IST1660A, it will not be displayed on the system console or in the system log, but will be replaced in the display with the word SUPPRESSED.

The value for PASSWORD can contain 1–8 characters.

SIZE=size_of_packet
Specifies the size (in bytes) of the packets to be sent. The value for SIZE can be any integer in the range 1–32763. The default is 100.
TP=transaction_program_name
Specifies the name of the transaction program to which data is to be sent. The default transaction program name is APINGD.

The value for TP can contain 1–64 characters.

USERID=userid
Specifies the user ID if conversation level security is requested.

The value for USERID can contain 1–8 characters.

Resulting display

The resulting VTAM® display shows performance information and routing information in two separate message groups.

The performance information includes the following information:
  • The specified destination LU and the session identifier (SID)
  • An indication of whether the ECHO was performed
  • The elapsed time for conversation allocation and version exchange
  • The data rate calculations for each iteration and the data rate calculations for all iterations
  • The elapsed time for each iteration and the total elapsed time for all iterations
  • The minimum, maximum, and average elapsed time for each iteration
Note: No decimal values are displayed for data rate calculations in messages. If the data rate calculation includes a decimal, the value is truncated to the whole number. If the data rate calculation is less than one, zero is displayed.
If a session is allocated for the DISPLAY APING command, VTAM also displays the following routing information:
  • The destination LU and the session identifier (SID)
  • The Class of Service table entry and the logon mode entry used
    Note: If the session cannot be established with the requested LOGMODE, the session is established with a default logon mode of *BLANK*.
  • If the destination LU is found in or through a subarea network, VTAM displays:
    • The origination subarea number and the destination subarea number of the first node in the route
    • The virtual route and explicit route numbers
  • If the destination LU is found in or through an APPN network, VTAM displays:
    • The APPN Class of Service toward the SLU
    • The transmission group number and type for APPN
    • The destination CP name for the TG

The routing information can be correlated to the performance information using the session identifier (SID).

Note: The name of the destination LU in the routing information might not match the name of the destination LU in the performance information if any name translation has occurred on the route between the LUs.

Examples

Displaying APING information when a session to the destination exists and is using the requested logon mode:
d net,aping,id=sscp2a
IST1457I VTAM APING VERSION 2R33 (PARTNER TP VERSION 2R33)
IST1490I DLU=NETA.SSCP2A SID=EAABEEC3710FD9E7
IST1462I ECHO IS ON
IST1463I ALLOCATION DURATION 17717 MILLISECONDS
IST1464I PROGRAM STARTUP AND VERSION EXCHANGE: 81 MILLISECONDS
IST1465I         DURATION      DATA SENT   DATA RATE   DATA RATE
IST1466I      (MILLISECONDS)    (BYTES)    (KBYTE/S)    (MBIT/S)
IST1467I               74            200           2           0
IST1467I            19543            200           0           0
IST1468I TOTALS:    19617            400           0           0
IST1469I DURATION STATISTICS:
IST1470I MINIMUM = 74 AVERAGE = 9808 MAXIMUM = 19543
IST314I END
Displaying APING information when the destination is in the same APPN network:
d net,aping,id=sscp1a
IST097I DISPLAY ACCEPTED
IST1489I APING SESSION INFORMATION
IST1490I DLU=NETA.SSCP1A SID=F6ABEEC3742C592E
IST933I LOGMODE=#INTER  , COS=*BLANK*
IST875I APPNCOS TOWARDS SLU = #INTER
IST1460I TGN  CPNAME             TG TYPE      HPR
IST1461I  21  NETA.SSCP1A        APPN         RTP
IST314I END
 
IST1457I VTAM APING VERSION 2R33 (PARTNER TP VERSION 2R33)
IST1490I DLU=NETA.SSCP1A SID=F6ABEEC3742C592E
IST1462I ECHO IS ON
IST1463I ALLOCATION DURATION 834 MILLISECONDS
IST1464I PROGRAM STARTUP AND VERSION EXCHANGE: 174 MILLISECONDS
IST1465I         DURATION      DATA SENT   DATA RATE   DATA RATE
IST1466I      (MILLISECONDS)    (BYTES)    (KBYTE/S)    (MBIT/S)
IST1467I              119            200           1           0
IST1467I             6088            200           0           0
IST1468I TOTALS:     6207            400           0           0
IST1469I DURATION STATISTICS:
IST1470I MINIMUM = 119 AVERAGE = 3103 MAXIMUM = 6088
IST314I END
Displaying APING information when the destination is in an adjoining subarea network:
d net,aping,id=sscp1a
IST097I DISPLAY ACCEPTED
IST1489I APING SESSION INFORMATION
IST1490I DLU=NETA.SSCP1A SID=EAABEE18C8567C6A
IST933I LOGMODE=#INTER  , COS=*BLANK*
IST875I APPNCOS TOWARDS SLU = #INTER
IST1460I TGN  CPNAME             TG TYPE      HPR
IST1461I  21  NETA.SSCP2A        APPN         ANR
IST1461I 254  SSCP1A             INTERCHANGE  *NA*
IST314I END
 
IST1457I VTAM APING VERSION 2R33 (PARTNER TP VERSION 2R33)
IST1490I DLU=NETA.SSCP1A SID=EAABEE18C8567C6A
IST1462I ECHO IS ON
IST1463I ALLOCATION DURATION 8208 MILLISECONDS
IST1464I PROGRAM STARTUP AND VERSION EXCHANGE: 35 MILLISECONDS
IST1465I         DURATION      DATA SENT   DATA RATE   DATA RATE
IST1466I      (MILLISECONDS)    (BYTES)    (KBYTE/S)    (MBIT/S)
IST1467I               26            200           7           0
IST1467I               22            200           9           0
IST1468I TOTALS:       48            400           8           0
IST1469I DURATION STATISTICS:
IST1470I MINIMUM = 22 AVERAGE = 24 MAXIMUM = 26
IST314I END
Displaying APING information when the destination is reached through a VRTG:
d net,aping,id=sscp2a
IST097I DISPLAY ACCEPTED
IST1489I APING SESSION INFORMATION
IST1490I DLU=NETA.SSCP2A SID=EAABEEC379DA83D2
IST933I LOGMODE=#INTER  , COS=*BLANK*
IST875I APPNCOS TOWARDS SLU = #INTER
IST1460I TGN  CPNAME             TG TYPE      HPR
IST1461I 255  NETA.SSCP2A        VRTG         RTP
IST314I END
 
IST1457I VTAM APING VERSION 2R33 (PARTNER TP VERSION 2R33)
IST1490I DLU=NETA.SSCP2A SID=EAABEEC379DA83D2
IST1462I ECHO IS ON
IST1463I ALLOCATION DURATION 414 MILLISECONDS
IST1464I PROGRAM STARTUP AND VERSION EXCHANGE: 210 MILLISECONDS
IST1465I         DURATION      DATA SENT   DATA RATE   DATA RATE
IST1466I      (MILLISECONDS)    (BYTES)    (KBYTE/S)    (MBIT/S)
IST1467I              622            200           0           0
IST1467I             4246            200           0           0
IST1468I TOTALS:     4868            400           0           0
IST1469I DURATION STATISTICS:
IST1470I MINIMUM = 622 AVERAGE = 2434 MAXIMUM = 4246
IST314I END
Displaying APING information when the destination is in a connecting subarea network:
d net,aping,id=sscp2a
IST097I DISPLAY ACCEPTED
IST1489I APING SESSION INFORMATION
IST1490I DLU=NETA.SSCP2A SID=EAABEEC3710FD9E7
IST933I LOGMODE=#INTER  , COS=*BLANK*
IST1458I ORIGIN   ADJSUB    VR       TP       ER      REVERSE ER
IST1459I     1        2      2        0        3           4
IST314I END
 
IST1457I VTAM APING VERSION 2R33 (PARTNER TP VERSION 2R33)
IST1490I DLU=NETA.SSCP2A SID=EAABEEC3710FD9E7
IST1462I ECHO IS ON
IST1463I ALLOCATION DURATION 17717 MILLISECONDS
IST1464I PROGRAM STARTUP AND VERSION EXCHANGE: 81 MILLISECONDS
IST1465I         DURATION      DATA SENT   DATA RATE   DATA RATE
IST1466I      (MILLISECONDS)    (BYTES)    (KBYTE/S)    (MBIT/S)
IST1467I               74            200           2           0
IST1467I            19543            200           0           0
IST1468I TOTALS:    19617            400           0           0
IST1469I DURATION STATISTICS:
IST1470I MINIMUM = 74 AVERAGE = 9808 MAXIMUM = 19543
IST314I END
Displaying APING information when the destination is in a non-native network:
d net,aping,id=netb.sscp7b
IST097I DISPLAY ACCEPTED
IST1489I APING SESSION INFORMATION
IST1490I DLU=NETB.SSCP7B SID=F6ABEEC374364CA8
IST933I LOGMODE=#INTER  , COS=*BLANK*
IST875I APPNCOS TOWARDS SLU = #INTER
IST1460I TGN  CPNAME             TG TYPE      HPR
IST1461I  21  NETA.SSCP1A        APPN         ANR
IST1461I  21  NETB.SSCP7B        ISL          ANR
IST314I END
 
IST1457I VTAM APING VERSION 2R33 (PARTNER TP VERSION 2R33)
IST1490I DLU=NETB.SSCP7B SID=F6ABEEC374364CA8
IST1462I ECHO IS ON
IST1463I ALLOCATION DURATION 360 MILLISECONDS
IST1464I PROGRAM STARTUP AND VERSION EXCHANGE: 262 MILLISECONDS
IST1465I         DURATION      DATA SENT   DATA RATE   DATA RATE
IST1466I      (MILLISECONDS)    (BYTES)    (KBYTE/S)    (MBIT/S)
IST1467I              334            200           0           0
IST1467I              108            200           1           0
IST1468I TOTALS:      442            400           0           0
IST1469I DURATION STATISTICS:
IST1470I MINIMUM = 108 AVERAGE = 221 MAXIMUM = 334
IST314I END