z/OS Common Information Model User's Guide
Previous topic | Next topic | Contents | Index | Contact z/OS | Library | PDF


IBMzOS_CouplingFacility

z/OS Common Information Model User's Guide
SC34-2671-00

IBMzOS_CouplingFacility

Purpose

This class represents a zSeries® Coupling Facility, which is the system that manages a Sysplex (System Complex).

Module name

The module name of the CMPI provider that is registered for a CIM class which is used by the cimprovider command line tool for the administration of CMPI providers is

  • IBMzOS_CouplingFacilityProviderModule

Provider library

The physical name of a CMPI provider’s shared object library as it is stored in the hierarchical file system is

  • libcmpiIBMzOS_CouplingFacilityProvider.so

Properties

string Caption
A short description of the class. Returns ‘IBM z/OS® Coupling Facility’.
string Description
A description of the class. Returns This is an IBM® z/OS Coupling Facility.
string ElementName
Name given to this instance of the class (same as Name)
datetime InstallDate
A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.
string Name
Coupling Facility Logical Name as assigned by CFRM policy definitions.

Note: CF Name is not considered an immutable property of a Coupling Facility, since the name can be changed via a CFRM policy update. The physical CF information is the immutable identification information.

uint16 OperationalStatus [ ]
The current status of the CF (summarized from more granular CF state information):
0
Unknown
2
OK
6
Error
9
Stopping
string StatusDescriptions [ ]
Strings describing the various Operational Status values.
string Status
A string indicating the current status
uint16 EnabledState
Indicates the Enabled or Disabled state.
string OtherEnabledState
String describing the Enabled State value
uint16 RequestedState
The last requested State
uint16 EnabledDefault
Indicates the default value for Enabled State
datetime TimeOfLastStateChange
The date and time Enabled State was last changed.
uint64 IdentityToken [key]
The generated identity value for sysplex cluster. (Part 1 of 2)
string IdentityName [key]
The generated identity value for sysplex cluster. (Part 2 of 2)
string MachineType
Machine type of the server hosting the CF
string Manufacturer
Name of the manufacturer of the server hosting the CF
string ManufacturerPlant
The plant number where the machine was manufactured
string SerialNumber
A manufacturer assigned number to identify the server hosting the CF
uint8 LPARid
Platform-assigned ID of a logical partition in which the CF is running. Null if the Computer System is not virtualized
uint32 CFLevel
Facility operational (functionality) level
uint32 State
CF Operational State (summarized from more granular CF state information):
1
Okay
2
Unknown
6
Error
9
Stopping
uint16 NumberOfProcessors
Total number of CF processors
uint16 CPUUtilization
Percent CF processor utilization
uint32 FreeSpace
Currently unused storage available in the CF (in number of 4KB blocks)
uint32 TotalSpace
Total storage available in the CF (in number of 4KB blocks)
uint32 FreeDumpSpace
Currently unused allocated dump storage available in the CF (in number of 4KB blocks)
uint32 TotalDumpSpace
Total allocated dump storage available in the CF (in number of 4KB blocks)
uint32 StorageIncrementSize
Storage increment. The number of 4K blocks in a single storage increment in this CF.
boolean Standalone
Coupling Facility Standalone indicator:
TRUE
Not Standalone
FALSE
Standalone
boolean Volatile
Indicator of whether this CF is volatile or nonvolatile (based on battery backup or standby power source)
boolean CPUType
Indicates whether all of the CF processors are shared, or whether at least one is dedicated:
TRUE
All shared
FALSE
Some are dedicated
boolean MaintenanceMode
Indicates whether the CF is currently in Maintenance mode:
TRUE
Not in Maintenance mode
FALSE
CF is in Maintenance mode
boolean RecoveryMgrSite
TRUE
Recovery Manager is not active or the CF does not reside at the recovery site
FALSE
Recover Manager is active and the CF resides at the recovery site.
string SiteName
Name of the SITE specified in the CFRM policy.
string CPCID
Coupling Facility's Central Processor Complex (CPC) ID.
string CFCCReleaseLevel
The release level of the CFCC code.
string CFCCServiceLevel
The service level of the CFCC code.
datetime CFCCCodeBuildDate
The date and time that the CFCC code was built.

Methods

uint32 StartCFMaintenanceMode()
Sets the maintenance mode of the specified coupling facility to ON.

When a CF is in maintenance mode, the CF is not eligible for CF structure allocation purposes and all structure allocation processes will modify their CF selection processing accordingly.

uint32 StopCFMaintenanceMode()
Sets the maintenance mode of the specified coupling facility to OFF.

When a CF is no longer in maintenance mode, the CF is eligible for CF structure allocation purposes.

Associations

IBMzOS_HostedCFStructure
Source
IBMzOS_CFStructure
Target
IBMzOS_CouplingFacility
see
Association IBMzOS_HostedCFStructure
IBMzOS_UsesCFs
Source
IBMzOS_SysplexNode
Target
IBMzOS_CouplingFacility
see
Association IBMzOS_UsesCFs

Indications

IBMzOS_CouplingFacilityInstCreation
A 'life cycle' indication that indicates that an instance of the IBMzOS_CouplingFacility class has been created.
IBMzOS_CouplingFacilityInstDeletion
A 'life cycle' indication that indicates that an instance of the IBMzOS_CouplingFacility class has been deleted.
IBMzOS _CouplingFacilityInstModification
A 'life cycle' indication that indicates that an instance of the IBMzOS_CouplingFacility class has been modified.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014