This class represents the methods and properties common to all specific types of z/OS® couple datasets. Examples of z/OS couple datasets include z/OS System Complex (Sysplex) and Coupling Facility Resource Manager (CFRM) couple datasets.

Subclasses are

• IBMzOS_SysplexCoupleDataset (see IBMzOS_SysplexCoupleDataset) and
• IBMzOS_CFRMCoupleDataset (see IBMzOS_CFRMCoupleDataset).

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

Not supported for z/OS.

string Name [key]

Name of Couple Dataset

uint16 OperationalStatus [ ]

The current status of the SysplexCoupleDataset:

0 = Unknown
2 = OK
6 = Error
9 = Stopping

string StatusDescriptions [ ]

Strings describing the various Operational Status values.

string Status

Not supported for z/OS.

string CSCreationClassName [key]

The scoping ComputerSystem's CreationClassName.

string CSName [key]

The scoping ComputerSystem's Name.

string FSCreationClassName [key]

The scoping FileSystem's CreationClassName.

string FSName ]key]

The scoping FileSystem's name.

string CreationClassName [key]

CreationClassName indicates the name of the class or the subclass used in the creation of an instance.

When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

uint64 FileSize

Not supported for z/OS.

datetime CreationDate

Not supported for z/OS.

datetime LastModified

Not supported for z/OS.

datetime LastAccessed

Not supported for z/OS.

boolean Executable

Indicates that the File is executable.

string CompressionMethod

Not supported for z/OS.

string EncryptionMethod

Not supported for z/OS.

uint64 InUseCount

Not supported for z/OS.

string SysplexName

This is the name of the z/OS Sysplex to which the couple dataset represented by an instance of this class belongs.

Couple datasets are formatted for use in a particular Sysplex and cannot be used by a Sysplex other than the one for which they have been formatted.

string Volser

This is the volume serial of the logical volume on which the couple dataset is defined.

string DeviceNumber

This is the z/OS device number of the logical volume on which the couple dataset is defined. The device number is local to the z/OS system from which this instance was obtained.

A logical volume may have different device numbers on different z/OS systems in the Sysplex, even though it is the same logical volume being shared by the different z/OS systems.

string NarrativeInfo

This property contains information used by the couple dataset owner to provide additional descriptive information about the couple dataset and its usage. This information includes formatting characteristics and any special functions or attributes that the couple dataset supports.

string Type

This property identifies the type of couple dataset the instance represents. Some examples of couple dataset types include CFRM and SYSPLEX. There are other types of couple datasets, although not all of them are externalized through CIM.

boolean IsPrimary

This property identifies whether the couple dataset represented by an instance is currently in use as the primary couple dataset for its type.

A value of True indicates that this instance represents the couple dataset that is currently in use as the primary couple dataset of its type.

boolean IsAlternate

This property identifies whether the couple dataset represented by an instance is currently in use as the alternate couple dataset "for its type.

A value of True indicates that this instance represents the couple dataset that is currently in use as the alternate couple dataset of its type.

uint32 MaximumNumberOfSystems

This property identifies the number of z/OS systems in the Sysplex that the couple dataset represented by this instance was formatted to support.

datetime FormatTime

This property identifies the local time that the couple dataset was formatted.

Note:

This property is in the local time of the operating system host servicing the request.

boolean IsSynchronized

This property applies only to instances representing couple datasets that are currently in use as the alternate couple dataset for their type.

A value of True indicates that the couple dataset has been fully synchronized with the primary couple dataset of its type.

A value of False indicates that the couple dataset is still in the process of synchronizing with the primary couple dataset of its type.

An alternate couple dataset must be fully synchronized with the primary couple dataset of its type in order to provide failover capability in the event of an error affecting the primary couple dataset.

boolean ErrorState

This property identifies whether the couple dataset is in an error state. When True, the couple dataset has experienced a permanent error and is in the process of being removed from active use.

uint32 NumberOfStructures

This is the number of coupling facility (CF) structures that the CFRM couple dataset is formatted to support. It is the maximum number of structures that can be defined for use in a policy contained in this couple dataset.

uint32 NumberOfConnectors

Connectors are programs running under z/OS that establish a connection to a CF structure. This property identifies the number of connectors per structure that the couple dataset is formatted to support. It is the maximum number of concurrent connectors that can be supported for each structure defined in the couple dataset.

uint32 NumberOfCFs

This is the number of coupling facilities the couple dataset is formatted to support. It is the maximum number of CFs that can be defined for use in a CFRM policy contained in this couple dataset.

uint32 NumberOfPolicies

This is the number of administrative (inactive) policies that the couple dataset is formatted to support.

uint32 SwitchPrimary()

This method switches the couple dataset represented by this instance as follows:

If the instance represents a current in-use alternate couple dataset, it is switched to become the current primary couple dataset. If the alternate couple dataset is not fully synchronized or is in an error state, the method returns an error.

If the instance represents a current in-use primary couple dataset, then it is switched out and the current in-use alternate couple dataset is switched to become the primary. If there is no current in-use alternate couple dataset or the in-use alternate couple dataset is not fully synchronized or in an error state, the method returns an error.

This method functions like the z/OS operator command:

SETXCF COUPLE,TYPE=___,PSWITCH