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

365 lines
16 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Configure Perf Collection (CFGPFRCOL)</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="CFGPFRCOL.Top_Of_Page"></a>
<h2>Configure Perf Collection (CFGPFRCOL)</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="#CFGPFRCOL.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CFGPFRCOL.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CFGPFRCOL.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CFGPFRCOL"></a>
<p>The Configure Performance Collection (CFGPFRCOL) command changes the Collection Services properties. These properties define certain collection attributes and determine how Collection Services will manage data collection. Some attributes changed with this command will take effect immediately, while others will take effect the next time a collection object is created. See the parameter help to determine how each attribute will be handled. The Collection Services server job (QYPSPFRCOL) can be started or cycled by using the Start Performance Collection (STRPFRCOL) command.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CFGPFRCOL.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="#CFGPFRCOL.INTERVAL"><b>INTERVAL</b></a></td>
<td valign="top">Default interval</td>
<td valign="top"><b><u>*SAME</u></b>, 0.25, 0.5, 1.0, 5.0, 15.0, 30.0, 60.0</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#CFGPFRCOL.LIB"><b>LIB</b></a></td>
<td valign="top">Collection library</td>
<td valign="top"><i>Name</i>, <b><u>*SAME</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGPFRCOL.DFTCOLPRF"><b>DFTCOLPRF</b></a></td>
<td valign="top">Default collection profile</td>
<td valign="top"><b><u>*SAME</u></b>, *MINIMUM, *STANDARD, *STANDARDP, *ENHCPCPLN, *CUSTOM</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGPFRCOL.CYCTIME"><b>CYCTIME</b></a></td>
<td valign="top">Cycle time</td>
<td valign="top"><i>Time</i>, <b><u>*SAME</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGPFRCOL.CYCITV"><b>CYCITV</b></a></td>
<td valign="top">Cycle interval</td>
<td valign="top">1-24, <b><u>*SAME</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CFGPFRCOL.RETPERIOD"><b>RETPERIOD</b></a></td>
<td valign="top">Collection retention period</td>
<td valign="top">Single values: <b><u>*SAME</u></b>, *PERM<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Number of units</td>
<td valign="top">
1-720</td>
</tr>
<tr>
<td valign="top">Element 2: Unit of time</td>
<td valign="top">
*HOURS, *DAYS</td>
</tr>
<tr>
<td valign="top"><a href="#CFGPFRCOL.CRTDBF"><b>CRTDBF</b></a></td>
<td valign="top">Create database files</td>
<td valign="top"><b><u>*SAME</u></b>, *YES, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGPFRCOL.CHGPMLIB"><b>CHGPMLIB</b></a></td>
<td valign="top">Change PM iSeries library</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="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CFGPFRCOL.INTERVAL"></a>
<h3>Default interval (INTERVAL)</h3>
<p>The default collection interval (in minutes). This value is used by most data categories as the collection sample interval. Although some I/O categories are set up to use a specific interval time, this value will determine the collection sample interval for most data. This change will take effect immediately.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The value does not change. If the configured value has never been modified, the interval will be 15 minutes.
</dd>
<dt><b>0.25</b></dt>
<dd>The default collection interval will be 15 seconds.
</dd>
<dt><b>0.5</b></dt>
<dd>The default collection interval will be 30 seconds.
</dd>
<dt><b>1.0</b></dt>
<dd>The default collection interval will be 1 minute.
</dd>
<dt><b>5.0</b></dt>
<dd>The default collection interval will be 5 minutes.
</dd>
<dt><b>15.0</b></dt>
<dd>The default collection interval will be 15 minutes.
</dd>
<dt><b>30.0</b></dt>
<dd>The default collection interval will be 30 minutes.
</dd>
<dt><b>60.0</b></dt>
<dd>The default collection interval will be 60 minutes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGPFRCOL.LIB"></a>
<h3>Collection library (LIB)</h3>
<p>The library where the management collection object (*MGTCOL) will reside. This change will take effect the next time a collection object is created.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The value does not change. If the configured value has never been modified, the library will be QPFRDATA.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the management collection object should be created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGPFRCOL.DFTCOLPRF"></a>
<h3>Default collection profile (DFTCOLPRF)</h3>
<p>Specifies the default collection profile. This determines which categories will be included in the system-level collection. This change will take effect the next time a collection object is created.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The value does not change. If the configured value has never been modified, the default collection profile will be *STANDARDP.
</dd>
<dt><b>*MINIMUM</b></dt>
<dd>The minimum data collection recommended. Includes the following categories: *SYSBUS, *POOL, *HDWCFG, *SYSCPU, *SYSLVL, *JOBMI, *JOBOS, *DISK, and *IOPBASE.
</dd>
<dt><b>*STANDARD</b></dt>
<dd>The standard profile includes all categories which are typically needed by the Performance Tools for iSeries, with the exception of communications data. It includes all categories in the *MINIMUM profile, as well as the following categories: *POOLTUNE, *SUBSYSTEM, *SNADS, *LCLRSP, *APPN, *SNA, *TCPBASE, *USRTNS and *LPAR. The category *DOMINO will be included if the product Domino for iSeries has been installed on the system. The category *HTTP will be included if the product IBM HTTP Server for iSeries (powered by Apache) has been installed on the system.
</dd>
<dt><b>*STANDARDP</b></dt>
<dd>The standard plus profile includes all categories which are typically needed by the Performance Tools for iSeries, including communications data. It includes all categories in the *STANDARD profile, as well as the following categories: *IPCS, *CMNBASE, *CMNSTN, *CMNSAP, *TCPIFC, and *DPS.
</dd>
<dt><b>*ENHCPCPLN</b></dt>
<dd>The enhanced capacity planner profile includes all categories in the *STANDARDP profile, with the addition *INTPEX.
</dd>
<dt><b>*CUSTOM</b></dt>
<dd>The custom profile includes categories as defined by the user. This profile must be defined using the Collection Services function in iSeries Navigator.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGPFRCOL.CYCTIME"></a>
<h3>Cycle time (CYCTIME)</h3>
<p>The base time at which the Collection Services server job (QYPSPFRCOL) will end the current collection and begin collecting data in a new management collection object (*MGTCOL). This change will take effect immediately.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The value does not change. If the configured value has never been modified, the cycle time will be midnight.
</dd>
<dt><b><i>time</i></b></dt>
<dd>Specify the time of day at which the collector will cycle. Although the CL command allows you to enter a time value that contains seconds, Collection Services supports only the hour and minute to cycle. Any value entered for seconds is ignored.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGPFRCOL.CYCITV"></a>
<h3>Cycle interval (CYCITV)</h3>
<p>The time period after which the Collection Services server job (QYPSPFRCOL) will end the current collection and begin collecting data in a new management collection object (*MGTCOL). This parameter controls the maximum amount of data (based on time) that will be stored in a single collection object. This value will take effect immediately.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The value does not change. If the configured value has never been modified, the cycle interval will be 24 hours.
</dd>
<dt><b><i>1-24</i></b></dt>
<dd>Specify the number of hours after which the collection will be cycled.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGPFRCOL.RETPERIOD"></a>
<h3>Collection retention period (RETPERIOD)</h3>
<p>Specifies how long the management collection object (*MGTCOL) should be retained on the system. After the retention period has expired, the object will be automatically deleted by the Collection Services server job (QYPSPFRCOL). Expired collections are removed from the system each time a collection starts or cycles. This change will take effect immediately and will apply to the current and future collection objects.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The value does not change. If the configured value has never been modified, the retention period will be 24 hours.
</dd>
<dt><b>*PERM</b></dt>
<dd>The object will not be automatically deleted.
</dd>
</dl>
<p><b>Element 1: Number of units</b>
</p>
<dl>
<dt><b><i>retention-time</i></b></dt>
<dd>Specify how long the management collection object should be retained in hours or days. The collection object may be retained for up to 30 days.
</dd>
</dl>
<p><b>Element 2: Unit of time</b>
</p>
<p>Specify whether the retention-time value specified for the Number of units element should be treated as a number of hours or a number of days.
</p>
<dl>
<dt><b>*HOURS</b></dt>
<dd>The retention period is specified in hours. The valid time period range is 1 through 720.
</dd>
<dt><b>*DAYS</b></dt>
<dd>The retention period is specified in days. The valid time period range is 1 through 30.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGPFRCOL.CRTDBF"></a>
<h3>Create database files (CRTDBF)</h3>
<p>This option will submit the Create Performance Data (CRTPFRDTA) job. This job will create the performance database files and process the data in the current management collection object as it is collected. The CRTPFRDTA job will end when the Collection Services server job (QYPSPFRCOL) ends or cycles. If this option is set to *YES, a new CRTPFRDTA job will be submitted for every management collection object (*MGTCOL) created. This change will take effect the next time a collection object is created.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The value does not change. If the configured value has never been modified, this option will be *NO.
</dd>
<dt><b>*YES</b></dt>
<dd>The CRTPFRDTA job is submitted.
</dd>
<dt><b>*NO</b></dt>
<dd>The CRTPFRDTA job is not submitted.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGPFRCOL.CHGPMLIB"></a>
<h3>Change PM iSeries library (CHGPMLIB)</h3>
<p>This option will change the PM iSeries library to match the library used by Collection Services.
</p>
<p>PM iSeries has its own configuration. When PM iSeries is running it will change the Collection Services configuration (on an hourly basis) so that the data it requires is collected and stored in the PM iSeries configured library. If you specify *YES, the PM iSeries collection library will be changed to the Collection Services collection library. If the Collection Services server job is running when this option is specified, the collection will be cycled so that the change to both libraries will take effect simultaneously.
</p>
<p>If the PM iSeries library is changed, you should be aware of the following: PM iSeries will not be able to process any data which was collected in the previous library. In addition, PM iSeries will automatically remove data in the new library based on the PM iSeries setting Performance data purge days. To change the number of days performance data is retained, type GO PM iSeries and select the Work with PM iSeries Customization option.
</p>
<dl>
<dt><b><u>*NO </u></b></dt>
<dd>The PM iSeries library name will not be changed.
</dd>
<dt><b>*YES</b></dt>
<dd>The PM iSeries library name will be changed to match the library used by Collection Services.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CFGPFRCOL.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Configuring Default Interval and Collection Library</b>
</p>
<p>
<pre>
CFGPFRCOL INTERVAL(5) LIB(QMPGDATA)
</pre>
</p>
<p>This command will cause the default interval at which most sample data is collected to be changed immediately to 5 minutes. In addition, the library where data is collected will change to QMPGDATA the next time a management collection object (*MGTCOL) is created.
</p>
<p><b>Example 2: Configuring Cycle Time and Cycle Interval</b>
</p>
<p>
<pre>
CFGPFRCOL CYCTIME(030000) CYCITV(6)
</pre>
</p>
<p>This command will change the cycle time and cycle interval of the collection. The base cycle time will be 3:00 a.m. and the collection will cycle every six hours from the base time. New management collection objects (*MGTCOL) will be created at the following times: 3:00, 9:00, 15:00, 21:00, 3:00, 9:00, and so on.
</p>
<p><b>Example 3: Configuring Retention Period</b>
</p>
<p>
<pre>
CFGPFRCOL RETPERIOD(25 *DAYS)
</pre>
</p>
<p>This command will cause the current and future collection objects to be retained on the system for 25 days before being automatically deleted by the Collection Services server job (QYPSPFRCOL).
</p>
<p><b>Example 4: Configuring Default Collection Profile and Create Database Files</b>
</p>
<p>
<pre>
CFGPFRCOL DFTCOLPRF(*STANDARD) CRTDBF(*YES)
</pre>
</p>
<p>This command causes changes that will take effect the next time a management collection object (*MGTCOL) is created. At that time, the collection profile will change to *STANDARD and the Create Performance Data (CRTPFRDTA) job will be submitted.
</p>
<p><b>Example 5: Changing the PM iSeries Library</b>
</p>
<p>
<pre>
CFGPFRCOL LIB(QPFRDATA) CHGPMLIB(*YES)
</pre>
</p>
<p>This command will change both the Collection Services collection library and the PM iSeries configured library to QPFRDATA. If the Collection Services server job is running, it will be cycled and the change will take effect immediately.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CFGPFRCOL.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3CF2</b></dt>
<dd>Error(s) occurred during running of &amp;1 API.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGPFRCOL.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>