Interface ICMASInCICSplexDefinition
-
- All Superinterfaces:
ICICSObject
,ICPSMConfigurationDefinition
,IDefinition
,com.ibm.cics.model.meta.ITypedObject
public interface ICMASInCICSplexDefinition extends ICPSMConfigurationDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ICMASInCICSplexDefinition.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
ICMASInCICSplexDefinition.DaylghtsvValue
Enumeration type for field DAYLGHTSVstatic class
ICMASInCICSplexDefinition.MpstatusValue
Enumeration type for field MPSTATUSstatic class
ICMASInCICSplexDefinition.RodmpopValue
Enumeration type for field RODMPOPstatic class
ICMASInCICSplexDefinition.SecbypassValue
Enumeration type for field SECBYPASSstatic class
ICMASInCICSplexDefinition.SeccmdchkValue
Enumeration type for field SECCMDCHKstatic class
ICMASInCICSplexDefinition.SecreschkValue
Enumeration type for field SECRESCHKstatic class
ICMASInCICSplexDefinition.StateValue
Enumeration type for field STATE
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSObject
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IDefinition
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Long
getBotrsupd()
Getter for field BOTRSUPDICMASInCICSplexDefinition.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTICMASInCICSplexDefinitionReference
getCICSObjectReference()
java.lang.String
getCicsplex()
Getter for field CICSPLEXjava.lang.String
getCmasname()
Getter for field CMASNAMEICMASInCICSplexDefinition.DaylghtsvValue
getDaylghtsv()
Getter for field DAYLGHTSVjava.lang.Long
getInterval()
Getter for field INTERVALjava.lang.String
getMpname()
Getter for field MPNAMEICMASInCICSplexDefinition.MpstatusValue
getMpstatus()
Getter for field MPSTATUSICICSType<ICMASInCICSplexDefinition>
getObjectType()
java.lang.Long
getReadrs()
Getter for field READRSICMASInCICSplexDefinition.RodmpopValue
getRodmpop()
Getter for field RODMPOPjava.lang.String
getRspoolid()
Getter for field RSPOOLIDICMASInCICSplexDefinition.SecbypassValue
getSecbypass()
Getter for field SECBYPASSICMASInCICSplexDefinition.SeccmdchkValue
getSeccmdchk()
Getter for field SECCMDCHKICMASInCICSplexDefinition.SecreschkValue
getSecreschk()
Getter for field SECRESCHKICMASInCICSplexDefinition.StateValue
getState()
Getter for field STATEjava.lang.Long
getStatus()
Getter for field STATUSjava.lang.String
getSysid()
Getter for field SYSIDjava.lang.String
getTmezone()
Getter for field TMEZONEjava.lang.Long
getTmezoneo()
Getter for field TMEZONEOjava.lang.Long
getToprsupd()
Getter for field TOPRSUPDjava.lang.Long
getUpdaters()
Getter for field UPDATERS-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICPSMConfigurationDefinition
getChangeAgentRelease, getChangeTime, getChangeUserID, getCICSContainer, getCreateTime
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ICMASInCICSplexDefinition> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceICPSMConfigurationDefinition
- Specified by:
getObjectType
in interfaceIDefinition
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
ICMASInCICSplexDefinition.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- DREPAPI - Resource was last changed by a CICSPlex SM API command.
- DREPBATCH - Changed by a CICSPlex SM utility.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getCmasname
java.lang.String getCmasname()
Getter for field CMASNAMECMAS
The name of a CMAS associated with the CICSplex.
-
getCicsplex
java.lang.String getCicsplex()
Getter for field CICSPLEXCICSplex
The 1- to 8-character name for the CICSplex. The name can contain alphabetic, numeric, or national characters. However, the first character must be alphabetic.
-
getInterval
java.lang.Long getInterval()
Getter for field INTERVALPerformance data interval
The number of minutes, from 15 to 1440, that monitor data is to be accumulated for this CICSplex before the statistics counters are reset.
-
getSeccmdchk
ICMASInCICSplexDefinition.SeccmdchkValue getSeccmdchk()
Getter for field SECCMDCHKSecurity command check
Indicates whether or not CICSPlex SM security is used to simulate CICS command checking for the CICS systems associated with the CICSplex.
Input Values: YES | NO
-
getSecreschk
ICMASInCICSplexDefinition.SecreschkValue getSecreschk()
Getter for field SECRESCHKSecurity resource check
Indicates whether CICSPlex SM security is used to simulate CICS resource checking for the CICS systems associated with the CICSplex.
Input Values: YES | NO
-
getSecbypass
ICMASInCICSplexDefinition.SecbypassValue getSecbypass()
Getter for field SECBYPASSBypass security
Indicates whether all simulated CICS security checking is to be bypassed for this CICS system:
- YES - Bypass all simulated CICS security checking for this CICS system.
- NO - Do not bypass simulated CICS security checking for this CICS system.
- INHERIT - Use the value assigned to the CICSplex with which this CICS system is associated.
-
getSysid
java.lang.String getSysid()
Getter for field SYSIDCMAS system ID
The 4-character system ID of the CMAS.
-
getStatus
java.lang.Long getStatus()
Getter for field STATUSStatus
The status of the CICSplex, as one of the following:
- CREPEND - Create pending.
- ACTIVE - CICSplex active.
- UPDPEND - Updates pending.
- DELPEND - Removal pending
- UNDELETE - REM/CRE cycle
-
getMpname
java.lang.String getMpname()
Getter for field MPNAMEMaintenance point CMAS
The name of the maintenance point CMAS.
-
getTmezoneo
java.lang.Long getTmezoneo()
Getter for field TMEZONEOTime zone offset
A number of minutes, between 0 and 59, that are to be added to the specified time zone. This adjustment is used to resolve time references in areas that do not use a standard zone.
-
getTmezone
java.lang.String getTmezone()
Getter for field TMEZONETime zone
A code identifying the time zone that is associated with this CICSplex.
-
getDaylghtsv
ICMASInCICSplexDefinition.DaylghtsvValue getDaylghtsv()
Getter for field DAYLGHTSVDaylight saving time in effect
Indicates whether or not the specified time zone is currently recognizing daylight saving time.
-
getRodmpop
ICMASInCICSplexDefinition.RodmpopValue getRodmpop()
Getter for field RODMPOPResource status facility populate indicator
Indicates whether the CICSplex is to be identified to and monitored by the resource status facility.
-
getState
ICMASInCICSplexDefinition.StateValue getState()
Getter for field STATEState
The current state of the CMAS association to the CICSplex, as one of the following:
- NORMAL - The CMAS is actively participating in the management of the CICSplex.
- CREATING - A request was made to add the CMAS to the management of the CICSplex, but the CMAS has not been contacted yet.
- REMOVING - A request was made to remove the CMAS from the management of the CICSplex, but the CMAS has not been contacted yet.
-
getMpstatus
ICMASInCICSplexDefinition.MpstatusValue getMpstatus()
Getter for field MPSTATUSCMAS maintenance point status
Indicates whether or not a CMAS is the maintenance point CMAS for the CICSplex.
-
getReadrs
java.lang.Long getReadrs()
Getter for field READRSRS server read interval
Within a workload running in optimized mode, this value specifies the minimum interval between refreshes of a target region status from a CICS CFDT server. These refresh requests will be issued by a routing region that is evaluating a target region for a dynamic routing request.
The value range is from 0 to 2000, and represents units of milliseconds:
- A value of 0 means that a routing region will request a status update of a target region on every occasion that it examines that target region's status.
- Values between 1 and 2000 specify the minimum time interval that must expire before the status of a target region can be refreshed.
A low interval value means that the CFDT server will be polled more often for a status update, than for a higher value. For workloads in QUEUE mode, this will result in a task load more evenly balanced across the CICS regions in the workload target scope (assuming all other health and link factors are equal) . However, the utilization of the RS server will be correspondingly increased, which may consequently result in a higher utilization of your coupling facility.
A value of 1000 represents a one second interval. The default value is 200 milliseconds
The value specified here at the CICSplex level may be overridden at the CICS definition level to allow fine tuning of the value on an individual CICS region basis.
-
getUpdaters
java.lang.Long getUpdaters()
Getter for field UPDATERSRS server update frequency
Within a workload running in optimized mode, this value indicates the frequency with which the CICS CFDT (RS) server will be called to modify the value of the task load within a target CICS region. This value will be the default frequency value for all CICS regions within the current CICSplex definition.
The value range is from 0 to 25:
- A value of 0 means that the RS server is not notified of any task load count changes, which disables the optimized workload function for regions within the scope of this CICSplex.
- Values between 1 and 25 are applied as an arithmetic percentage to a region's MAXTASKS setting. The resultant task count value is used as a numeric threshold to drive an update call to the RS server.
For example, with a MAXTASKS setting of 120, and with this attribute set to 20, the RS server will be called to update the WLM load count when the regions task count changes between:
- 23 and 24 tasks - (20%),
- 47 and 48 tasks - (40%),
- 71 and 72 tasks - (60%),
- 95 and 96 tasks - (80%),
- 119 and 120 tasks - (100%).
The RS server would be updated when a regions task load increments or decrements across these boundaries.
If the value reported is at the lower end of the 1-25 scale, then that will cause an increase in the frequency of updates to the RS server across its task load range. For workloads in QUEUE mode, this will result in a task load more evenly balanced across the CICS regions in the workload target scope (assuming all other health and link factors are equal) . However, the utilization of the RS server will be correspondingly increased, which may consequently result in a higher utilization of your coupling facility.
The value shown here at the CICSplex level may be overridden at the CICS definition level to allow fine tuning of the value on an individual CICS region basis.
-
getToprsupd
java.lang.Long getToprsupd()
Getter for field TOPRSUPDRS server top tier
For sysplex optimized workloads, this value is converted from a task load percentage to an actual task count. That count will be subtracted from the MAXTASK value for the region to determine top tier task load range.
The value range is from 1 to 25. The value is applied as an arithmetic percentage to a region's MAXTASKS setting. The resultant task count value is subtracted from the region's MAXTASKS setting to establish a task load top tier. If the task load in a region runs up to its MAXTASKS limit, then the task load must drop back below this value before the MAXTASKS state for the region is switched off and broadcast to the coupling facility.
The default value is 5%. You should only change this value after giving consideration to the impact that the change may have on your workload and coupling facility throughput.
The value shown here at the CICSplex level may be overridden at the CICS definition level to allow fine tuning of the value on an individual CICS region basis.
-
getBotrsupd
java.lang.Long getBotrsupd()
Getter for field BOTRSUPDRS server bottom tier
For sysplex optimized workloads, this value is converted from a task load percentage to an actual task count. That count will be used to define the bottom tier task load range (from zero up to this value).
The value range is from 1 to 25. When a region's task load falls within this range, then the task load will be broadcast to the coupling facility for every change in the task load. Once the load reaches this value, then the RS server update frequency task rules will be activated.
The default value is 1%. You should only change this value after giving consideration to the impact that the change may have on your workload and coupling facility throughput.
The value shown here at the CICSplex level may be overridden at the CICS definition level to allow fine tuning of the value on an individual CICS region basis.
-
getRspoolid
java.lang.String getRspoolid()
Getter for field RSPOOLIDRS server pool name
For sysplex optimized workloads, region status data is maintained within a coupling facility data table. That table will be contained within a CFDT pool identified by this attribute. For an optimized workload to activate, there must be an active Region Status server which manages data for the pool name specified here.
If your CICSplex identifiers are not unique within your sysplex, you must ensure that the RS server pool names are unique. If your Sysplex comprises unique CICSplex identifiers, then they may all specify the same RS server pool name.
The default name is DFHRSTAT. You may choose to employ an existing CFDT pool for containing your CICSplex data tables. If you do, be aware that the throughput of your optimized workloads may be impeded by any user application activity to the specified pool name. Likewise, any application throughput to the pool may be impacted by sysplex optimized workloads. It is recommended that a discrete RS server and poolname is defined for the optimized workload function.
-
getCICSObjectReference
ICMASInCICSplexDefinitionReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICPSMConfigurationDefinition
- Specified by:
getCICSObjectReference
in interfaceIDefinition
-
-