TRACE for buffer, I/O, NCP line, QDIOSYNC, SIT, SMS, or STATE (with ID) traces

Read syntax diagramSkip visual syntax diagram
   .-NOTRACE--,--TYPE--=--BUF (¹)-----------------------.   
>>-+----------------------------------------------------+------->
   '-TRACE--,--TYPE--=--BUF--| BUF trace operands (²) |-'   

   .-NOTRACE--,--TYPE--=--IO (¹)----------------------.   
>--+--------------------------------------------------+--------->
   '-TRACE--,--TYPE--=--IO--| IO trace operands (²) |-'   

   .-NOTRACE--,--TYPE--=--LINE (¹)------------------------.   
>--+------------------------------------------------------+----->
   '-TRACE--,--TYPE--=--LINE--| LINE trace operands (²) |-'   

                                        .-,--ID--=--*-------------.     
   .-NOTRACE--,--TYPE--=--QDIOSYNC (¹)--+-------------------------+-.   
   |                                    '-,--ID--=--+-*---------+-' |   
   |                                                '-trle_name-'   |   
>--+----------------------------------------------------------------+-->
   '-TRACE--,--TYPE--=--QDIOSYNC--| QDIOSYNC trace operands (²) |---'   

   .-NOTRACE--,--TYPE--=--SIT (¹)-----------------------.   
>--+----------------------------------------------------+------->
   '-TRACE--,--TYPE--=--SIT--| SIT trace operands (²) |-'   

   .-NOTRACE--,--TYPE--=--SMS (¹)------------------.   
>--+-----------------------------------------------+------------>
   '-TRACE--,--TYPE--=--SMS--,--ID--=--VTAMBUF (²)-'   

   .-NOTRACE--,--TYPE--=--STATE (¹)-------------------------.   
>--+--------------------------------------------------------+--><
   '-TRACE--,--TYPE--=--STATE--| STATE trace operands (²) |-'   

BUF trace operands

|--,--ID--=--node_name--+----------+---------------------------->
                        '-,--EVERY-'   

   .-,--AMOUNT--=--PARTIAL-----.   
>--+---------------------------+-------------------------------->
   '-,--AMOUNT--=--+-FULL----+-'   
                   '-PARTIAL-'     

   .-,--IDTYPE--=--RESOURCE-----.  .-,--SAVE--=--YES-----.   
>--+----------------------------+--+---------------------+------|
   '-,--IDTYPE--=--+-CP-------+-'  '-,--SAVE--=--+-NO--+-'   
                   +-SSCP-----+                  '-YES-'     
                   '-RESOURCE-'                              

IO trace operands

|--,--ID--=--node_name--+----------+---------------------------->
                        '-,--EVERY-'   

   .-,--IDTYPE--=--RESOURCE-----.  .-,--SAVE--=--YES-----.   
>--+----------------------------+--+---------------------+------|
   '-,--IDTYPE--=--+-CP-------+-'  '-,--SAVE--=--+-NO--+-'   
                   +-SSCP-----+                  '-YES-'     
                   '-RESOURCE-'                              

LINE trace operands

                        .-,--COUNT--=--ALL (³)-------------.   
|--,--ID--=--line_name--+----------------------------------+----|
                        '-,--COUNT--=--+-ALL-------------+-'   
                                       '-number_of_bytes-'     

QDIOSYNC trace operands

   .-,--ID--=--*-------------.   
|--+-------------------------+---------------------------------->
   '-,--ID--=--+-*---------+-'   
               '-trle_name-'     

   .-,--OPTION--=--ALLINOUT-----.   
>--+----------------------------+------------------------------->
   '-,--OPTION--=--+-ALLIN----+-'   
                   +-ALLINOUT-+     
                   +-ALLOUT---+     
                   +-IN-------+     
                   +-INOUT----+     
                   '-OUT------'     

   .-,--SYNCID--=--trle_name--.  .-,--SAVE--=--YES-----.   
>--+--------------------------+--+---------------------+--------|
   '-,--SYNCID--=--identifier-'  '-,--SAVE--=--+-NO--+-'   
                                               '-YES-'     

SIT trace operands

                        .-,--COUNT--=--ALL (³)-------------.   
|--,--ID--=--line_name--+----------------------------------+---->
                        '-,--COUNT--=--+-ALL-------------+-'   
                                       '-number_of_bytes-'     

>--+-------------------------------+----------------------------|
   '-,--TRACEPT--=--trace_point_id-'   

STATE trace operands

                        .-,--IDTYPE--=--RESOURCE-----.   
|--,--ID--=--node_name--+----------------------------+---------->
                        '-,--IDTYPE--=--+-CP-------+-'   
                                        +-SSCP-----+     
                                        '-RESOURCE-'     

   .-,--SAVE--=--YES-----.   
>--+---------------------+--------------------------------------|
   '-,--SAVE--=--+-NO--+-'   
                 '-YES-'     

Note:
  1. Do not use NOTRACE when starting VTAM®, except to override a TRACE start option coded in a predefined list.
  2. Code TRACE and its qualifiers on one line. Code the TYPE qualifier immediately after TRACE.
  3. COUNT applies only to the IBM® 3720 and 3745 Communication Controllers.

Specifies whether VTAM starts or cancels a specific type of trace for a node or line, or monitors the usage of all the VTAM buffer pools.

If you code the TRACE option, code the TYPE qualifier immediately after TRACE.

You can specify a network-qualified name on the ID=node_name operand of the TRACE start option for buffer, I/O, and QDIOSYNC traces.

You can change the value of TRACE with the MODIFY TRACE command while VTAM is running.
AMOUNT
Specifies whether VTAM records part or all of the data that is transmitted in inbound and outbound message buffers.
AMOUNT=PARTIAL
Specifies that VTAM records the data in trace records with a maximum size of 256 bytes. Each trace record contains a trace record header and data. Data that does not fit in the trace record is lost. This operand can be abbreviated as AMT=P.
AMOUNT=FULL
Specifies that VTAM records all of the data transmitted in message buffers. Multiple trace records might be needed to record all of the data. This operand can be abbreviated as AMT=F.
COUNT=number_of_bytes or ALL
The number of bytes of data you want traced. The range is 0–254. If you do not code COUNT, or if you code COUNT=ALL, VTAM traces a maximum of 255 bytes of data in the PIU.

COUNT is valid only if you are running an SIT or LINE trace for a 3720, 3725, or 3745 communication controller.

EVERY
Specifies that VTAM starts or stops the requested trace for the resource named in the ID operand and all appropriate minor nodes of this resource.

You can abbreviate this operand as E.

This operand applies only to buffer and I/O traces. For example:
  • TRACE,TYPE=IO,ID=line name,E

This start option initiates an I/O trace for the line and each of its minor nodes.

This operand is not valid if ID=ISTPUS or ID=ISTIRN is also coded. If ID names a channel-attachment major node, code the EVERY option. You can name the link in a channel-attachment major node, but you cannot name the link station.

IDTYPE
Specifies the type of resource that the ID operand names. In cases where several types of resources share the same name, IDTYPE can be used to identify which resource the start option should act on.

If both a CP and an SSCP have the name specified on the ID operand, then both resources are traced.

IDTYPE is valid only for the buffer contents, I/O, and resource state traces.
IDTYPE=CP
Specifies that the name on the ID operand is a CP. Only the trace for a host CP or for the cross-domain resource that represents the adjacent CP is affected by this start option.
IDTYPE=SSCP
Specifies that the name on the ID operand is an SSCP. Only the trace for an SSCP is affected by this start option.
IDTYPE=RESOURCE
Specifies that the name on the ID operand is one of the following items. VTAM looks for the resource in the order they are listed here:
  1. SSCP
  2. Host CP
  3. Adjacent CP
  4. Another resource
ID=line name
Names the specific line for which a VTAM trace is started or stopped. line name corresponds to the name on the LINE statement that represents the same line.

Each line traced must be explicitly coded in a TRACE start option.

ID=node name
Names the specific node for which a VTAM trace is started or stopped. node name corresponds to the name assigned to the node and filed in the VTAM definition library. node name can be a network-qualified name for the buffer and I/O traces. See the description of the MODIFY TRACE command in z/OS Communications Server: SNA Operation for a list of the types of nodes you can choose.

For CMIP application programs, node_name is the name of the internal or external application program. For the VTAM topology agent, node_name is ISTTOPAG. For notification services, node_name is ISTNOTIF.

For external CMIP application programs, node_name is the application name defined as the ACB name of the application program major node.

For a CDRM, you can specify a network-qualified name, but this does not remove the restriction that the non-network-qualified CDRM name must be unique across networks.

You can use ID=VTAM to trace all SSCP activity and, in a multiple-domain network, all cross-domain resource manager activity. You can use ID=ISTPUS or the HOSTPU value to trace all SSCP-PU activity. Each terminal or logical unit traced must be explicitly coded in a TRACE start option.

ID=trle_name|*
When TYPE=QDIOSYNC is specified, the ID operand specifies the TRLE name of the OSA-Express2 or later adapter for which diagnostic data synchronization and filtering is to be started or stopped. Specify ID=* to start or stop QDIOSYNC for all TRLEs that define OSA-Express2 or later adapters. When the value ID=* is specified with SAVE=NO, ID=* indicates that the QDIOSYNC command is to be applied to all currently active TRLEs that define OSA-Express2 or later adapters. When the value ID=* is specified with SAVE=YES, ID=* indicates that the QDIOSYNC command is to be applied to all currently active TRLEs that define OSA-Express2 or later adapters and to those that are activated by this VTAM in the future.

When multiple QDIOSYNC NOTRACE or TRACE start options are specified, the last one that is applicable to a specific TRLE name takes precedence. For example, coding TRACE TYPE=QDIOSYNC,ID=TRLE1 requests synchronization for a single OSA-Express2 or later adapter but the request is cancelled if it is followed by NOTRACE TYPE=QDIOSYNC,ID=*. Coding TRACE TYPE=QDIOSYNC,ID=* requests synchronization of all OSA-Express2 or later adapters and, if it is followed by NOTRACE TYPE=QDIOSYNC,ID=TRLE1, it results in the synchronization of all OSA-Express2 or later adapters except TRLE1.

NOTRACE
Specifies that VTAM cancels the trace requested by the TYPE operand. You should code this start option only when you need to override a predefined TRACE start option. Code a separate NOTRACE start option to stop each trace.
OPTION
For the value TYPE=QDIOSYNC, the OPTION operand specifies the scope and filter to be applied by the OSA-Express2 or later adapter. The option specifies the devices and the direction for which diagnostic data is to be gathered. You can abbreviate this operand as OPT.
OPTION=ALLIN
Indicates that the adapter should gather diagnostic data for all devices, including any that might be controlled by other operating systems. This option also indicates that the adapter should collect records pertinent to events and data flowing from the adapter to the host. Code the value OPTION=ALLIN only when advised by IBM service to do so.
OPTION=ALLINOUT
Indicates that the adapter should gather diagnostic data for all devices, including any that might be controlled by other operating systems. This option also indicates that the adapter should collect both inbound and outbound diagnostic data.
OPTION=ALLOUT
Indicates that the adapter should gather diagnostic data for all devices, including any that might be controlled by other operating systems. This option also indicates that the adapter should collect records pertinent to events and data flowing from the host to the adapter. Code OPTION=ALLOUT only when advised by IBM service to do so.
OPTION=IN
Indicates that the adapter should gather diagnostic data for devices defined to this VTAM only. This option also indicates that the adapter should collect records pertinent to events and data flowing from the adapter to the host. Code OPTION=IN only when advised by IBM service to do so.
OPTION=INOUT
Indicates that the adapter should gather diagnostic data for devices defined to this VTAM only. This option also indicates that the adapter should collect both inbound and outbound diagnostic data. Code OPTION=INOUT only when advised by IBM service to do so.
OPTION=OUT
Indicates that the adapter should gather diagnostic data for devices defined to this VTAM only. This option also indicates that the adapter should collect records pertinent to events and data flowing from the host to the adapter. Code OPTION=OUT only when advised by IBM service to do so.
SAVE
Applies to TYPE=BUF, TYPE=IO, TYPE=QDIOSYNC, and TYPE=STATE. It specifies whether the trace request is saved for the resource named on the ID operand.
SAVE=YES
VTAM saves the trace request for the resource named on the ID operand. If the resource exists when this request is issued, the trace starts immediately. If the resource does not exist when this request is issued, VTAM saves the trace command and starts the trace when the resource is defined.

For TYPE=BUF, TYPE=IO, and TYPE=STATE, if you start a trace with IDTYPE=RESOURCE and a CP or an SSCP (but not both) exists when the command is issued, VTAM starts the trace for the existing resource and saves the trace commands for both resources. If both a CP and an SSCP exist when the command is issued, VTAM starts tracing for them immediately.

For TYPE=QDIOSYNC:
  • If you specify ID=trlename, any saved command from a previous TRACE TYPE=QDIOSYNC start option for that TRLE is deleted.
  • If you specify ID=*, all saved commands from previous TRACE TYPE=QDIOSYNC start options are deleted

Use the MODIFY NOTRACE command to delete a saved trace command. VTAM will not delete a saved trace command until you issue a MODIFY NOTRACE command for it, even though the resource might be created and freed or activated and deactivated several times. Saved trace commands are lost when VTAM is halted and restarted.

SAVE=NO
Does not save the trace request. If the resource does not exist when you start the trace, the request fails.
SYNCID
Optional operand valid for TYPE=QDIOSYNC. The OSA-Express2 or later uses this value as part of an identifier when it captures diagnostic data. If this operand is not specified, the trlename value is used.

Restriction: If you specify a value for SYNCID, it must conform to the rules for names detailed in Format of definition statements.

TRACE
Specifies that VTAM starts a specific type of trace for a node or line, or monitors the use of all the VTAM buffer pools. Once started, the trace remains in effect until it is stopped, either by stopping VTAM or by entering the MODIFY NOTRACE command. More than one trace can run concurrently, but code a separate TRACE start option to start each trace.
TRACEPT=trace_point_id
Specifies the point in the microcode at which tracing should be activated. TRACEPT applies to TYPE=SIT and is valid only if you are tracing CSS resources on an IBM 3745 Communication Controller. If you omit this operand, tracing is done for all valid trace points. The TRACEPT operand allows you to limit the tracing to a single trace point if too much output is being produced.

VTAM accepts any integer in the range 1–255; however, only a few values are defined by the NCP. For information on which values are defined and what they mean, see NCP, SSP, and EP Trace Analysis Handbook.

TYPE=BUF
Specifies whether a VTAM buffer trace is started or stopped.
TYPE=IO
Specifies whether a VTAM I/O trace is started or stopped.
TYPE=LINE
Specifies that an NCP line trace is started or stopped for a communication controller. There can be up to 8 concurrent line traces and scanner interface traces (SIT) for each NCP, depending on how each NCP is generated.
TYPE=SIT
Specifies that a scanner interface trace is started or stopped for a 3720, 3725, or 3745 communication controller. There can be up to 8 concurrent line traces and SITs for each NCP, depending on how each NCP was generated.
TYPE=QDIOSYNC
Use TYPE=QDIOSYNC to synchronize and optionally apply a scope and filter to OSA-Express2 or later diagnostic data.
Arming the OSA-Express2 or later directs it to capture diagnostic data when there is an unexpected loss of host connectivity. Data is also captured when the following conditions occur:
  1. The VTAM-supplied message processing facility (MPF) exit (IUTLLCMP) is driven.
  2. Either the VTAM or TCP/IP functional recovery routine (FRR) is driven with ABEND06F. ABEND06F is the result of a PER trap SLIP command that specifies ACTION=RECOVERY.

    Restriction: The SLIP must be a PER trap SLIP in order to specify ACTION=RECOVERY.

See z/OS Communications Server: SNA Diagnosis Vol 1, Techniques and Procedures for more information about using the QDIOSYNC facility.
TYPE=SMS,ID=VTAMBUF
Specifies that VTAM monitors the number of its requests to obtain buffers in the VTAM buffer pools. (After a specified number of requests occur, the trace creates a record to show how the pools are being used at that time.) If you code TYPE=SMS, also code ID=VTAMBUF.
TYPE=STATE
Specifies whether a resource state trace is started or stopped to monitor changes in the state of the resource named on the ID operand.