Print Communications Trace (PRTCMNTRC)

Print Communications Trace (PRTCMNTRC)

Where allowed to run: All environments (*ALL)
Threadsafe: No Parameters
Examples
Error messages

The Print Communications Trace (PRTCMNTRC) command transfers the communications trace data for the specified line, network interface description, or network server description to a spooled file or an output file.
The PRTCMNTRC command can also be used to format communications trace data that was previously dumped to a stream file using the Dump Communications Trace (DMPCMNTRC) command.
Restrictions:

You must have service (*SERVICE) special authority, or be authorized to the Service Trace function of Operating System through iSeries Navigator's Application Administration support. The Change Function Usage (CHGFCNUSG) command, with a function ID of QIBM_SERVICE_TRACE, can also be used to change the list of users that are allowed to perform trace operations.
The trace data for network server description traces can only be transferred to a spooled file. The trace data cannot be transferred to an output file. There are no formatting options available.
The following user profiles have authority to this command:

QSECOFR
QSRV

Top

Parameters

Keyword Description Choices Notes
CFGOBJ Configuration object Name Optional, Positional 1
FROMSTMF From stream file Path name Optional
CFGTYPE Type *LIN, *NWI, *NWS Optional, Positional 2
OUTPUT Output *PRINT, *OUTFILE Optional
OUTFILE File to receive output Qualified object name Optional
Qualifier 1: File to receive output Name
Qualifier 2: Library Name, *LIBL, *CURLIB
OUTMBR Output member options Element list Optional
Element 1: Member to receive output Name, *FIRST
Element 2: Replace or add records *REPLACE, *ADD
CODE Character code *EBCDIC, *ASCII, *CALC Optional
SLTLIND Line description Name, *ALL Optional
SLTCTLD Controller description Name, *ALL Optional
FMTSNA Format SNA data only *NO, *YES Optional
FMTRR Format RR, RNR commands *NO, *YES Optional
FMTTCP Format TCP/IP data *LINTYPE, *YES, *NO Optional
FMTLCP Format LCP data *YES, *NO Optional
FMTNCP Format NCP data *YES, *NO Optional
TCPIPADR Format TCP/IP data by address Element list Optional
Element 1: Source/destination IP address Character value, *ALL
Element 2: Source/destination IP address Character value, *ALL
SLTPORT IP port number Decimal number, *ALL Optional
FMTUI Format UI data only *NO, *YES Optional
FMTMAC Format MAC or SMT data only *NO, *YES Optional
FMTETH Format Ethernet data only *NO, *YES Optional
FMTCCD Format call control data *NO, *YES Optional
FMTBCD Format broadcast data *NO, *YES Optional
EXCLMI Exclude LMI data *NO, *YES Optional
FMTLMI Format LMI data only *NO, *YES Optional
FMTHPRIP Format HPR over IP data only *NO, *YES Optional
FMTLDLCIP Format LDLC over IP data only *NO, *YES Optional

Top

Configuration object (CFGOBJ)

Specifies the configuration object being traced. The object must be a line description, a network interface description, or a network server description.
Either the CFGOBJ and CFGTYPE parameters or the FROMSTMF parameter must be specified.

name

Specify the name of the configuration description object.

Top

From stream file (FROMSTMF)

Specifies the path name of the stream file from which communications trace data is formatted. This file must have been created by running the Dump Communications Trace (DMPCMNTRC) CL command. Either the CFGOBJ and CFGTYPE parameters or the FROMSTMF parameter must be specified.

path-name

Specify the path name of the stream file created by the DMPCMNTRC command.

Top

Type (CFGTYPE)

Specifies the type of configuration description that was traced.
Either the CFGOBJ and CFGTYPE parameters or the FROMSTMF parameter must be specified.

*LIN

The type of configuration object is a line description.

*NWI

The type of configuration object is a network interface description.

*NWS

The type of configuration object is a network server description.

Top

Output (OUTPUT)

Specifies whether the output from the command is printed with the job's spooled output or sent to a database file.

For network server description traces, *PRINT must be specified for this parameter.

*PRINT

The output is printed with the job's spooled output.

*OUTFILE

The output is directed to the database file specified for the File to receive output (OUTFILE) parameter.

Top

File to receive output (OUTFILE)

Specifies the database file to which the output of the command is directed. If the file does not exist, this command creates a database file in the specified library. If the file is created, the public authority for the file is the same as the create authority specified for the library in which the file is created. Use the Display Library Description (DSPLIBD) command to show the library's create authority.
Qualifier 1: File to receive output

name

Specify the name of the database file to which the command output is directed.

Qualifier 2: Library

*LIBL

The library list is used to locate the file. If the file is not found, one is created in the current library. If no current library exists, the file will be created in the QGPL library.

*CURLIB

The current library for the thread is used to locate the file. If no library is specified as the current library for the thread, the QGPL library is used.

name

Specify the name of the library to be searched.

Top

Output member options (OUTMBR)

Specifies the name of the database file member to which the output is directed when *OUTFILE is specified for the Output (OUTPUT) parameter.
Element 1: Member to receive output

*FIRST

The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified for the File to receive output (OUTFILE) parameter.

name

Specify the name of the file member that receives the output. If OUTMBR(member-name) is specified and the member does not exist, the system creates it.
If the member exists, you can add records to the end of the existing member or clear the existing member and add the records.

Element 2: Replace or add records

*REPLACE

The existing records in the specified database file member are replaced by the new records.

*ADD

The new records are added to the existing information in the specified database file member.

Top

Character code (CODE)

Specifies whether the extended binary-coded decimal interchange code (*EBCDIC) or the American National Standard Code for Information Interchange (*ASCII) character code is used on the line.

*CALC

The system determines whether to format the user data in EBCDIC or ASCII, based on the type of controller that is used.

*ASCII

The ASCII character code is used.

*EBCDIC

The EBCDIC character code is used.

Top

Line description (SLTLIND)

Specifies whether to format data for all lines or a specific line communicating on the network during a trace.

*ALL

Formats the data for all lines.

name

Specify the name of the line for which trace data is formatted.

Top

Controller description (SLTCTLD)

Specifies whether to format data for all controllers or a specific controller communicating on the network during a trace.

*ALL

Formats data for all controllers.

controller-name

Specify the name of the controller for which trace data is formatted.

Top

Format SNA data only (FMTSNA)

Specifies whether line protocol data or Systems Network Architecture (SNA) data is formatted. Line protocol data includes SDLC, X.25, Carrier Sense Multiple Access with Collision Detection (CSMA/CD), Ethernet DIX V2, DDI, wireless, and IBM Token-Ring Network (TRLAN).

*NO

Only line protocol data is formatted.

*YES

Only SNA data is formatted.

Top

Format RR, RNR commands (FMTRR)

Specifies whether receiver ready (RR) and receiver not ready (RNR) commands are formatted with other data.

*NO

RR and RNR commands are not formatted with other data.

*YES

RR and RNR commands are formatted with other data.

Top

Format TCP/IP data (FMTTCP)

Specifies whether line protocol data or Transmission Control Protocol/Internet Protocol (TCP/IP) data is formatted.

If the trace data is being formatted from a stream file (FROMSTMF parameter), this parameter is ignored and TCP/IP data is formatted.

*LINTYPE

For X.25, Ethernet, DDI, wireless, Token-Ring, and Frame Relay lines, only line protocol data is formatted. For all other lines supporting TCP/IP, TCP/IP data is formatted.

*YES

TCP/IP data is formatted.

*NO

TCP/IP data is not formatted.

Top

Format LCP data (FMTLCP)

Specifies whether Link Control Protocol (LCP) data is included in the formatted communications trace.

If FMTLCP, FMTNCP, and FMTTCP are all specified *NO when formatting data for a Point-to-Point Protocol (PPP) line, then asynchronous and unrecognized data will be placed in the spooled file. This is also the case if all are specified *YES (or *LINTYPE for FMTTCP). In all other cases asynchronous and unrecognized data will be omitted.

*YES

LCP data is formatted.

*NO

LCP data is not formatted.

Top

Format NCP data (FMTNCP)

Specifies whether Network Control Protocol (NCP) data is included in the formatted communications trace.

*YES

NCP data is formatted.

*NO

NCP data is not formatted.

Top

Format TCP/IP data by address (TCPIPADR)

Specifies an internet address pair for which TCP/IP data is formatted. Any values that are valid for IP address 1 are also valid for IP address 2.
The internet address is specified in the form, nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. An internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address.
For IPv6 (IP version 6) addresses, the form is xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx, where x is any valid hexadecimal digit 0 through F.

IPv6 addresses are only valid when formatting trace data from a stream file.
Element 1: Source/destination IP address

*ALL

The communications between the systems specified for element 2 and all other systems are printed.

character-value

Specify the address of the system for which communications between this system and the systems specified for element 2 are printed.

Element 2: Source/destination IP address

*ALL

The communications between the systems specified for element 1 and all other systems are printed.

character-value

Specify the address of the system for which communications between this system and the systems specified for element 1 are printed.

Top

IP port number (SLTPORT)

Specifies whether data for all internet protocol (IP) ports or only a single IP port is formatted.

This parameter is valid only if FMTTCP(*YES) is specified.

*ALL

Data for all IP ports is formatted.

decimal-number

Specify the IP port number (1 to 65535) whose data is to be formatted.

Top

Format UI data only (FMTUI)

Specifies whether line protocol data or unnumbered information (UI) data is formatted.

*NO

All line protocol data is formatted.

*YES

Only UI data is formatted.

Top

Format MAC or SMT data only (FMTMAC)

Specifies whether line protocol data or medium access control (MAC) or Station Management (SMT) data is formatted.

*NO

The line protocol data (TRLAN or Ethernet) is formatted.

*YES

Only MAC or SMT data is formatted.

Top

Format Ethernet data only (FMTETH)

Specifies whether IEEE 802.3 data or Ethernet V2 data is formatted.

*YES

Both IEEE 802.3 data and Ethernet V2 data are formatted.

*NO

Only IEEE 802.3 data is formatted.

Top

Format call control data (FMTCCD)

Specifies whether all network interface data or only Integrated Services Digital Network (ISDN) signalling data is formatted.

*NO

All network interface data is formatted.

*YES

Only ISDN signaling data is formatted.

Top

Format broadcast data (FMTBCD)

Specifies whether broadcast data and data received containing destination MAC addresses is formatted.

*YES

Broadcast data is formatted.

*NO

Broadcast data is not formatted.

Top

Exclude LMI data (EXCLMI)

Specifies whether to exclude local management interface (LMI) data from the formatted output.

*NO

LMI data is not excluded from the formatted output.

*YES

LMI data is excluded from the formatted output.

You cannot specify *YES for both the EXCLMI and FMTLMI parameters.

Top

Format LMI data only (FMTLMI)

Specifies whether local management interface (LMI) data is formatted.

*NO

LMI data is not formatted.

*YES

LMI data is formatted.

You cannot specify *YES for both the EXCLMI and FMTLMI parameters.

Top

Format HPR over IP data only (FMTHPRIP)

Specifies whether High Performance Routing Protocol (HPR) over IP data is included in the formatted communications trace.

*NO

HPR over IP data is not formatted.

*YES

Only HPR over IP data is formatted.

Top

Format LDLC over IP data only (FMTLDLCIP)

Specifies whether Logical Data Link Control (LDLC) over IP data is included in the formatted communications trace.

*NO

LDLC over IP data is not formatted.

*YES

Only LDLC over IP data is formatted.

Top

Examples
 PRTCMNTRC   CFGOBJ(*QESLINE)  CFGTYPE(*LIN)
This command prints communications trace data for line description QESLINE.

Top

Error messages

*ESCAPE Messages

CPF2634

Not authorized to object &1.

CPF39AF

Trace is ending - please wait

CPF39A7

Trace storage not available in communications processor

CPF39A8

Not authorized to communications trace service tool

CPF39A9

Error occurred during communications trace function

CPF39BA

Formatting options selected not valid

CPF39BB

Communications trace data not printed

CPF39BC

Communications trace print request cannot be completed

CPF39B0

No communications traces exist.

CPF39B1

Trace &1 type &2 does not exist

CPF39B3

Trace &1 type &2 contains no data

CPF39B4

Trace data for &1 type &2 cannot be printed

CPF39B5

Communications trace data not printed

CPF39B6

Communications trace function cannot be performed

CPF39B7

Trace data for &1 type &2 cannot be printed

CPF39B8

No SNA data found in trace &1 type &2

CPF39B9

No trace records found for printing trace &1 type &2

CPF39C4

IP address not valid.

CPF3CF2

Error(s) occurred during running of &1 API.

CPF9803

Cannot allocate object &2 in library &3.

CPF9845

Error occurred while opening file &1.

CPF9846

Error while processing file &1 in library &2.

CPF9847

Error occurred while closing file &1 in library &2.

CPF9860

Error occurred during output file processing.

CPF9872

Program or service program &1 in library &2 ended. Reason code &3.

CPF98A2

Not authorized to &1 command.

CPFA0D4

File system error occurred. Error number &1.

Top

Keyword	Description	Choices	Notes
CFGOBJ	Configuration object	Name	Optional, Positional 1
FROMSTMF	From stream file	Path name	Optional
CFGTYPE	Type	LIN, NWI, *NWS	Optional, Positional 2
OUTPUT	Output	PRINT, OUTFILE	Optional
OUTFILE	File to receive output	Qualified object name	Optional
	Qualifier 1: File to receive output	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
OUTMBR	Output member options	Element list	Optional
	Element 1: Member to receive output	Name, *FIRST
	Element 2: Replace or add records	REPLACE, ADD
CODE	Character code	EBCDIC, ASCII, *CALC	Optional
SLTLIND	Line description	Name, *ALL	Optional
SLTCTLD	Controller description	Name, *ALL	Optional
FMTSNA	Format SNA data only	NO, YES	Optional
FMTRR	Format RR, RNR commands	NO, YES	Optional
FMTTCP	Format TCP/IP data	LINTYPE, YES, *NO	Optional
FMTLCP	Format LCP data	YES, NO	Optional
FMTNCP	Format NCP data	YES, NO	Optional
TCPIPADR	Format TCP/IP data by address	Element list	Optional
	Element 1: Source/destination IP address	Character value, *ALL
	Element 2: Source/destination IP address	Character value, *ALL
SLTPORT	IP port number	Decimal number, *ALL	Optional
FMTUI	Format UI data only	NO, YES	Optional
FMTMAC	Format MAC or SMT data only	NO, YES	Optional
FMTETH	Format Ethernet data only	NO, YES	Optional
FMTCCD	Format call control data	NO, YES	Optional
FMTBCD	Format broadcast data	NO, YES	Optional
EXCLMI	Exclude LMI data	NO, YES	Optional
FMTLMI	Format LMI data only	NO, YES	Optional
FMTHPRIP	Format HPR over IP data only	NO, YES	Optional
FMTLDLCIP	Format LDLC over IP data only	NO, YES	Optional