Dump Communications Trace (DMPCMNTRC)

Dump Communications Trace (DMPCMNTRC)

Where allowed to run: All environments (*ALL)

Threadsafe: No

The Dump Communications Trace (DMPCMNTRC) command copies the unformatted trace data for the specified line, network interface description, or network server description to a user-specified stream file. The data in the stream file can be formatted at a later time, either on the current system or a different system, by using the Print Communications Trace (PRTCMNTRC) command and specifying the FROMSTMF parameter, or by using a custom formatter that supports the Packet Capture (PCAP) format.

Restrictions:

To use this command, you must have service (*SERVICE) special authority, or be authorized to the Service trace function of IBM i through System i 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 following user profiles have authority to this command:
- QSECOFR
- QSRV

Parameters

Keyword	Description	Choices	Notes
CFGOBJ	Configuration object	Name	Required, Positional 1
CFGTYPE	Type	LIN, NWI, *NWS	Required, Positional 2
TOSTMF	To stream file	Path name	Required, Positional 3
REPLACE	Replace file	NO , YES	Optional
FORMAT	Stream file format	CMNTRC , PCAP	Optional

Configuration object (CFGOBJ)

Specifies the configuration object that was traced. The object is either a line description, a network interface description, or a network server description.

name: Specify the name of the configuration object.

Type (CFGTYPE)

Specifies the type of configuration description that was traced.

*LIN: The configuration object is a line description.
*NWI: The configuration object is a network interface description.
*NWS: The configuration object is a network server description.

To stream file (TOSTMF)

Specifies the stream file to which data is copied. All directories in the path name must exist. New directories are not created. If the stream file does not exist, it is created.

path-name: Specify the path name for the stream file to be used.

Replace file (REPLACE)

Specifies whether the dump operation replaces or fails to copy the records to a stream file if a stream file with the specified name already exists. If the stream file does not exist, it is created.

*NO: No records are copied and an error message is signalled if the file already exists.
*YES: The trace data records replace the existing stream file records.

Stream file format (FORMAT)

Specifies the format the dump file will have.

*CMNTRC: Format used by the Print Communication Trace (PRTCMNTRC) command.
*PCAP: Packet Capture (PCAP) format, used by network protocol analyzers in other operating systems, such as Linux and AIX.

Examples


DMPCMNTRC   CFGOBJ(*QESLINE)  CFGTYPE(*LIN)
            TOSTMF('/user/Test.stmf')  REPLACE(*YES)
            FORMAT(*CMNTRC)

This command dumps the communications trace of line description QESLINE to stream file /user/Test.stmf in Communications Trace format. If this stream file already exists, it will be replaced.

Error messages

*ESCAPE Messages

CPF2634: Not authorized to object &1.
CPF39AF: Trace is ending - please wait
CPF39A8: Not authorized to communications trace service tool
CPF39A9: Error occurred during communications trace function
CPF39B0: No communications traces exist.
CPF39B1: Trace &1 type &2 does not exist
CPF39B3: Trace &1 type &2 contains no data
CPF39B6: Communications trace function cannot be performed
CPF39B8: No SNA data found in trace &1 type &2
CPF3CF2: Error(s) occurred during running of &1 API.
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.
CPF9872: Program or service program &1 in library &2 ended. Reason code &3.
CPFA0D4: File system error occurred. Error number &1.