ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/chgusrtrc.htm

214 lines
7.9 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>Change User Trace (CHGUSRTRC)</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="CHGUSRTRC.Top_Of_Page"></a>
<h2>Change User Trace (CHGUSRTRC)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>Yes
</td>
<td valign="top" align="right">
<a href="#CHGUSRTRC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CHGUSRTRC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CHGUSRTRC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CHGUSRTRC"></a>
<p>The Change User Trace Buffer (CHGUSRTRC) command changes the user trace buffer associated with the specified job. Each user trace buffer is a user space (*USRSPC) object in library QUSRSYS by the name QP0Znnnnnn, where 'nnnnnn' is the job number of the job using the user trace.
</p>
<p>The user trace supports user-generated trace records written using the Qp0zUprintf, Qp0zDump, Qp0zDumpStack, and Qp0zDumpTargetStack APIs. Refer to the System API Reference information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter, <b>OS/400 UNIX-type APIs</b> for more information on the Problem Determination APIs.
</p>
<p>The trace records written to the user trace buffer with the Problem Determination APIs can be formatted and placed into a file or written to the <b>stdout</b> file by using the DMPUSRTRC (Dump User Trace Buffer) CL command.
</p>
<p>User trace buffer spaces can be deleted by using the DLTUSRTRC (Delete User Trace Buffer) CL command.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CHGUSRTRC.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" rowspan="4"><a href="#CHGUSRTRC.JOB"><b>JOB</b></a></td>
<td valign="top">Job name</td>
<td valign="top">Single values: <b><u>*</u></b><br>Other values: <i>Qualified job name</i></td>
<td valign="top" rowspan="4">Optional, Key, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job name</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: User</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 3: Number</td>
<td valign="top">000000-999999</td>
</tr><tr>
<td valign="top"><a href="#CHGUSRTRC.CLEAR"><b>CLEAR</b></a></td>
<td valign="top">Clear trace buffer</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CHGUSRTRC.MAXSTG"><b>MAXSTG</b></a></td>
<td valign="top">Maximum storage to use</td>
<td valign="top">10-16382, <b><u>*SAME</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CHGUSRTRC.TRCFULL"><b>TRCFULL</b></a></td>
<td valign="top">Trace full</td>
<td valign="top">*WRAP, *STOPTRC, <b><u>*SAME</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CHGUSRTRC.JOB"></a>
<h3>Job name (JOB)</h3>
<p>Specifies the job for which the user trace buffer is being changed.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The user trace buffer for the job that the command is running in is changed.
</dd>
<dt><b><i>job-name</i></b></dt>
<dd>Specify the name of the job whose user trace buffer is being changed. If no user name or job number qualifier is given, all of the jobs currently in the system are searched for the simple job name. If duplicates of the specified name are found, a qualified job name must be specified.
</dd>
<dt><b><i>user-name</i></b></dt>
<dd>Specify the name of the user of the job whose user trace buffer is being changed.
</dd>
<dt><b><i>job-number</i></b></dt>
<dd>Specify the six-digit number of the job whose user trace buffer is being changed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGUSRTRC.CLEAR"></a>
<h3>Clear trace buffer (CLEAR)</h3>
<p>Specifies whether all trace records currently stored in the user trace buffer space should be removed.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>No trace records are removed from the user trace buffer.
</dd>
<dt><b>*YES</b></dt>
<dd>All trace records currently stored in the user trace buffer are removed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGUSRTRC.MAXSTG"></a>
<h3>Maximum storage to use (MAXSTG)</h3>
<p>Specifies the size, in kilobytes, that the user trace buffer will be created to (if it doesn't exist) or resized to (if it exists). If this parameter is specified, *YES must also be specified for the CLEAR parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The user trace size is not changed. The default size (300 kilobytes) is used to create the user trace buffer when the first user trace API is called.
</dd>
<dt><b><i>maximum-kilobytes</i></b></dt>
<dd>Specify the maximum amount of storage, in kilobytes, used to store user trace records. One kilobyte equals 1024 bytes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGUSRTRC.TRCFULL"></a>
<h3>Trace full (TRCFULL)</h3>
<p>Specifies whether the trace records wrap (replace oldest records with new records) or whether the trace stops when all of the storage specified by the MAXSTG parameter has been used.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The current attribute does not change. The default when a user trace buffer space is created is TRCFULL(*WRAP).
</dd>
<dt><b>*WRAP</b></dt>
<dd>When the trace file is full, the trace wraps to the beginning. The oldest trace records are written over by new ones as they are collected.
</dd>
<dt><b>*STOPTRC</b></dt>
<dd>Tracing stops when the trace buffer space is full of trace records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHGUSRTRC.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Changing the User Trace Buffer Size for the Current Job</b>
</p>
<p>
<pre>
CHGUSRTRC JOB(*) MAXSTG(100) CLEAR(*YES)
</pre>
</p>
<p>This command changes the user trace buffer size for the current job to 100 kilobytes.
</p>
<p><b>Example 2: Clearing the User Trace Buffer for a Specific Job</b>
</p>
<p>
<pre>
CHGUSRTRC JOB(123581/DEPT2/WS1) CLEAR(*YES)
</pre>
</p>
<p>This command clears the user trace buffer for job WS1, which is associated with the user profile DEPT2, and has the job number 123581.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHGUSRTRC.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPFA98A</b></dt>
<dd>A User Trace option could not be changed for job &amp;3/&amp;2/&amp;1.
</dd>
<dt><b>CPFA98C</b></dt>
<dd>Job &amp;3/&amp;2/&amp;1 not unique.
</dd>
<dt><b>CPF1070</b></dt>
<dd>Job &amp;3/&amp;2/&amp;1 not found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGUSRTRC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>