LINKCONTROL

Syntax

                                  [A(ll)          ]
                                  [C(onfiguration)]
 LINKCONTROL linkname  {;STATUS=} [L(inkstate)    ]
                       {,       } [S(tat)istics)) ]
                                  [D(iag(stats))  ]
                                  [R(eset)        ]

                                  [,DATA   ]
                            [ON]  [,ALL    ]
 LINKCONTROL Linkname;TRACE=[OFF] [,PARTIAL][,buffsize][,tracefile]
                                  [,FULL   ]

Use

 Available          In Session?          YES
                    In Job?              YES
                    In Break?            YES
                    Programmatically?    YES
 Breakable?                              YES
 Capabilities?                           NM

Parameters

linkname

The configured name of an active data communications link. Only the link name specified in the LINK portion of the configuration file (@LINK.linkname) is valid. The character @ may be used to signify all active links. (Partial wildcards, such as PSI@, are not allowed, however.)

STATUS

Requests status information about the link. May not be used with the TRACE option. For all options, displays the linkname, linktype, and additional information as follows:

ALL

Prints the information displayed by the LINKSTATE, CONFIGURATION, and STATISTICS parameters. These parameters are described more fully later in this section. Additional information about the LINKCONTROL command and its parameters can be found in Appendix A "LINKCONTROL Command"

CONFIGURATION

Prints the information displayed by the LINKSTATE parameter along with link configuration information for the link. The link configuration data consists mainly of the configuration information that was input for this link during NMMGR configuration. The fields that are displayed by this parameter are described in Appendix A "LINKCONTROL Command"

LINKSTATE

Prints link status information, including the link name, link type, and the current status of the link.

DIAGSTATS

Prints the information displayed by the LINKSTATE, CONFIGURATION, and STATISTICS parameters along with additional diagnostic statistics.

STATISTICS

Prints the information displayed by the LINKSTATE command and link statistics, including accumulated error information. This includes such information as the number of data bytes sent and received, and the number of frames sent and received. The fields that are displayed by this parameter are described in Appendix A "LINKCONTROL Command"

RESET

Resets the accumulated data and link statistics that are displayed by the previously described parameters to 0. Displays the same fields that are displayed by the STATISTICS parameter.

The STATUS and TRACE parameters are mutually exclusive and may not be specified together in a LINKCONTROL command.

TRACE

Activates link-level tracing. Only one active trace is allowed per link. If a trace is already active, issuing the command a second time will result in a TRACE REQUEST FAILED error message (NMERR 182).

If TRACE is specified, either ON or OFF must also be specified.

ON

Turns link level tracing on.

OFF

Turns link level tracing off. Any subsequent subparameters are checked for syntax but are otherwise ignored.

DATA

(LAN and token ring links only) Traces all read and write requests. If neither DATA nor ALL is specified, DATA is the default.

ALL

(LAN and token ring links only) Traces all read, write, control, status, and exception requests.

PARTIAL

(Point-to-Point only) Trace all read, write, control, status, and exception requests. Only the first 16 bytes of data are traced for reads or writes.

FULL

(Point-to-Point only) Traces the full data field for all read, write, control, status, and exception requests. If neither PARTIAL nor FULL is specified, PARTIAL is the default.

buffsize

The trace buffer size in memory, in kilobytes. This area is used to buffer trace data before it is written to disk. Allowable values are from 1 to 16.

tracefile

Actual file designator of the disk file where the trace is to be written. If not specified, the trace will automatically be written to a file with the name NMTCnnnn.PUB.SYS, where nnnn is a value between 0000 and 9999. If the filename is specified without group or account names, the current group and account names are used.

TRACE may not be specified in a LINKCONTROL command also containing STATUS.

Discussion

Example 1:

 LINKCONTROL SYSLINK, ALL

 Linkname: SYSLINK   Linktype: IEEE8023   Linkstate: CONNECTED

 Physical Path:                  4.3
 Inbound Buffer Size:                  1536
 Inbound Number of Buffers:              64
 Inbound Buffers Available:              56
 Current Station Address:              08-00-09-00-EE-8C
 Default Station Address:              08-00-09-00-EE-8C
 Current Receive Filter:          bad(0) multi(1) broad(1) any(0)
 Current Multicast Addresses:
   09-00-09-00-00-01
 Transmits no error             19231   Receives no error    2493981
 Transmits error                    0   Receives error            16
 Out of Tx bufs                     0   Out of Rx bufs             2
 Transmits deferred               370   Carrier losses             0
 Transmits 1 retry                 16   Reflectometer              0
 Transmits 1 retry                 15   CRC errors                12
 Transmits 16 collisions            0   Whole byte errors         11
 Transmits late collision           0   Size range errors          0
 802 chip restarts                  0   Frame losses              10
 Heartbeat losses                   0

Example 2:

 :LINKCONTROL SYSLINK;TRACE=ON,DATA,8
 Trace has been successfully enabled for SYSLINK.
 The trace file, for SYSLINK, is NMTC0006.PUB.SYS.

 :LINKCONTROL SYSLINK;TRACE=OFF
 Trace has been successfully disabled for SYSLINK.