IBMzOS_CouplingFunction
Purpose
This class represents an abstraction of z/OS® clustering capabilities. The
clustering capabilities are referred to as coupling functions, each
serving a unique purpose in a z/OS Systems
Complex (Sysplex). Coupling functions are capabilities that are facilitated
through the use of:
- Couple datasets, which serve as repositories.
- Coupling facilities, which are used by z/OS systems to cache data structures, serialization
structures and provide signaling capabilities to z/OS systems participating in a Sysplex.
- Cross-System Coupling Facility (XCF) software, which is a component
of z/OS that provides functions
to support cooperation between authorized programs running within
a Sysplex.
Coupling functions include such capabilities as basic
Sysplex support and Coupling Facility Resource Manager (CFRM) support.
There are other such coupling functions supported by z/OS, though not all of them may be externalized
through CIM providers.
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_CouplingFunctionProviderModule
Provider library
The physical name of a CMPI provider’s shared object library
as it is stored in the hierarchical file system is
- libcmpiIBMzOS_CouplingFunctionProvider.so
Properties
- 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 [key]
- Name of the coupling function
- 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
- 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.
- uint32 Redundancy
- This identifies the level of couple dataset redundancy currently
active for the coupling function.
- 0
- No couple datasets in use. The coupling function is not active.
- 1
- Primary couple dataset in use.
- 2
- Primary and alternate couple dataset are in use.
- string ActivePolicyName
- Specifies the name of the active policy for the coupling function.
Instances of coupling functions such as SYSPLEX, which have no policy,
will have a null string value.
- datetime TimeActivePolicyStarted
- The local date and time that the active policy was started.
Note:
This property is in the local time of the operating
system host servicing the request.
- boolean isActive
- Identifies whether the coupling function is active.
Coupling
functions with no primary CDS are considered inactive.
Coupling
functions that support policies will be identified as active if they
have a primary couple dataset in use, even if there is not active
policy.
Methods
- uint32 StartPolicy()
- This method activates (starts) the specified policy.
The
policy specified by the name parameter must be an administrative policy
defined in the primary couple dataset currently in use by the coupling
function.
- uint32 StopPolicy()
- This method inactivates the currently active policy. For Coupling
Facilities (CFs) or structures that are actively being used, not all
aspects of the policy may become inactive immediately. These changes
will become pending until the resources in question are no longer
being used by programs operating in the Sysplex.
- uint32 DeletePolicy()
- This method deletes the specified administrative policy.
The
policy specified by the name parameter must be an administrative policy
defined in the primary couple dataset currently in use by the coupling
function.
- uint32 SwitchPrimary()
- This method makes the current in-use alternate couple dataset
the current primary couple dataset for the type represented by the
coupling function instance.
The current in-use primary couple dataset
at the time this method is invoked, upon successful completion of
the method, will no longer be recognized by XCF and the coupling function
instance will be operating solely with a primary couple dataset.
This
method is similar to the z/OS operator
command:
SETXCF COUPLE,TYPE=__,PSWITCH
- uint32 MakeAlternate()
- This method makes the specified couple dataset the current in
use alternate couple dataset for the type represented by the coupling
function instance.
The type of the specified couple dataset must
be compatible with the coupling function instance for which the method
was invoked.
The specified couple dataset must be a newly formatted
couple dataset, formatted specifically for use in the Sysplex in which
the coupling function instance exists. The method will fail if the
specified couple dataset is currently or was previously active in
the Sysplex.
The specified couple dataset may be one created
using the Duplicate method or one created manually via the XCF couple
dataset format utility (IXCL1DSU).
- uint32 Duplicate()
- This method duplicates the characteristics of the currently
active primary couple dataset, for the type represented by the coupling
function instance, to a new couple dataset. The name of the new couple
dataset and the volume serial of the logical volume on which it will
be allocated must be specified by the method invoker. The type of
the couple dataset is determined by the coupling function instance.
Associations
|