234 lines
8.5 KiB
HTML
234 lines
8.5 KiB
HTML
|
|
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>End Trace (ENDTRC)</title>
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<a name="ENDTRC.Top_Of_Page"></a>
|
|
<h2>End Trace (ENDTRC)</h2>
|
|
<table width="100%">
|
|
<tr>
|
|
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
|
|
<b>Threadsafe: </b>No
|
|
</td>
|
|
<td valign="top" align="right">
|
|
<a href="#ENDTRC.PARAMETERS.TABLE">Parameters</a><br>
|
|
<a href="#ENDTRC.COMMAND.EXAMPLES">Examples</a><br>
|
|
<a href="#ENDTRC.ERROR.MESSAGES">Error messages</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<div> <a name="ENDTRC"></a>
|
|
<p>The End Trace (ENDTRC) command ends a trace session that was started by a STRTRC (Start Trace) command.
|
|
</p>
|
|
<p><b>Restrictions:</b>
|
|
</p>
|
|
<ul>
|
|
<li>To use this command, 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.
|
|
</li>
|
|
<li>If DTAOPT(*LIB) is specified, you must have authority to the library and the database files within that library where the trace data is stored.
|
|
</li>
|
|
<li>If PRTTRC(*YES) is specified, you must have authority to the PRTTRC (Print Trace) command.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
|
|
<div>
|
|
<h3><a name="ENDTRC.PARAMETERS.TABLE">Parameters</a></h3>
|
|
<table border="1" cellpadding="4" cellspacing="0">
|
|
<!-- col1="10" col2="15" col3="30" col4="10" -->
|
|
<tr>
|
|
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
|
|
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
|
|
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
|
|
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ENDTRC.SSNID"><b>SSNID</b></a></td>
|
|
<td valign="top">Session ID</td>
|
|
<td valign="top"><i>Name</i>, *PRV</td>
|
|
<td valign="top">Required, Positional 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ENDTRC.DTAOPT"><b>DTAOPT</b></a></td>
|
|
<td valign="top">Data option</td>
|
|
<td valign="top"><b><u>*LIB</u></b>, *DLT</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ENDTRC.DTALIB"><b>DTALIB</b></a></td>
|
|
<td valign="top">Data library</td>
|
|
<td valign="top"><i>Name</i>, <b><u>*CURLIB</u></b></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ENDTRC.RPLDTA"><b>RPLDTA</b></a></td>
|
|
<td valign="top">Replace data</td>
|
|
<td valign="top"><b><u>*YES</u></b>, *NO</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ENDTRC.PRTTRC"><b>PRTTRC</b></a></td>
|
|
<td valign="top">Print trace data</td>
|
|
<td valign="top"><b><u>*NO</u></b>, *YES</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</div>
|
|
<div> <a name="ENDTRC.SSNID"></a>
|
|
<h3>Session ID (SSNID)</h3>
|
|
<p>Specifies a session identifier for the trace to be ended. This name must match the session identifier of a trace that had been previously started and is still active.
|
|
</p>
|
|
<p>This is a required parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b>*PRV</b></dt>
|
|
<dd>The trace session most recently started by the same user who is running this ENDTRC command will be ended. For example, if the job running the ENDTRC command is running under user profile BOB, the last trace session started under user profile BOB is ended.
|
|
</dd>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the session identifier of the trace to be ended.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ENDTRC.DTAOPT"></a>
|
|
<h3>Data option (DTAOPT)</h3>
|
|
<p>Specifies whether the trace data that has been collected is stored into database files or if the trace data is deleted.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*LIB</u></b></dt>
|
|
<dd>The trace data will be copied into database files. The PRTTRC parameter on this command or the Print Trace (PRTTRC) command can be used to format and print the data.
|
|
</dd>
|
|
<dt><b>*DLT</b></dt>
|
|
<dd>The trace data will be deleted from the internal buffers where it was collected.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ENDTRC.DTALIB"></a>
|
|
<h3>Data library (DTALIB)</h3>
|
|
<p>Specifies the name of the library in which the trace data will be stored. A set of database files will be created in this library to contain the trace data. The files will be created if they do not already exist.
|
|
</p>
|
|
<p>
|
|
<b>Note: </b>This parameter is valid only if *LIB is specified for the <b>Data option (DTAOPT)</b> parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*CURLIB</u></b></dt>
|
|
<dd>The trace data is stored in files in the current library for the job. If no library is specified as the current library for the job, QGPL is used.
|
|
</dd>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the name of the library to contain the trace data files. The library must already exist when the ENDTRC command is run.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ENDTRC.RPLDTA"></a>
|
|
<h3>Replace data (RPLDTA)</h3>
|
|
<p>Specifies whether trace data that was collected by a previous trace session with the same session identifier is replaced with new trace data. This is determined by checking if the set of database files where the trace data is to be stored already have file members with the same name as the specified trace session identifier (SSNID parameter).
|
|
</p>
|
|
<p>
|
|
<b>Note: </b>This parameter is valid only if *LIB is specified for the <b>Data option (DTAOPT)</b> parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*YES</u></b></dt>
|
|
<dd>If trace data already exists with the specified session identifier, the old trace data is lost and replaced by the new trace data.
|
|
</dd>
|
|
<dt><b>*NO</b></dt>
|
|
<dd>If trace data already exists for the specified session, an error message is sent to the user.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ENDTRC.PRTTRC"></a>
|
|
<h3>Print trace data (PRTTRC)</h3>
|
|
<p>Specifies whether trace data is formatted and printed after it is stored in the trace database files.
|
|
</p>
|
|
<p>
|
|
<b>Note: </b>This parameter is valid only if *LIB is specified for the <b>Data option (DTAOPT)</b> parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*NO</u></b></dt>
|
|
<dd>The PRTTRC (Print Trace) command is not run as part of this command.
|
|
</dd>
|
|
<dt><b>*YES</b></dt>
|
|
<dd>The PRTTRC (Print Trace) command is run after the trace data has been stored in the database files.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="ENDTRC.COMMAND.EXAMPLES">Examples</a> </h3>
|
|
<p><b>Example 1: End Most Recently Started Trace</b>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
ENDTRC SSNID(*PRV)
|
|
</pre>
|
|
</p>
|
|
<p>This command ends the trace session started most recently by the same user who is running the ENDTRC command. The trace data will be stored in a set of files in the current library of the job, or QGPL if there is no current library for the job.
|
|
</p>
|
|
<p><b>Example 2: End a Trace and Delete Trace Data</b>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
ENDTRC SSNID(DCG1) DTAOPT(*DLT)
|
|
</pre>
|
|
</p>
|
|
<p>This command ends the trace session DCG1 and deletes the trace data.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="ENDTRC.ERROR.MESSAGES">Error messages</a> </h3>
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
|
</p>
|
|
<dl>
|
|
<dt><b>CPC3923</b></dt>
|
|
<dd>ENDTRC session ID &1 successfully saved into library &2.
|
|
</dd>
|
|
<dt><b>CPC3924</b></dt>
|
|
<dd>ENDTRC session ID &1 successfully deleted.
|
|
</dd>
|
|
<dt><b>CPF39CA</b></dt>
|
|
<dd>Trace session ID &1 not found.
|
|
</dd>
|
|
<dt><b>CPF39CB</b></dt>
|
|
<dd>Trace session ID &1, in library &2, data exists. Specify RPLDTA(*YES).
|
|
</dd>
|
|
<dt><b>CPF98A2</b></dt>
|
|
<dd>Not authorized to &1 command.
|
|
</dd>
|
|
<dt><b>CPF39D3</b></dt>
|
|
<dd>Unable to start/end the trace.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ENDTRC.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</body>
|
|
</html>
|