TCP/IP Line Driver Operator Commands

Entire Net-Work's TCP/IP line driver has the ability to process operator commands that are directed to a specific link or directly to the driver.

For information about entering operator commands under z/VSE, see the section Entering Operator Commands.

This document covers the following topics:


Operator Command Syntax

Under z/OS, the TCP/IP line driver operator commands have the following format:

graphics/tcpimvso.png

The following table describes this syntax.

Syntax Representation Description
TCPI Informs Entire Net-Work that the command is destined for the TCP/IP driver. If more than one TCPI DRIVER statement exists, use the name specified on the DRVNAME parameter of the DRIVER statement instead of TCPI.
target

A value that informs TCPI what the target of the command is, as follows:

  • Specify an asterisk (*) if the target is all links.

  • Specify the DRVCHAR value ("#" is the default) if the target is the driver itself (see the DRVCHAR parameter on the TCP/IP DRIVER Statement).

  • Specify the link name if the target is a specific link.

cmd The operator commands to be carried out. Multiple commands can be specified in a single command statement. When the ALTER command is specified, it must be the last command in the statement, because everything following the ALTER command is treated as a DRIVER or LINK statement parameter. One or more DRIVER or LINK statement parameters must be specified.

Examples

The following are examples of TCP/IP line driver operator commands:

F NETWORK,TCPI * CLOSE
NETWORK TCPI # STATS
F NETWORK,TCPI link3 CONNECT

Driver Commands

The Entire Net-Work TCP/IP line driver supports the commands listed in the following table when the target is the driver. The underlined portion of the command is the minimum abbreviation.

Command Action
ALTER driver-parms

Dynamically changes the driver configuration. The ALTER command is followed by the driver configuration parameters to be altered. The driver configuration parameters are the same as those specified in the DRIVER statement. For example:

TCPI # ALTER
          ACCEPTUI=Y

Refer to the specific parameter description for information on possible restrictions about modifying the parameter using the ALTER command.

CLOSE
Disconnects and closes all links that are connected to other nodes. Releases all resources held by the driver as well as all open links. Closes the driver.
OPEN
Reopens the driver after it is closed with the CLOSE operator command or because of an access method failure. Allocates all the resources needed by the driver to communicate with TCP/IP. Also attempts to resolve any unresolved host names.
RESET
Resets all statistics for the driver. Statistics are printed only if the STATS command precedes the RESET command.
SHOW
Displays the current configuration of the driver. The current configuration is always shown automatically following an ALTER command.
SNAP
Causes all control blocks specific to the link to be snapped (printed in hexadecimal). Driver specific control blocks and Entire Net-Work specific control blocks are not snapped.
STATS

Causes the immediate printing of statistics and restarts the statistics interval. This command has no effect on the next automatic printing of statistics. To print and reset statistics, specify RESET immediately after the STATS command. For example:

TCPI # STATS RESET
STATUS
Displays the current status of the driver as well as a count of messages received and sent.
TRACE
Causes the TCP/IP driver to format and print the driver-specific trace table. The trace table is formatted and printed in hexadecimal automatically when the SNAP command is processed.

Note:
When the driver is closed, it does not recognize the commands CLOSE, STATS, or RESET.

Link Commands

The Entire Net-Work TCP/IP line driver supports the commands listed in the following table when the target is a link or all links. The underlined portion of the command is the minimum abbreviation.

Command Action
ALTER link-parms 

Dynamically changes the link configuration. The ALTER command is followed by the link configuration parameters to be altered. The link configuration parameters are the same as those specified on the LINK statement. For example:

TCPI LINK1 ALTER ADJHOST=DALLAS

Refer to the specific parameter description for information on possible restrictions about modifying the parameter using the ALTER command.

CLOSE
Disconnects the link if it is connected to another node and releases all resources held by the link.
CONNECT 
Attempts to establish one or more TCP/IP sessions with the target link(s). If the link is already connected or is in the process of connecting, the command is ignored.
DISCONNECT 
Starts the disconnect sequence for the target link(s). If the link is already disconnected or is in the process of disconnecting, the command is ignored.
LOGLON linkname
Turns on selective logging for the specified link.
LOGLOFF linkname
Turns off selective logging for the specified link.
OPEN
Allocates all the resources needed by the link to communicate with TCP/IP. Does not initiate a connect to the remote node. The status of the link displayed via the SHOW operator command is not affected by the OPEN request.
RESET
Resets all statistics for the link. Statistics are printed only if the STATS command precedes the RESET command.
RESUME
Restarts processing on a link that was temporarily stopped due to a SUSPEND command.
SHOW
Displays the current configuration of the link. The current configuration is always shown automatically following an ALTER command.
SNAP
Causes all link specific control blocks and the link specific trace table to be snapped (printed in hexadecimal). Driver specific control blocks and Entire Net-Work specific control blocks are not snapped.
STATS

Causes the immediate printing of statistics and restarts the statistics interval. This command has no effect on the next automatic printing of statistics. To print and reset statistics, specify RESET immediately after the STATS command. For example:

TCPI LINK1 STATS RESET
STATUS
Displays the current status of the link as well as a count of messages received and sent.
SUSPEND
Temporarily stops all processing on a link. Processing can be restarted with the RESUME command.
TRACE
Causes the link specific trace table to be formatted and printed. The trace table is formatted and printed in hexadecimal automatically when the SNAP command is processed.

BS2000/OSD Net-Work Sockets Tracing

The BS2000 sockets task includes code to trace the logic, the data transferred, and the interface with the FSC Sockets subsystem. This tracing is normally requested using the sixth value of the OPTIONS1 parameter. In order to facilitate the diagnosis of problems, there are two operator commands that can be directed to the Sockets task. The first allows the level of tracing to be altered dynamically. The changes the SYSOUT file used by the task, allowing the tracing output to be viewed without shutting down Entire Net-Work. The operator commands can be supplied from an operator console or from a DIALOG session in a USER-ID with operating privileges ($TSOS, for example).

Command Action
CHANGE-TRACE n
The tracing level is set to n, where n is the tracing level.

On z/OS and z/VSE systems, the tracing levels can range from 0-9.

On BS2000 systems, the tracing levels can range from 0-19 and behave as described below:

  • A value of "0" disables tracing immediately.

  • A value of "1" traces connect/accept events plus error situations.

  • A value of "2" or "3" traces payload messages as well.

  • Values "4" through "9" also include a tracing of the socket library of BS2000.

  • A value of "10" is ignored.

  • A value of "11" behaves in the same manner as a value of "1", but goes into level "5" automatically when outgoing data transfer is stopped due to system congestion. When the congestion is cleared, level "5" is switched back to level "1" automatically.

  • Values ranging from "12" through 19 are ignored.

On BS2000 systems, all values greater than "1" can have a negative impact on your systems performance and should only be activated in problem situations.

CHANGE-SYSOUT
The current SYSOUT file is replaced. If an FGG is in use, the generation will be used; if a SAM file is in use, a new file will be created with a suffix (its name will appear at the end of the original SYSOUT file).

Examples

To switch on tracing:

/INF-PROG 'CHANGE-TRACE 2',*TSN(<Sockets task TSN>)

To switch off tracing:

/INF-PROG 'CHANGE-TRACE 0',*TSN(<Sockets task TSN>)

To free the SYSOUT file so the tracing output can be viewed:

/INF-PROG 'CHANGE-SYSOUT',*TSN(<Sockets task TSN>)