Collector APIs

The collector APIs provide services to manage collections. These APIs:

Start, end, and cycle collections
Change and retrieve system parameters for the data collected
Register and deregister a user-defined data category
Add and remove collector notification

The collector APIs include:

Add Collector Notification (QypsAddCollectorNotification) registers with a collector to provide notifications to a specified data queue for a collection event.
Change Collection Services Attributes (QypsChgColSrvAttributes) changes system or global collection attributes. It is a replacement for and extension of the Change System Collector Attributes (QYPSCSCA, QypsChgSysCollectorAttributes) API.
Change System Collector Attributes (QYPSCSCA, QypsChgSysCollectorAttributes) changes system collection attributes. System attributes provide the default values for each collector. These include the collection interval in seconds, the library where the data is to be stored, the retention period for data, the cycle time, the cycle interval, the companion job flag, and the name of the default collection definition.
Cycle Collector (QYPSCYCC, QypsCycleCollector) closes current collection objects and opens new collection objects.
Deregister Collector Data Category (QypsDeregCollectorDataCategory) removes a user-defined data category from the Collection Services function of Management Central.
End Collector (QYPSENDC, QypsEndCollector) ends a specified collector.
Register Collector Data Category (QypsRegCollectorDataCategory) adds a user-defined data category to one or more collector definitions of the Collection Services function of Management Central.
Remove Collector Notification (QypsRmvCollectorNotification) removes a notification registration from a collector.
Retrieve Collection Services Attributes (QypsRtvColSrvAttributes) retrieves system or global collection attributes. It is a replacement for and extension of the Retrieve System Collector Attributes (QYPSRSCA, QypsRtvSysCollectorAttributes) API.
Retrieve System Collector Attributes (QYPSRSCA, QypsRtvSysCollectorAttributes) retrieves system collection attributes. These include the collection interval in seconds, the library where the data is to be stored, the retention period for data, the cycle time, the cycle interval, the companion job flag, the name of the default collection definition, and the currently running collection definition, if any.
Start Collector (QYPSSTRC, QypsStartCollector) starts a specified collector.

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