Start Collector (QYPSSTRC, QypsStartCollector) API

Required Parameter Group:

1	Collector name	Input	Char(10)
2	Default collector definition	Input	Char(10)
3	Error code	I/O	Char(*)

  Default Public Authority: *EXCLUDE

  Service program: QYPSCOLL

  Threadsafe: No

The Start Collector (QYPSSTRC, QypsStartCollector) API starts a collector. When the collector job is not running, the job is submitted to the QSYSNOMAX job queue and a start request passes to it. If no default collection definition is provided, the default provided by the system value is used. When the collector job is running and a new default collection definition is provided, the collector changes to use that definition. If the collector job is running and no new default collector definition is provided, no action is taken.

Authorities and Locks

API Public Authority: *EXCLUDE
Job Authority: *JOBCTL

Required Parameter Group

Collector name

INPUT; CHAR(10)

The name of the collector to start. The special value is:

*PFR	Performance collector job QYPSPFRCOL

Default collector definition

OUTPUT; CHAR(10)

The name of the collector definition to run. The possible special values are:

*CURRENT
*CUSTOM
*ENHCPCPLN
*MINIMUM
*SAME
*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
CPF222E E	&1 special authority is required.
CPF3C1E E	Required parameter &1 omitted.
CPF3C3C E	Value for parameter &1 is not valid.
CPF3C36 E	Number of parameters, &1, entered for this API was not valid.
CPF3CF2 E	Errors occurred during running of &1 API.
CPFB94A E	Collector communications error. Reason code &1.

API introduced: V4R4

[ Back to top | Performance Management APIs | APIs by category ]