Retrieve System Collector Attributes (QYPSRSCA, QypsRtvSysCollectorAttributes) API
Required Parameter Group:
| 1 | Collector name | Input | Char(10) |
| 2 | Default collection interval | Output | Binary(4) |
| 3 | Library | Output | Char(10) |
| 4 | Retention period | Output | Binary(4) |
| 5 | Cycle time | Output | Binary(4) |
| 6 | Cycle interval | Output | Binary(4) |
| 7 | Companion user job | Output | Binary(4) |
| 8 | Default collector definition | Output | Char(10) |
| 9 | Current collector definition | Output | Char(10) |
| 10 | Error code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Service program: QYPSCOLL
Threadsafe: No
The Retrieve System Collector Attributes (QYPSRSCA, QypsRtvSysCollectorAttributes) API retrieves system or global collection attributes for collection services. Attributes consist of the default collector state, the default collection interval, the library used to store the collection data, the retention period for the data, the time the initial cycle is to occur, the interval between cycles, the companion user job flag, the default collection definition, and the currently running collection definition.
Authorities and Locks
- API Public Authority
- *EXCLUDE
Required Parameter Group
- Collector name
- INPUT; CHAR(10)
The name of the collector whose default values are to be retrieved. The special value is:
*PFR Performance collector
- Default collection interval
- OUTPUT; BINARY(4)
The default interval used when collecting data for a category in seconds. The interval is 15, 30, 60, 300, 900, 1800, or 3600 seconds. The following special value may be returned:
0 Do not collect on interval.
- Library
- OUTPUT; CHAR(10)
The name of the library used to store the collection data.
- Retention period
- OUTPUT; BINARY(4)
The retention period indicates how long collection data is to exist. Collection data older than the retention period is deleted.
Collection Services stores this data in Management Collection (*MGTCOL) Objects with the *PFR attribute. This retention period is used to calculate an expiration date for the object. Expired objects will be automatically deleted by the Collection Services server job (QYPSPFRCOL) the next time a collection is started or cycled. Collection objects are deleted only when they exist in the system's configured collection library.
The retention period is specified in hours. The following special value may be returned:
0 Permanent
- Cycle time
- OUTPUT; BINARY(4)
The time at which the first cycle is to occur. The cycle time is specified in minutes past midnight. The maximum allowed value is 1439 minutes, which is one minute less than 24 hours.
- Cycle interval
- OUTPUT; BINARY(4)
The lapse time between cycles. The cycle time is specified in hours, and can range from a minimum value of one hour to a maximum value of 24 hours.
- Companion user job flag
- OUTPUT; BINARY(4)
Whether a job is started to run in concert with the collector. One of the following values will be returned:
0 No companion user job is started. 1 A companion user job is started. (For the *PFR collector, this is the CRTPFRDTA job which creates the standard performance database collection from the current *MGTCOL collection.)
- Default collector definition
- OUTPUT; CHAR(10)
The name of the collector definition to run. The possible special values are:
*CURRENT
*CUSTOM
*ENHCPCPLN
*MINIMUM
*STANDARD
*STANDARDP - Current collector definition
- OUTPUT; CHAR(10)
The name of the currently running collector definition. The possible special values are:
*CUSTOM
*ENHCPCPLN
*MINIMUM
*NONE
*STANDARD
*STANDARDP - Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C3C E | Value for parameter &1 is not valid. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3CF2 E | Errors occurred during running of &1 API. |
API introduced: V4R4
[ Back to top | Performance Management APIs | APIs by category ]