Configure Perf Collection (CFGPFRCOL)

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

The Configure Performance Collection (CFGPFRCOL) command changes certain collection attributes and determines 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.

Top

Parameters

Keyword Description Choices Notes
INTERVAL Default interval *SAME, 0.25, 0.5, 1.0, 5.0, 15.0, 30.0, 60.0 Optional, Positional 1
LIB Collection library Name, *SAME Optional
DFTCOLPRF Default collection profile *SAME, *MINIMUM, *STANDARD, *STANDARDP, *ENHCPCPLN, *CUSTOM Optional
CYCTIME Cycle time Time, *SAME Optional
CYCITV Cycle interval 1-24, *SAME Optional
RETPERIOD Collection retention period Single values: *SAME, *PERM
Other values: Element list
Optional
Element 1: Number of units 1-720
Element 2: Unit of time *HOURS, *DAYS
CRTDBF Create database files *SAME, *YES, *NO Optional
CRTPFRSUM Create performance summary *SAME, *YES, *NO Optional
CHGPMLIB Change PM Agent library *SAME, *YES, *NO Optional
STDDTARET Standard data retention (days) Integer, *SAME, *PERM Optional
Top

Default interval (INTERVAL)

Specifies the default collection interval (in minutes). This value is used by most data categories as the collection sample interval. When a category has a minimum or maximum interval size associated with it and it also uses the default collection interval, the default interval will be used as long as it does not conflict with those other settings. When there is a conflict, the minimum or maximum will be used. For example the maximum interval size is five minutes for *DISK, *IOPBASE, and *IPCS. If the default collection interval is set to a value larger than five minutes, the category will still collect at five minute intervals. This change will take effect immediately.

*SAME
The value does not change. If the value has never been modified, the interval will be 15 minutes.
0.25
The default collection interval will be 15 seconds.
0.5
The default collection interval will be 30 seconds.
1.0
The default collection interval will be 1 minute.
5.0
The default collection interval will be 5 minutes.
15.0
The default collection interval will be 15 minutes.
30.0
The default collection interval will be 30 minutes.
60.0
The default collection interval will be 60 minutes.
Top

Collection library (LIB)

Specifies the library where the management collection object (*MGTCOL) will reside. This change will take effect the next time a collection object is created. If you change the collection library, you should be aware of the folowing: PM Agent and collection services use the same collection library. PM Agent will not be able to process any data which was collected in the previous library. In addition collections will automatically be removed from the new library based on the standard collection file retention period you have specified.

*SAME
The value does not change. If the value has never been modified, the library will be QPFRDATA.
name
Specify the name of the library where the management collection object should be created.
Top

Default collection profile (DFTCOLPRF)

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.

*SAME
The value does not change. If the value has never been modified, the default collection profile will be *STANDARDP.
*MINIMUM
The minimum data collection recommended. Includes the following categories: *SYSBUS, *POOL, *HDWCFG, *SYSCPU, *SYSLVL, *JOBMI, *JOBOS, *DISK, and *IOPBASE.
*STANDARD
The standard profile includes all categories which are typically needed by the IBM Performance Tools for i, 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, *LPAR, *EXTSTG, *SYSINT and *RMVSTG. The category *DOMINO will be included if the product IBM Domino for i has been installed on the system. The category *HTTP will be included if the product IBM HTTP Server for i (powered by Apache) has been installed on the system.
*STANDARDP
The standard plus profile includes all categories which are typically needed by the IBM Performance Tools for i, including communications data. It includes all categories in the *STANDARD profile, as well as the following categories: *IPCS, *CMNBASE, *CMNSTN, *CMNSAP, *TCPIFC, and *DPS.
*ENHCPCPLN
The enhanced capacity planner profile includes all categories in the *STANDARDP profile, with the addition *INTPEX.
*CUSTOM
The custom profile includes categories as defined by the user. This profile must be defined using the Configure Collection Services task within the IBM Systems Director Navigator for i.
Top

Cycle time (CYCTIME)

Specifies 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.

*SAME
The value does not change. If the value has never been modified, the cycle time will be midnight.
time
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.
Top

Cycle interval (CYCITV)

Specifies 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.

*SAME
The value does not change. If the value has never been modified, the cycle interval will be 24 hours.
1-24
Specify the number of hours after which the collection will be cycled.
Top

Collection retention period (RETPERIOD)

Specifies how long the management collection objects (*MGTCOL) should be retained on the system. The retention period is used to calculate an expiration date and time that is stored in the collection object. 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. Collection objects will be automatically deleted only when they exist in the system's configured collection library. This change will take effect immediately and will apply to the current and future collection objects.

Single values

*SAME
The value does not change. If the value has never been modified, the retention period will be 24 hours.
*PERM
The object will not be automatically deleted.

Element 1: Number of units

retention-time
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.

Element 2: Unit of time

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.

*HOURS
The retention period is specified in hours. The valid time period range is 1 through 720.
*DAYS
The retention period is specified in days. The valid time period range is 1 through 30.
Top

Create database files (CRTDBF)

Specifies whether or not to 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.

*SAME
The value does not change. If the value has never been modified, this option will be *YES.
*YES
The CRTPFRDTA job is submitted.
*NO
The CRTPFRDTA job is not submitted.
Top

Create performance summary (CRTPFRSUM)

Specifies whether or not to create additional performance database summary data as supported by the CRTPFRSUM command. This data facilitates quicker processing of the performance database data by tools such as the Performance Viewer. If this option is enabled, and CRTDBF(*YES) was specified, the CRTPFRSUM function will be performed for the database collection created by the CRTPFRDTA job

*SAME
The value does not change. If the value has never been modified, this option will be *NO.
*YES
Summary file data is generated.
*NO
Summary file data is not generated.
Top

Change PM Agent library (CHGPMLIB)

Specifies whether or not to change the PM Agent library to match the library used by Collection Services.

This parameter is no longer supported. It exists solely for compatibility with the releases earlier than Version 5 Release 5 Modification 0 of the operating system.

Top

Standard data retention (days) (STDDTARET)

Specifies the retention period for standard file data. Standard file data is that data normally collected for a collection profile on an ongoing basis that has been exported to performance data base files (QAPM*). The standard file data retention period is used to determine how long performance database file collections should be retained on the system. When standard data in the configured collection library is older than the current retention period, it will be automatically deleted by the Collection Services server job (QYPSPFRCOL) the next time the collector is started or cycled. The retention period is specified in days.

*SAME
The value does not change.
*PERM
The performance database file data is not automatically deleted.
retention-time
The number of days database file data is retained before it becomes eligible to be deleted.
Top

Examples

Example 1: Configuring Default Interval and Collection Library

CFGPFRCOL INTERVAL(5) LIB(QMPGDATA)

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.

Example 2: Configuring Cycle Time and Cycle Interval

CFGPFRCOL CYCTIME(030000) CYCITV(6)

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.

Example 3: Configuring Retention Period

CFGPFRCOL RETPERIOD(25 *DAYS)

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).

Example 4: Configuring Default Collection Profile and Create Database Files

CFGPFRCOL DFTCOLPRF(*STANDARD) CRTDBF(*YES)

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.

Top

Error messages

*ESCAPE Messages

CPF3CF2
Error(s) occurred during running of &1 API.
CPF9810
Library &1 not found.
CPF9820
Not authorized to use library &1.
Top