DISPLAY ROUTE command

Read syntax diagramSkip visual syntax diagram
Displaying the status of routes:

>>-DISPLAY-- --NET--,--ROUTE--,--DESTSUB--=--subarea_number----->

   .-,--ER--=--ALL-------.                           
>--+---------------------+--+--------------------+-------------->
   +-,--COSNAME--=--name-+  '-,--NETID--=--netid-'   
   +-,--ER--=--ALL-------+                           
   +-,--ER--=--er_number-+                           
   '-,--VR--=--vr_number-'                           

                                      .-,--TEST--=--NO------.   
>--+-------------------------------+--+---------------------+--><
   +-,--ORIGIN--=--subarea_pu_name-+  '-,--TEST--=--+-NO--+-'   
   '-,--ORIGIN--=--ALL-------------'                '-YES-'     

Read syntax diagramSkip visual syntax diagram
Displaying blocked virtual routes:

>>-DISPLAY-- --NET--,--ROUTE--,--BLOCKED------------------------>

>--+------------------------+----------------------------------->
   |                    (1) |   
   '-,--NETID--=--netid-----'   

>--+-------------------------------+---------------------------><
   +-,--ORIGIN--=--subarea_pu_name-+   
   '-,--ORIGIN--=--ALL-------------'   

Notes:
  1. When the BLOCKED operand is specified, the NETID of the host where the command was entered is assumed, and specification of another NETID is not permitted.
Read syntax diagramSkip visual syntax diagram
Displaying held virtual routes:

>>-DISPLAY-- --NET--,--ROUTE--,--HELD--------------------------><

Abbreviations

Operand Abbreviation
DISPLAY D
DESTSUB DESTSA

Purpose

The DISPLAY ROUTE command displays the status of explicit routes and virtual routes and tests whether a route is operational.

Operands

Route selection
Specifies which explicit routes or virtual routes are to be displayed. A blank COS entry is used when no COSNAME entry has been coded in the LOGMODE table for LU-LU sessions or when an ISTVTCOS entry for SSCP-type sessions cannot be found.
BLOCKED
Displays the blocked Virtual Routes from the PU specified in ORIGIN for all destination Subarea combinations known to VTAM® through its current PATH table.
COSNAME=name
Specifies a Class of Service name. If this operand is specified, all virtual routes to the specified destination subarea within this Class of Service are displayed.

The Class of Service table associated with the origin node (where applicable) and the netid specified in the ORIGIN and NETID operands are used to resolve the Class of Service name to a list of virtual routes.

If COSNAME is specified, neither the BLOCKED, ER nor the VR operands can be specified.

DESTSUB=subarea_number
Specifies the subarea address of the destination subarea of the routes to be displayed.

The BLOCKED and DESTSUB operands are mutually exclusive.

ER=er_number
Specifies the explicit route number (an integer 0–15). If this operand is specified, all the explicit routes identified by this explicit route number that are defined to VTAM through activation of a path definition statement are displayed. An explicit route becomes known to VTAM either by having been defined at one time (through the activation of a path definition set defining the ER), or by having been operative at one time (through the receipt of an ER_OP request unit from the network).

If ER is specified, neither the BLOCKED, COSNAME nor the VR operands can be specified.

ER=ALL
Specifies that every explicit route to the specified destination subarea is to be displayed.

If ER is specified, neither the BLOCKED, COSNAME nor the VR operands can be specified.

If COSNAME, ER, or VR options are not specified, then ER=ALL is assumed.

VR=vr_number
Specifies the virtual route number (an integer 0–7). If this operand is specified, the virtual routes identified by this virtual route number to the specified destination subarea are displayed. There can be up to three virtual routes identified by the virtual route number, with one route for each of the three transmission priority levels.

If VR is specified, neither the BLOCKED, COSNAME, nor the ER operands may be specified.

HELD
Displays the held virtual routes for the virtual routes that originate in VTAM. When this command is used, no other keywords are permitted. The NETID and ORIGIN of the host where the command was entered is assumed.
Note: Held virtual routes have a status of active.
NETID=netid
Specifies the network attached to the origin node that contains the routes. VTAM sends the requested NETID to the origin node in the route test request. The request succeeds if the origin node can recognize the NETID. NETID is a required start option.

If the netid specified is not the network in which the command is issued, or the host is not gateway capable, the ORIGIN operand is required for the command to succeed.

If you do not specify a NETID, the default is the network identifier supplied by the NETID option at start time.

When the BLOCKED operand is specified, the NETID of the host where the command was entered is assumed and specification of another NETID is not permitted.

ORIGIN=ALL
Used with the BLOCKED operand. Specifies that all PU type 4 and 5 nodes that serve as an origin of a route should be checked for blocked Virtual Routes. As in the case where the subarea_pu_name is specified, VTAM must have an SSCP-PU session with this node to forward a route display request to the node.
Warning: The use of this operand may have a significant performance impact depending on the number of NCPs and destination subareas in the network. Therefore, it is recommended that this operand be used only when the diagnostic advantage is preferred over the performance impact.
Note: Specifying an ORIGIN by name, instead of using ORIGIN=ALL, will greatly reduce the performance impact.
ORIGIN=subarea_pu_name
Specifies the node where the route starts. VTAM must have an SSCP-PU session with this node to forward the route display request to the node. In addition, the node must be an NCP subarea node or the host physical unit name (as specified in the HOSTPU start option). The command fails if you specify an external host subarea node because VTAM has no SSCP-PU session with the physical unit in another host subarea.

The default for the ORIGIN operand is the host physical unit specified in the HOSTPU start option.

TEST
Specifies whether an explicit route test is to be performed for a route to a destination subarea. Testing is not supported for APPN routes.

If TEST is specified, the BLOCKED operand cannot be specified.

TEST=YES
Specifies that VTAM is to perform an explicit route test for each explicit route contained in the requested display. That is, if the VR operand is specified, the explicit route defined to be used by the specified virtual route is tested; if the COSNAME operand is specified, those explicit routes defined to be used by the virtual routes within the specified Class of Service are tested. When the test results are received, these test results are sent to the operator that requested the display; however, these test results are sent separately from the initial display results. The test results include a display number that you can use to correlate the results the original status display.

For an explicit route to be tested, it must be known to VTAM, either by having been defined at one time (through the activation of a path definition set defining the ER), or by having been operative at one time (through the receipt of an ER_OP request unit from the network).

If a node or link along a route becomes inoperative after the ER test request unit has been sent, VTAM might never receive any test results for that explicit route.

TEST=NO
Specifies that the requested route status is to be displayed, but that no explicit route test is to be performed.

Resulting display

The resulting display shows:
  • The subarea number of the nodes
  • The origin of the physical unit (PU) name (if known)
  • The destination of the PU name (if known)
  • The network ID (where applicable) of the network attached to the origin PU that contains the routes
  • The virtual route
  • The transmission priority, status, explicit route number, adjacent subarea and its status, and the transmission group number

Examples

Displaying one virtual route to a destination subarea:
d net,route,destsub=01,netid=netc,origin=c0453le,vr=0
IST097I DISPLAY ACCEPTED
IST535I ROUTE DISPLAY 8  FROM SA 4 TO SA 1
IST808I ORIGIN PU = C0453LE DEST PU = C01NPU   NETID = NETC
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN MAX
IST537I  0   0    ACTIV     5            1    1  ACTIV3
IST537I  0   1    INACT     5            1    1  ACTIV3
IST537I  0   2    INACT     5            1    1  ACTIV3
IST314I END
Displaying one explicit route to a destination subarea:
d net,route,destsub=01,netid=netc,origin=a03n43a,er=5
IST097I DISPLAY ACCEPTED
IST535I ROUTE DISPLAY 7  FROM SA 4 TO SA 1
IST808I ORIGIN PU = C0453LE DEST PU = C01NPU   NETID = NETC
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN MAX
IST537I  0   0    ACTIV     5            1    1  ACTIV3
IST537I  0   1    INACT     5            1    1  ACTIV3
IST537I  0   2    INACT     5            1    1  ACTIV3
IST314I END
Displaying all virtual routes in a Class of Service to a destination subarea:
d net,route,destsub=01,netid=netc,origin=a0362zc,cosname=ist
IST097I DISPLAY  ACCEPTED
IST535I ROUTE DISPLAY 4  FROM SA         31 TO SA          1
IST808I ORIGIN PU = A0362ZC DEST PU = ***NA*** NETID = NETC
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN MAX
IST537I  0   2    ACTIV     0            1    1  ACTIV3
IST537I  1   2    INACT     1            1    1  ACTIV1
IST537I  2   2    INACT     2            1    1  ACTIV1
IST537I  3   2    INACT     3            1    1  ACTIV1
IST537I  4   2    INACT     4            1    1  ACTIV1
IST537I  5   2    UNDEF
IST537I  6   2    UNDEF
IST537I  7   2    UNDEF
IST537I  0   1    INACT     0            1    1  ACTIV3
IST537I  1   1    INACT     1            1    1  ACTIV1
IST537I  2   1    INACT     2            1    1  ACTIV1
IST537I  3   1    INACT     3            1    1  ACTIV1
IST537I  4   1    INACT     4            1    1  ACTIV1
IST537I  5   1    UNDEF
IST537I  6   1    UNDEF
IST537I  7   1    UNDEF
IST537I  0   0    ACTIV     0            1    1  ACTIV3
IST537I  1   0    INACT     1            1    1  ACTIV1
IST537I  2   0    INACT     2            1    1  ACTIV1
IST537I  3   0    INACT     3            1    1  ACTIV1
IST537I  4   0    INACT     4            1    1  ACTIV1
IST537I  5   0    UNDEF
IST537I  6   0    UNDEF
IST537I  7   0    UNDEF
IST314I END
Displaying and testing all virtual routes in a Class of Service to a destination subarea:
d net,route,destsub=01,netid=netc,origin=a0362zc,cosname=ist,test=yes
IST097I DISPLAY  ACCEPTED
IST535I ROUTE DISPLAY 6  FROM SA         31 TO SA          1
IST808I ORIGIN PU = A0362ZC DEST PU = ***NA*** NETID = NETC
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN MAX
IST537I  0   2    ACTIV     0            1    1  ACTIV3
IST537I  1   2    INACT     1            1    1  ACTIV1
IST537I  2   2    INACT     2            1    1  ACTIV1
IST537I  3   2    INACT     3            1    1  ACTIV1
IST537I  4   2    INACT     4            1    1  ACTIV1
IST537I  5   2    UNDEF
IST537I  6   2    UNDEF
IST537I  7   2    UNDEF
IST537I  0   1    INACT     0            1    1  ACTIV3
IST537I  1   1    INACT     1            1    1  ACTIV1
IST537I  2   1    INACT     2            1    1  ACTIV1
IST537I  3   1    INACT     3            1    1  ACTIV1
IST537I  4   1    INACT     4            1    1  ACTIV1
IST537I  5   1    UNDEF
IST537I  6   1    UNDEF
IST537I  7   1    UNDEF
IST537I  0   0    ACTIV     0            1    1  ACTIV3
IST537I  1   0    INACT     1            1    1  ACTIV1
IST537I  2   0    INACT     2            1    1  ACTIV1
IST537I  3   0    INACT     3            1    1  ACTIV1
IST537I  4   0    INACT     4            1    1  ACTIV1
IST314I END
IST538I ROUTE TEST   6 IN PROGRESS
IST533I ER  0 SUCCEEDED IN ROUTE TEST   6
IST797I            FROM   VIA     ADJACENT         DEST     ER LENGTH
IST644I         A0362ZC    TG     ***NA***     ***NA***
IST533I ER  0 SUCCEEDED IN ROUTE TEST   6
IST534I              31     1            1            1             1
IST798I            NETC
IST533I ER  1 SUCCEEDED IN ROUTE TEST   6
IST797I            FROM   VIA     ADJACENT         DEST     ER LENGTH
IST644I         A0362ZC    TG     ***NA***     ***NA***
IST534I              31     1            1            1             1
IST798I            NETC
IST533I ER  2 SUCCEEDED IN ROUTE TEST   6
IST797I            FROM   VIA     ADJACENT         DEST     ER LENGTH
IST644I         A0362ZC    TG     ***NA***     ***NA***
IST534I              31     1            1            1             1
IST798I            NETC
IST314I END
 
Displaying and testing one explicit route to a destination subarea:
d net,route,destsub=01,netid=netc,origin=c0453le,er=5,test=yes
IST097I DISPLAY ACCEPTED
IST535I ROUTE DISPLAY 11 FROM SA 4 TO SA 1
IST808I ORIGIN PU = C0453LE DEST PU = C01NPU   NETID = NETC
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN MAX
IST537I  0   0    ACTIV     5            1    1  ACTIV3
IST537I  0   1    INACT     5            1    1  ACTIV3
IST537I  0   2    INACT     5            1    1  ACTIV3
IST314I END
Displaying and testing all explicit routes to a destination subarea:
d net,route,destsub=01,netid=netc,origin=a0362zc,test=yes
IST097I DISPLAY  ACCEPTED
IST535I ROUTE DISPLAY 8  FROM SA         31 TO SA          1
IST808I ORIGIN PU = A0362ZC DEST PU = ***NA*** NETID = NETC
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN MAX
IST537I  0   0    ACTIV     0            1    1  ACTIV3
IST537I  0   1    INACT     0            1    1  ACTIV3
IST537I  0   2    ACTIV     0            1    1  ACTIV3
IST537I  1   0    INACT     1            1    1  ACTIV1
IST537I  1   1    INACT     1            1    1  ACTIV1
IST537I  1   2    INACT     1            1    1  ACTIV1
IST537I  2   0    INACT     2            1    1  ACTIV1
IST537I  2   1    INACT     2            1    1  ACTIV1
IST537I  2   2    INACT     2            1    1  ACTIV1
IST537I  3   0    INACT     3            1    1  ACTIV1
IST537I  3   1    INACT     3            1    1  ACTIV1
IST537I  3   2    INACT     3            1    1  ACTIV1
IST537I  4   0    INACT     4            1    1  ACTIV1
IST537I  4   1    INACT     4            1    1  ACTIV1
IST537I  4   2    INACT     4            1    1  ACTIV1
IST314I END
IST538I ROUTE TEST   8 IN PROGRESS
IST533I ER  0 SUCCEEDED IN ROUTE TEST   8
IST797I            FROM   VIA     ADJACENT         DEST     ER LENGTH
IST644I         A0362ZC    TG     ***NA***     ***NA***
IST533I ER  0 SUCCEEDED IN ROUTE TEST   8
IST534I              31     1            1            1             1
IST798I            NETC
IST533I ER  1 SUCCEEDED IN ROUTE TEST   8
IST797I            FROM   VIA     ADJACENT         DEST     ER LENGTH
IST644I         A0362ZC    TG     ***NA***     ***NA***
IST534I              31     1            1            1             1
IST798I            NETC
IST533I ER  2 SUCCEEDED IN ROUTE TEST   8
IST797I            FROM   VIA     ADJACENT         DEST     ER LENGTH
IST644I         A0362ZC    TG     ***NA***     ***NA***
IST534I              31     1            1            1             1
IST798I            NETC
IST314I END
 
Displaying blocked virtual routes from one origin PU:
d net,route,blocked,origin=ISTPUS
IST097I DISPLAY ACCEPTED                                        
IST350I DISPLAY TYPE = BLOCKED VIRTUAL ROUTES                   
IST535I ROUTE DISPLAY 1 FROM SA 1 TO SA 1                       
IST808I ORIGIN PU = ISTPUS DEST PU = NCP2B   NETID = NETA       
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN
IST537I  0   0    BLCKD     0            1    1  ACTIV3         
IST537I  0   1    BLCKD     0            1    1  ACTIV3         
IST537I  0   2    BLCKD     0            1    1  ACTIV3         
IST314I END                                                     
IST535I ROUTE DISPLAY 1 FROM SA 1 TO SA 2                       
IST808I ORIGIN PU = ISTPUS DEST PU = NCP4D   NETID = NETA       
IST536I VR  TP    STATUS   ER       ADJSUB  TGN  STATUS  CUR MIN
IST537I  3   1    BLCKD     0            4    1  ACTIV3         
IST537I  3   2    BLCKD     0            4    1  ACTIV3
IST537I  4   0    BLCKD     1            3    1  ACTIV3
IST537I  4   1    BLCKD     1            3    1  ACTIV3
IST314I END                                            
 
Displaying blocked virtual routes from one origin with no blocked routes found:
d net,route,blocked,origin=ISTPUS
IST097I DISPLAY ACCEPTED                     
IST350I DISPLAY TYPE = BLOCKED VIRTUAL ROUTES
IST172I NO BLOCKED VIRTUAL ROUTE             
IST314I END                                  
Displaying held virtual routes with no held routes found:
d net,route,held
IST097I DISPLAY ACCEPTED
IST350I DISPLAY TYPE = HELD VIRTUAL ROUTES
IST172I NO HELD VIRTUAL ROUTE
IST314I END