z/OS Management Instrumentation for CIM

The CIM standard provides the ability to develop management applications that work with systems management data. To work with CIM, developers should have a thorough understanding of the CIM standard defined by the DMTF. For more information about the CIM standard, see Common Information Model (CIM) Standards on the DMTF website.

IBM® has developed providers for z/OS that support basic operating system information and some performance metrics. A CIM provider is the link between the CIM server and the system (see Figure 2). This interface allows CIM to access and manage the resources. Each CIM provider makes accessible the resources it represents in a standard way.

Notes:

IBM only supports the classes and properties listed in the present document or in other z/OS® documentation provided by IBM. All other classes or properties which are not documented by IBM, IBM does not support, and bears no responsibility for their use.
Not all properties of the supported CIM classes described in this document are implemented by z/OS. Those properties implemented by z/OS are documented in each of the following subtopics. For all CIM properties not implemented by z/OS, the CIM server returns no values.

The following CIM classes and associations are implemented as IBM-supplied providers to provide basic operating system information:

Base classes

(See OS management Base classes)

IBMzOS_ComputerSystem: subclass of CIM_ComputerSystem
IBMzOS_OperatingSystem: subclass of CIM_OperatingSystem
IBMzOS_OSProcess: subclass of association CIM_OSProcess
IBMzOS_Process: subclass of CIM_Process
IBMzOS_RunningOS: subclass of association CIM_RunningOS
IBMzOS_UnixProcess: subclass of CIM_UnixProcess
IBMzOS_LogicalDisk: subclass of CIM_LogicalDisk
IBMzOS_LogicalDiskDevice: subclass of association CIM_SystemDevice

BaseBoard classes

(See OS management BaseBoard classes)

IBM_BaseBoard: subclass of CIM_Card
IBMzOS_BaseBoard: subclass of IBM_BaseBoard

Processor classes

(See OS management Processor classes)

IBMzOS_CSProcessor: subclass of association CIM_SystemDevice
IBMzOS_Processor: subclass of CIM_Processor

File System classes

(See OS management File System classes)

IBMzOS_HostedFileSystem: subclass of association CIM_HostedFileSystem
IBMzOS_NFS: subclass of CIM_NFS
IBMzOS_UnixLocalFileSystem: subclass of CIM_UnixLocalFileSystem

Network classes

(See OS management Network classes)

IBMzOS_EthernetPort: subclass of CIM_EthernetPort
IBMzOS_CSNetworkPort: subclass of association CIM_SystemDevice
IBMzOS_IPProtocolEndpoint: subclass of CIM_IPProtocolEndpoint
IBMzOS_NetworkPortImplementsIPEndpoint: subclass of association CIM_PortImplementsEndpoint

Job classes

(See OS management Job classes)

IBMzOS_Job: subclass of CIM_Job
IBMzOS_JES2Job: subclass of IBMzOS_Job
IBMzOS_JES3Job: subclass of IBMzOS_Job
IBMzOS_SysoutDataset: subclass of CIM_LogicalFile
IBMzOS_JES2SysoutDataset: subclass of IBMzOS_SysoutDataset
IBMzOS_JES3SysoutDataset: subclass of IBMzOS_SysoutDataset
IBMzOS_Subsystem: subclass of CIM_Service
IBMzOS_JobsManagementSettings: subclass of CIM_SettingData
association IBMzOS_SubsystemJES2Jobs (between IBMzOS_Subsystem and IBMzOS_JES2Job)
association IBMzOS_SubsystemJES3Jobs (between IBMzOS_Subsystem and IBMzOS_JES3Job)
association IBMzOS_UsesJES3SysoutDatasets (between IBMzOS_JES3Job and IBMzOS_JES3SysoutDataset)
association IBMzOS_UsesJES2SysoutDatasets (between IBMzOS_JES2Job and IBMzOS_JES2SysoutDataset)

Cluster classes

(See OS management Cluster classes)

IBMzOS_Sysplex: subclass of IBMzOS_Cluster
IBMzOS_SysplexNode: subclass of IBMzOS_ClusterNode
IBMzOS_CouplingFacility: subclass of IBMzOS_ClusterAggregatedResource
IBMzOS_CFStructure: subclass of IBMzOS_ClusterAggregatedResource
IBMzOS_CFStructureConnector: subclass of IBMzOS_ClusterResource
IBMzOS_ClusterResource
IBMzOS_ClusterGlobalResource
IBMzOS_ClusterAggregatedResource
IBMzOS_Cluster
IBMzOS_ClusterNode
IBMzOS_CoupleDataset: subclass of CIM_LogicalFile
IBMzOS_SysplexCoupleDataset: subclass of IBMzOS_CoupleDataset
IBMzOS_CFRMCoupleDataset: subclass of IBMzOS_CoupleDataset
IBMzOS_CouplingFunction: subclass of IBMzOS_ClusterAggregatedResource
IBMzOS_CFRMPolicy: subclass of IBMzOS_ClusterAggregatedResource
association IBMzOS_CollectionOfSysplexNodes
association IBMzOS_CollectionOfCFs
association IBMzOS_HostedCFStructure
association IBMzOS_HostedCFStrConnector
association IBMzOS_CFStructureDependsOn
association IBMzOS_UsesCFs
association IBMzOS_UsesCouplingFunctions
association IBMzOS_UsesSysplexCoupleDatasets
association IBMzOS_UsesCFRMCoupleDatasets
association IBMzOS_UsesCFRMPolicies

Cluster indications

IBMzOS_SysplexInstCreation
IBMzOS_SysplexInstModification
IBMzOS_Sysplex_ReallocateInitiated
IBMzOS_Sysplex_ReallocateCompleted
IBMzOS_Sysplex_CFRM_CDS_Initialized
IBMzOS_SysplexNodeInstCreation
IBMzOS_SysplexNodeInstDeletion
IBMzOS_SysplexNodeInstModification
IBMzOS_CouplingFacilityInstCreation
IBMzOS_CouplingFacilityInstDeletion
IBMzOS_CouplingFacilityInstModification
IBMzOS_CFStructureInstCreation
IBMzOS_CFStructureInstDeletion
IBMzOS_CFStructureInstModification
IBMzOS_CFStrConnectorInstCreation
IBMzOS_CFStrConnectorInstDeletion
IBMzOS_CFStrConnectorInstModification
IBMzOS_CollectionOfSysplexNodesInstCreation
IBMzOS_CollectionOfSysplexNodesInstDeletion
IBMzOS_CollectionOfCFsInstCreation
IBMzOS_CollectionOfCFsInstDeletion
IBMzOS_HostedCFStructureInstCreation
IBMzOS_HostedCFStructureInstDeletion
IBMzOS_HostedCFStrConnectorInstCreation
IBMzOS_HostedCFStrConnectorInstDeletion
IBMzOS_UsesCFInstCreation: subclass of CIM_InstCreation
IBMzOS_UsesCFInstDeletion: subclass of CIM_InstDeletion

Storage management classes

(See Storage management classes)

CIM_StorageExtent
IBMzOS_FCCUPort
IBMzOS_FCPort
IBMzOS_FCPortStatistics
IBMzOS_FCSBPort
IBMzOS_PortController
IBMzOS_Product
IBMzOS_SBProtocolEndpoint
IBMzOS_SoftwareIdentity
association IBMzOS_ControlledBy
association IBMzOS_CSFCPort
association IBMzOS_CSFCPortController
association IBMzOS_ElementSoftwareIdentity
association IBMzOS_FCPortStatisticalData
association IBMzOS_InstalledSoftwareIdentity
association IBMzOS_ProductElementComponent
association IBMzOS_SBDeviceSAPImplementation
association IBMzOS_SBHostedAccessPoint
association IBMzOS_SBInitiatorTargetLogicalUnitPath

Storage management indications

For CIM_PortController:

CIM_InstCreation
CIM_InstDeletion

For CIM_InitiatorTargetLogicalUnitPath:

CIM_InstCreation
CIM_InstDeletion
CIM_InstModification

WLM classes

(See WLM classes)

IBMzOS_WLM
association IBMzOS_WLMOS (between IBMzOS_WLM and IBMzOS_ComputerSystem)

WLM indications

IBMzOS_WLMPolicyActivationIndication

CIM classes implemented by RMF™

Please note that for using the CIM providers implemented by RMF you need to have RMF installed and additional configuration is required (see Setting up the CIM server for RMF monitoring). For more information, see z/OS RMF Programmer's Guide and z/OS RMF Users Guide.

IBMzOS_BaseMetricValue
IBMzOS_BaseMetricDefinition
IBMzOS_MetricForME
IBMzOS_MetricDefForME
IBMzOS_MetricInstance
IBMzOS_Channel
IBMz_CEC
IBMz_ComputerSystem
IBMzOS_WLMServiceDefinition
IBMzOS_WLMServiceClassPeriod

To exploit this functionality, RMF must be installed and running.

Notes:

The z/OS Communications Server provides documentation of these CIM classes. For details refer to Considerations for Common Information Model (CIM) providers in z/OS Communications Server: IP Configuration Guide.
For all classes, the properties that are common for eServer™ and the z/OS specific properties are documented in separate tables.
Starting with z/OS 1.9, the CIM server exploits the functionality of Common event adapter (CEA). CEA is a z/OS component that provides the ability to deliver z/OS events to C-language clients. A CEA address space is started automatically during initialization of every z/OS system. In order for the address space to start successfully, you must configure CEA to work with z/OS. Failure to do so will cause CEA to run in a minimum function mode. For details refer to z/OS Planning for Installation.
An extra security setup is needed for the Job and Cluster classes.

The graphics showing class structures illustrate the CIM object modeling using the UML syntax:

Table 7. Legend for graphics showing class structures

Construct

Description

Syntax

association

A relationship between two or more classifiers that involves connections among their instances.

aggregation

A special form of association that specifies a whole-part relationship between the aggregate (whole) and the component part.

inheritance

A relationship among classes where one class shares the structure and/or behavior defined for one or more other classes. Inheritance is the mechanism that makes generalization, subclasses, and superclasses possible.

class

Denotes the representation of a CIM class in UML notation with title, properties, and methods.