Management Central APIs
The Management Central APIs provide services to manage collections. These
APIs start, end, and cycle collections, and change and retrieve system
parameters for the data collected.
Terminology
The following terms are used in the Management Central APIs:
Collection. Data obtained by a collector that represents the system status at a given point in time. Collections are timestamped and stored in a management collection object.
Collector. A generic name for a program that at regular intervals collects data about a system's status.
Cycle. The end of the management collection object currently in use and the opening of a new object for storing future collections. This process prevents collection objects from becoming too large.
Management collection. An object within the OS/400 operating system that includes the data for a number of collections, beginning when the collector was started and continuing until the the collector was either ended or cycled. The system-recognized identifier for the object type is *MGTCOL.
The Management Central APIs and their functions are:
-
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.
-
End Collector (QYPSENDC, QypsEndCollector) ends
a specified collector.
-
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.