DISPLAY RTPS command

Abbreviations

Purpose

The DISPLAY RTPS command displays information concerning HPR pipes terminating or originating in the host. The following keywords can be used to limit the display information.

Operands

ALSNAME=name

Specifies the name of an Adjacent Link Station in this node that the HPR pipe goes over.

APPNCOS=name

Specifies the name of a Class of Service (CoS) used to establish the HPR pipe.

CLEAR

Specifies whether to clear diagnostic counters for RTP pipes.

CLEAR=ALL

Diagnostic counters for RTP pipes are cleared. If the CLEAR=ALL option is specified with the command filter CPNAME, the diagnostic counters are cleared for all pipes to the specified partner CP. If the CLEAR=ALL option is specified with the ID command filter, the diagnostic counters of the specified RTP pipe are cleared.

CLEAR=NONE

Diagnostic counters for RTP pipes are not cleared.

Rule: The REXMIT operand limits the scope of the display output, but not the scope of the CLEAR operand. The CLEAR=ALL option clears the diagnostic counters for all RTP pipes whether the REXMIT operand is specified. The CPNAME command filter or ID operand limits the scope of the CLEAR operand.

CONGEST

Specifies whether the display should be restricted.

CONGEST=YES

Displays only pipes that are congested.

CONGEST=NO

Displays only pipes that are not congested.

CONGEST=ALL

Displays all pipes. This is the default value.

CPNAME=name

Specifies the name of a CP that is at the other end of the HPR pipe. The name may be network qualified. If a network identifier is omitted, the host network identifier is assumed.

You can specify * as the name portion of a network-qualified name. The * is useful for displaying only HPR pipes whose other end is in a particular network. To use the * for the name, you must explicitly specify the netid in the form netid.* (for example, NETA.*). The capability of specifying netid.* for this value is not affected by the coding of the DSPLYWLD start option.

FIRSTCP=name

Specifies the name of a CP that is at the other end of the first hop of the HPR pipe. The name may be network qualified. If a network identifier is omitted, the host network identifier is assumed.

You can specify * as the name portion of a network-qualified name. The * is useful for displaying HPR pipes that have a first hop into a particular network. To use the * for the name, you must explicitly specify the netid, in the form netid.* (for example, NETA.*). The capability of specifying netid.* for this value is not affected by the coding of the DSPLYWLD start option.

FIRSTTG=number

Specifies the TG number of the first hop of the HPR pipe. When used with FIRSTCP, a unique hop can be identified. The valid range for this keyword is 0-255.

ID=name

Specifies the name of an RTP PU in this node.

LIST

Specifies the amount of detail the output contains.

LIST=DETAIL

Provides detailed information for each RTP pipe that matches the scope of the display command.

LIST=SUMMARY

Provides a condensed format of the RTP pipe information that matches the scope of the display command.

MAX

Specifies the maximum number of HPR pipes that VTAM® displays for this command.

MAX=*

Specifies that the value of the DSPLYMAX start option is used to limit the display output.

MAX=number_of_resources

Specifies the number of HPR pipes to display for this command. The valid range of this keyword is 1–value of the DSPLYMAX start option. The default is the value specified for the DSPLYDEF start option.

Specifying the MAX operand limits the display output. VTAM searches only for the number of instances that you have specified. When that number is found, VTAM does not search any further. This saves processing time for the command and gives you control over the amount of display output generated by the command. If fewer HPR pipes are found than you have specified on the MAX operand, VTAM displays only the HPR pipes that are found.

QDEPTH

Specifies whether the display should be restricted.

QDEPTH=ALL

Displays all pipes. This is the default value.

QDEPTH=qdepth

Display only HPR pipes that have internal queue depths that meet or exceed the specified qdepth value. Valid values are in the range 100 - 65535.

REXMIT=retransmission_rate_percentage

The retransmission_rate_percentage value specifies that only RTP pipes that have a retransmission rate that is equal to or exceeds the specified percentage should be displayed. The REXMIT counters are maintained from the time the RTP pipe was activated, or since the last DISPLAY RTPS command that cleared the REXMIT counters for this RTP pipe was issued. If CPNAME is specified, only RTP pipes that meet or exceed the retransmission rate for that CP are displayed. If CPNAME is not specified, all RTP pipes that meet or exceed the retransmission rate are displayed.

The valid range is 0 - 100. The retransmission_rate_percentage value can be specified up to two decimal points (for example, 0.22, 1.3, 14.5, 2.69).

Results:

• The display is limited by the MAX operand.
• When the value 0 is specified for the REXMIT operand, all RTP pipes are displayed.

Rule: The REXMIT operand limits the scope of the display output but not the scope of the CLEAR operand. The CLEAR operand clears the diagnostic counters for RTP pipes whether the REXMIT operand is specified. The command filter of CPNAME operand limits the scope of the REXMIT operand and CLEAR operand.

STALL

Specifies whether the display should be restricted.

STALL=YES

Displays only pipes whose data flow is stalled.

STALL=NO

Displays only pipes whose data flow is normal.

STALL=ALL

Displays all pipes. This is the default value.

SWITCH

Specifies whether the display should be restricted.

SWITCH=YES

Displays only pipes in the midst of a path switch.

SWITCH=NO

Displays only pipes not in the midst of a path switch.

SWITCH=ALL

Displays all pipes. This is the default value.

TCID=tcid

Specifies the local transport connection identifier (TCID) for an RTP PU.

Tip: The TCID operand can be used to correlate a local RTP PU name to the RTP PU name used by the remote (VTAM) partner RTP node to represent the same RTP connection. To determine the RTP PU name used by the remote (VTAM) partner RTP node, use the DISPLAY ID=rtp_pu_name command on the local node to display the local RTP PU, and remember the REMOTE TCID value that is displayed at the end of the IST1476I message. Then, from the remote (VTAM) partner RTP node (shown on the IST1481I message in the prior display), issue the DISPLAY RTPS,TCID=tcid command using the REMOTE TCID value obtained from the prior display.

TEST

Specifies whether an HPR route test is to be performed.

TEST is valid only if the ID operand or the TCID operand is also specified and if the resource identified by the ID or TCID operand is an RTP PU in this node.

TEST=YES

Specifies that VTAM is to perform an HPR route test for this RTP PU in addition to displaying the RTP PU status.

The HPR route test is initiated if the RTP PU is connected and is not path switching. When the test results are received, they are provided to the operator console in a separate message group from the initial display output.

TEST=NO

Specifies that the RTP PU status is to be displayed but no HPR route test is to be performed.