This class represents a zSeries® Coupling Facility Structure.

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_CFStructureProviderModule

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

• libcmpiIBMzOS_CFStructureProvider.so

string Caption

A short description of the class.

string Description

A description of the class.

string ElementName

Name given to this instance of the class.

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

The Name of the structure as defined in the CFRM policy.

uint16 OperationalStatus [ ]

The current status of the CF Structure:

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)

uint32 State

CF structure operational state:

1

Okay

2

Unknown

3

Error

4

Stopping

uint32 SubState

CF structure substate:

1

Normal (no exceptional conditions.

2

Temporarily degraded (alter in progress, structure dump serialization held).

3

Permanently degraded (allocated smaller than desired size, pending CFRM policy change).

4

Recovering (Valid only when the value of 'State' is 1 (Okay) or 4 (Stopping) ).

uint8 Type

Structure type based on exploiter allocation requirements:

0x03

List

0xFF

Lock

0x04

Cache

0xFE

Serialized List

boolean AllowAlter

Indicator of whether this structure can be dynamically altered, based on current conditions. All active connectors to the structure specified ALLOWAUTO = YES on the IXLCONN connect request.

boolean AllowAuto

All active connectors to the structure specified ALLOWREBLD = YES on the IXLCONN connect request.

boolean AllowRebuild

All active connectors to the structure specified ALLOWDUPREBLD = YES on the IXLCONN connect request.

boolean AllowDupRebuild

All active connectors to the structure specified ALLOWALTER = YES on the IXLCONN connect request.

boolean IsDuplexed

Indicator of whether this structure actually is duplexed at this time. Only when this property indicates that the structure is duplexed, will the following properties be valid:

• MaximumStructureSize2
• InitialStructureSize2
• MinimumStructureSize2
• OverFullThreshold2
• StructureVersion2
• CFName2
• CurrentStructureSize2

boolean PendPolicyChange

Indicates that there is a change pending in structure policy.

boolean Disposition

Defines whether the structure is persistent when there are no longer any defined connections (active or failed):

FALSE

Keep

TRUE

Delete

string CFName1

The name of the Coupling Facility in which this structure instance has been allocated.

It is possible to have two structure instances due to rebuild-in-progress or duplexing.

It is possible to have no structure instances when the structure is not currently allocated.

When Duplexed this is the ‘Old’ instance of the structure.

string CFName2

The name of the Coupling Facility in which the 'New' structure instance has been allocated. Null if not allocated.

This property is only valid when Duplexed.

string StructureVersion1

Structure version number for the currently allocated instance of the structure.

It is possible to have two structure instances due to rebuild-in-progress or duplexing. It is possible to have no structure instances when the structure is not currently allocated.

When Duplexed this is the 'Old' instance of the structure.

string StructureVersion2

Structure version number for the 'New' instance of the structure, when the structure is in the process of rebuilding or has been duplexed.

This property is only valid when Duplexed.

uint32 MaximumStructureSize1

The maximum size to which this instance of the structure can be expanded, in units of 4KB.

When Duplexed this is the 'Old' instance of the structure.

uint32 MaximumStructureSize2

The maximum size to which the 'New' instance of the structure can be expanded, in units of 4KB.

This property is only valid when Duplexed.

uint32 InitialStructureSize1

The requested initial structure allocation size, in units of 4KB, for this instance of the structure.

When Duplexed this is the 'Old' instance of the structure.

uint32 InitialStructureSize2

The requested initial structure allocation size, in units of 4KB, for the 'New' instance of the structure.

This property is only valid when Duplexed.

uint32 MinimumStructureSize1

The minimum size at which this instance of the structure can be allocated or contracted to, in units of 4KB.

When Duplexed this is the 'Old' instance of the structure.

uint32 MinimumStructureSize2

The minimum size at which the 'New' instance of the structure can be allocated or contracted to, in units of 4KB.

This property is only valid when Duplexed.

uint32 CurrentStructureSize1

The allocated structure size, in units of 4 KB, for this instance of the structure. Not provided if the structure is not allocated.

When Duplexed this is the 'Old' instance of the structure.

uint32 CurrentStructureSize2

The allocated structure size, in units of 4 KB, for the 'New" instance of the structure. Not provided if the structure is not allocated.

This property is only valid when Duplexed.

uint32 SysMgdProcessLevel1

System Managed Process Level required by the instance of the structure to participate in a system-managed process.

When Duplexed this is the 'Old' instance of the structure.

uint32 SysMgdProcessLevel2

System Managed Process Level required by the 'New' instance of the structure to participate in a system-managed process.

This property is only valid when Duplexed.

uint32 ElementCount1

Element Count for the structure. List set element count for List structures. Data area element count for Cache Structures. Invalid for Lock Structures.

When Duplexed this is the 'Old' instance of the structure.

uint32 ElementCount2

Element Count for the 'New' structure. List set element count for List structures. Data area element count for Cache Structures. Invalid for Lock Structures.

This property is only valid when Duplexed.

uint32 EntryCount1

Entry Count for the structure. List set entry count for List and Lock Structures. Directory entry count for cache structures.

When Duplexed this is the 'Old' instance of the structure.

uint32 EntryCount2

Entry Count for the 'New' structure. List set entry count for List and Lock Structures. Directory entry count for cache structures.

This property is only valid when Duplexed.

uint32 EMCCount1

Event Monitor Controls count for List Structures. Invalid for Cache structures and Lock structures.

When Duplexed this is the 'Old' instance of the structure.

uint32 EMCCount2

Event Monitor Controls count for 'New' List Structures. Invalid for Cache structures and Lock structures.

This property is only valid when Duplexed.

uint32 LockCount1

Lock Entry Count. Valid for serialized List and Lock Structures. Invalid for Cache Structures and unserialized List structures.

When Duplexed this is the 'Old' instance of the structure.

uint32 LockCount2

Lock Entry Count. Valid for 'New' serialized List and Lock Structures. Invalid for Cache Structures and unserialized List structures.

This property is only valid when Duplexed.

string LogicalVersion1

Logical Version numner for the instance of the structure.

When Duplexed this is the 'Old' instance of the structure.

string LogicalVersion2

Logical Version numner for the 'New' instance of the structure.

This property is only valid when Duplexed.

string PreferenceList1 [ ]

Structure Preference List for the instance of the structure. It is an array of up to 8 Coupling Facility names.

When Duplexed this is the 'Old' instance of the structure.

string PreferenceList2 [ ]

Structure Preference List for the instance of the structure. This is an array of up to 8 coupling facility names.

This property is only valid when Duplexed.

string ExclusionList1 [ ]

The Structure Exclusion List for the instance of the structure. This is an array of up to 8 coupling facility names.

When Duplexed this is the 'Old' instance of the structure.

string ExclusionList2 [ ]

Structure Exclusion List for the 'New' instance of the structure. This is an array of up to 8 coupling facility names.

This property is only valid when Duplexed.

uint32 AccessTimeMax1

This instance of the structure was allocated with access time for IXLCONN ACCESSTIME(MAXIMUM).

When Duplexed this is the 'Old' instance of the structure.

uint16 AccessTimeMax2

The 'New' instance of the structure was allocated with access time for IXLCONN ACCESSTIME(MAXIMUM).

This property is only valid when Duplexed.

uint16 MaximumConnections1

The maximum number of connections allowed when the structure was allocated in the coupling facility.

When Duplexed this is the 'Old' version of the structure.

uint16 MaximumConnections2

The maximum number of connections allowed when the 'New' instance of the structure was allocated in the coupling facility.

This property is only valid when Duplexed.

uint8 FullThreshold1

Percentage value for the structure full monitoring threshold for the structure, as defined in CFRM policy. This threshold is set on-platform and is not currently settable through the resource model.

When Duplexed this is the 'Old' version of the structure.

uint8 FullThreshold2

Percentage value for the structure full monitoring threshold for the 'New' version of the structure, as defined in CFRM policy. This threshold is set on-platform and is not currently settable through the resource model.

This property is only valid when Duplexed.

uint8 RebuildPercent1

REBUILDPERCENT for the instance of the structure as specified in CFRM active policy. Not valid indicates not specified.

When Duplexed this is the 'Old' version of the structure.

uint8 RebuildPercent2

REBUILDPERCENT for the 'New' instance of the structure as specified in CFRM active policy. Not valid indicates not specified.

This property is only valid when Duplexed.

uint8 DuplexPolicy1

The effective DUPLEX option for the structure as specified in the CFRM active policy or defaulted.

When Duplexed this is the 'Old' version of the structure.

uint8 DuplexPolicy2

The effective DUPLEX option for the 'New' structure as specified in the CFRM active policy or defaulted.

This property is only valid when Duplexed.

boolean OverFullThreshold1

Indicator of whether or not the instance of the structure is currently in violation of its structure full monitoring threshold.

When Duplexed this is the 'Old' instance of the structure.

boolean OverFullThreshold2

Indicator of whether or not the 'New' instance of the structure is currently in violation of its structure full monitoring threshold.

This property is only valid when Duplexed.

boolean AllowAutoAlter1

ALLOWAUTOALT(YES) was specified in the CFRM active policy for the structure.

When Duplexed this is the 'Old' instance of the structure.

boolean AllowAutoAlter2

ALLOWAUTOALT(YES) was specified in the CFRM active policy for the 'New' structure.

This property is only valid when Duplexed.

boolean EnforceOrder1

ENFORCEORDER(YES) was specified in the CFRM active policy for the structure.

When Duplexed this is the 'Old' instance of the structure.

boolean EnforceOrder2

ENFORCEORDER(YES) was specified in the CFRM active policy for the 'New' structure.

This property is only valid when Duplexed.

boolean AllowReallocate1

ALLOWREALLOCATE(YES) was specified in the CFRM active policy for the structure.

When Duplexed this is the 'Old' instance of the structure.

boolean AllowReallocate2

ALLOWREALLOCATE(YES) was specified in the CFRM active policy for the 'New' structure.

This property is only valid when Duplexed.

boolean AccessTimeNoLimit1

The instance of the structure was allocated with IXLCONN ACCESSTIME(NOLIMIT)

When Duplexed this is the 'Old' instance of the structure.

boolean AccessTimeNoLimit2

The 'New' instance of the structure was allocated with IXLCONN ACCESSTIME(NOLIMIT).

This property is only valid when Duplexed.

uint32 MaxElementCount1

The maximum Element Count for the structure. List set element count for List structures. Data area element count for Cache Structures. Invalid for Lock Structures.

When Duplexed this is the 'Old' instance of the structure.

uint32 MaxElementCount2

The maximum Element Count for the 'New' structure. List set element count for List structures. Data area element count for Cache Structures. Invalid for Lock Structures. This property is only valid when Duplexed.

uint32 MaxEntryCount1

The maximum Entry Count for the structure. List set entry count for List and Lock Structures. Directory entry count for cache structures.

When Duplexed this is the 'Old' instance of the structure

uint32 MaxEntryCount2

The maximum Entry Count for the 'New' structure. List set entry count for List and Lock Structures. Directory entry count for cache structures.

This property is only valid when Duplexed.

uint32 MaxEMCCount1

The maximum Event Monitor Controls count for List Structures. Invalid for Cache structures and Lock structures. When Duplexed this is the 'Old' instance of the structure

uint32 MaxEMCCount2

The maximum Event Monitor Controls count for 'New' List Structures. Invalid for Cache structures and Lock structures. This property is only valid when Duplexed.

uint32 StartRebuild()

Asynchronously rebuilds the structure into the same or a different CF than the one in which it is currently located.

Only works if supported by exploiters. The Location parameter specifies the location where the new structure can be built.

The LessConnAction parameter indicates whether the rebuild should be allowed to continue, in spite of a degradation in connectivity to the new structure.

A rebuild operation should only be requested for structures that are identified as rebuild capable. The rebuild will be performed asynchronously. The return and reason codes will indicate whether the operation was initiated successfully. A property change event will be generated asynchronously when the rebuild has completed.

Coupling Facility Structure operations should only be invoked from a single system in the sysplex.

uint32 StopRebuild()

Stops a Rebuild operation.

A property change event will be generated when the operation has completed.

Coupling Facility Structure Operations should only be invoked from a single system in the sysplex.

uint32 StartDuplex()

Asynchronously establishes duplexing for the specified structure.

Only works if supported by exploiters. The request to start duplexing will be performed asynchronously. The return and reason codes will indicate whether the operation was initiated successfully. A property change event will be generated asynchronously when the duplexing has completed.

Coupling Facility Structure Operations should only be invoked from a single system in the sysplex.

uint32 StopDuplex()

Stops duplexing.

The required Keep parameter indicates which structure is to persist after duplexing has been stopped. The request to stop duplexing will be performed asynchronously. The return and reason codes will indicate whether the operation was initiated successfully. A property change event will be generated asynchronously when operation has completed.

Coupling Facility Structure Operations should only be invoked from a single system in the sysplex.

uint32 Force()

Asynchronously forces the deallocation of a persistent structure.

Force of a structure does not work if there are any active connectors to the structure, and may or may not work if there are failed connectors to the structure. The return and reason codes will indicate whether the operation was initiated successfully. CFStructure property change event or life cycle event will be generated asynchronously when the Force operation has completed.

uint32 ForceAll()

Asynchronously forces the deletion of all failed-persistent connections for this structure.

The return and reason codes will indicate whether the operation was initiated successfully. Connector life cycle events or relationship-related events will be generated asynchronously when the failed persistent connectors are deleted.

IBMzOS_CFStrDependsOn

Source

IBMzOS_CFStructure

Target

IBMzOS_CFStructureConnector

see

Association IBMzOS_CFStrDependsOn

IBMzOS_CFStructureInstCreation

A 'life cycle' indication that indicates that an instance of the IBMzOS_CFStructure class has been created.

IBMzOS_CFStructureInstDeletion

A 'life cycle' indication that indicates that an instance of the IBMzOS_CFStructure class has been deleted.

IBMzOS_CFStructureInstModification

A 'life cycle' indication that indicates that an instance of the IBMzOS_CFStructure class has been modified.