|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkloadTargetStatus
generated from CICS resourcetable WLMATARG
Nested Class Summary | |
---|---|
static class |
IWorkloadTargetStatus.ContactStatusValue
Enumeration type for field CON_STATUS |
static class |
IWorkloadTargetStatus.HealthDumpValue
Enumeration type for field HLTHDUMP |
static class |
IWorkloadTargetStatus.HealthMasNonresponsiveValue
Enumeration type for field HLTHNRM |
static class |
IWorkloadTargetStatus.HealthMaxtasksValue
Enumeration type for field HLTHMAXT |
static class |
IWorkloadTargetStatus.HealthShortOnStorageValue
Enumeration type for field HLTHSOS |
static class |
IWorkloadTargetStatus.HealthStallValue
Enumeration type for field HLTHSTALL |
static class |
IWorkloadTargetStatus.OptimizationEnablementValue
Enumeration type for field WLMOPTEN |
static class |
IWorkloadTargetStatus.OptimizationStatusValue
Enumeration type for field OWSTATE |
static class |
IWorkloadTargetStatus.StatusValue
Enumeration type for field STATUS |
static class |
IWorkloadTargetStatus.TaskLoadQueueModeValue
Enumeration type for field WLMQMODE |
Field Summary |
---|
Fields inherited from interface com.ibm.cics.model.ICPSMManager |
---|
COPYRIGHT |
Method Summary | ||
---|---|---|
|
findReferences(IReferenceAttribute<From,IWorkloadTargetStatus> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. |
|
java.lang.Long |
getCfreadct()
Getter for field CFREADCT |
|
java.lang.Long |
getCfUpdateCount()
Getter for field CFUPDCNT |
|
IWorkloadTargetStatusReference |
getCICSObjectReference()
|
|
IWorkloadTargetStatus.ContactStatusValue |
getContactStatus()
Getter for field CON_STATUS |
|
java.lang.String |
getCpsmver()
Getter for field CPSMVER |
|
java.lang.Long |
getEvents()
Getter for field EVENTS |
|
IWorkloadTargetStatus.HealthDumpValue |
getHealthDump()
Getter for field HLTHDUMP |
|
IWorkloadTargetStatus.HealthMasNonresponsiveValue |
getHealthMasNonresponsive()
Getter for field HLTHNRM |
|
IWorkloadTargetStatus.HealthMaxtasksValue |
getHealthMaxtasks()
Getter for field HLTHMAXT |
|
IWorkloadTargetStatus.HealthShortOnStorageValue |
getHealthShortOnStorage()
Getter for field HLTHSOS |
|
IWorkloadTargetStatus.HealthStallValue |
getHealthStall()
Getter for field HLTHSTALL |
|
java.lang.Long |
getMaxtasks()
Getter for field MAXTASKS |
|
ICICSType<IWorkloadTargetStatus> |
getObjectType()
|
|
IWorkloadTargetStatus.OptimizationEnablementValue |
getOptimizationEnablement()
Getter for field WLMOPTEN |
|
IWorkloadTargetStatus.OptimizationStatusValue |
getOptimizationStatus()
Getter for field OWSTATE |
|
java.lang.String |
getOwningCMAS()
Getter for field OWNINGCMAS |
|
java.lang.String |
getReportingCMAS()
Getter for field RPTINGCMAS |
|
java.lang.Long |
getRouteAbends()
Getter for field RTABEND |
|
java.lang.Long |
getRouteCompletes()
Getter for field RTCOMPLETE |
|
java.lang.Long |
getRouteErrors()
Getter for field RTERROR |
|
java.lang.Long |
getRouteInitiates()
Getter for field RTINITIATE |
|
java.lang.Long |
getRouteNotifies()
Getter for field RTNOTIFY |
|
java.lang.Long |
getRouteSelections()
Getter for field RTSELECT |
|
java.lang.Long |
getRouteTerminates()
Getter for field RTTERMINATE |
|
java.lang.Long |
getRoutingLoad()
Getter for field ROUTINGLOAD |
|
java.lang.Long |
getRoutingWeight()
Getter for field ROUTEWGHT |
|
java.lang.String |
getRsPoolID()
Getter for field RSPOOLID |
|
java.lang.Long |
getRsServerBottomTier()
Getter for field BOTRSUPD |
|
java.lang.Long |
getRsServerReadInterval()
Getter for field READRS |
|
java.lang.Long |
getRsServerTopTier()
Getter for field TOPRSUPD |
|
java.lang.Long |
getRsServerUpdateFreq()
Getter for field UPDATERS |
|
IWorkloadTargetStatus.StatusValue |
getStatus()
Getter for field STATUS |
|
java.lang.String |
getTargetRegion()
Getter for field AOR |
|
java.lang.Long |
getTaskCountIncrement()
Getter for field TASKINC |
|
java.lang.Long |
getTaskLoad()
Getter for field TASKLOAD |
|
java.lang.Long |
getTaskLoadHealthThreshold()
Getter for field WLMTHRSH |
|
IWorkloadTargetStatus.TaskLoadQueueModeValue |
getTaskLoadQueueMode()
Getter for field WLMQMODE |
|
java.lang.Long |
getWorkloadCount()
Getter for field WRKLDCNT |
Methods inherited from interface com.ibm.cics.model.ICICSObject |
---|
getCICSType, getName |
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject |
---|
getAttributeValue |
Method Detail |
---|
ICICSType<IWorkloadTargetStatus> getObjectType()
getObjectType
in interface ICICSObject
getObjectType
in interface ICPSMManager
getObjectType
in interface com.ibm.cics.model.meta.ITypedObject
java.lang.String getTargetRegion()
Target region name
The name of an active CICS system, acting as a WLM target region.
IWorkloadTargetStatus.StatusValue getStatus()
Target region status
The current status of the target region associated with the workload, as one of the following:
Input Values: ACTIVE | QUIESCE
IWorkloadTargetStatus.ContactStatusValue getContactStatus()
Target region contact status
The status of the connection between the target region and the CMAS. Values are:
IWorkloadTargetStatus.OptimizationStatusValue getOptimizationStatus()
Optimization status
This field reports the status of the current target region for the optimized workload routing function.
The possible values are:
This value is set to INACTIVE if the reporting CMAS is not connected to a Region Status (RS) server.
java.lang.Long getRoutingWeight()
WLM routing weight for region
This is the calculated routing weight for the current routing target without accounting for outstanding RTA MRM events, router region link speeds and transaction abend probabilities. Only the transaction load and health state of the region are calculated into this value. The health state is a combination of the SOS, Dump, Stall and MAXTASK conditions. The transaction load is the value indicated by the 'Task load percentage' attribute. No workload associated parameters are included in this weight value. To determine routing weights for specific workloads, then use the corresponding attribute returned in the WLMAWAOR 'Target region in active workload' views.
When no affinities are applicable to a dynamic routing request, then the routing weights of all target regions in the routing scope are compared and the region with the lowest weight value will be the one selected. If several regions have the same lowest weight value, then one of that set is randomly selected as the routing target.
Note: 2147483647 is a special value indicating that the target is quiesced.
java.lang.Long getWorkloadCount()
Workload count
This is a count of the workloads which have designated this region as a dynamic routing target.
The workload count is set to zero (0) if:
java.lang.Long getEvents()
RTA event count for target region
This is the count of all outstanding RTA events that are associated with the current region.
This value is set to zero (0) if the reporting CMAS is not the owning CMAS.
IWorkloadTargetStatus.TaskLoadQueueModeValue getTaskLoadQueueMode()
Task load queue mode
This attribute specifies how the queued task load of a target CICS region is to be evaluated:
The default value is ALL. This value is specified within the CICSPlex SM CICS system definition object. If you want this value to be changed, you must modify the system definition for the current region and then restart it. You may change the value in an active CICS region by using the CICSPlex SM MAS object. When the region restarts it will revert to the value specified in the system definition.
java.lang.Long getTaskLoad()
Task load percentage
This is the normalized task load for this target region. It is calculated from dividing the current task routing count by the MAXTASKS value for the region, and multiplying by 100.
java.lang.Long getRouteSelections()
Route selections
The number of times that the current region has been chosen as a routing target by route selection processing.
This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.
java.lang.Long getRouteErrors()
Route errors
The number of times that the selection of the current region has caused a route error to occur. Route errors occur when CICSPlex SM has selected a target region, and CICS has experienced an error in routing the work to it. For example, the connection is out of service, or no sessions are immediately available for an LU 6.2 connection. CICSPlex SM will attempt to select another target when this occurs.
This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.
java.lang.Long getRouteTerminates()
Route terminates
The number of times that route terminate has been driven for this region. Route terminate occurs when a transaction finishes on a target region.
This value is the total for all requests processed by routing regions (dynamic routing) and all requests processed by the target region (distributed routing) while they were connected to the reporting CMAS.
java.lang.Long getRouteNotifies()
Route notifies
The number of times that route notify has been driven for this region. Route notify normally occurs when a static routing starts.
This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.
java.lang.Long getRouteAbends()
Route abends
The number of times that route abend has been returned after selecting this region.
This value is the total for all requests processed by routing regions (dynamic routing) and all requests processed by the target region (distributed routing) while they were connected to the reporting CMAS.
java.lang.Long getRouteInitiates()
Route initiates
The number of times that routed transactions have been actually started on the target region.
This value is the total for all requests processed by the target region while it was connected to the reporting CMAS.
java.lang.Long getRouteCompletes()
Route completes
The number of times that route complete has been driven for this region. Route complete occurs after the transaction request is dispatched to the waiting queue of the target region.
This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.
IWorkloadTargetStatus.HealthShortOnStorageValue getHealthShortOnStorage()
Short on storage
This field indicates the SOS status of this routing target at the current time. Note that a CICS region can change from being in and out of SOS status very rapidly.
IWorkloadTargetStatus.HealthStallValue getHealthStall()
Region has stalled
This indicates whether the routing target is in a stall condition. If the region is stalled, use the Active task views to determine which tasks are suspended, and determine why. Note: Stall here means a task has been waiting for the same resource for a specific time.
IWorkloadTargetStatus.HealthDumpValue getHealthDump()
Region is dumping
This indicates whether the routing target is currently issuing a transaction or system dump.
IWorkloadTargetStatus.HealthMaxtasksValue getHealthMaxtasks()
Region is at MAXTASKS
This indicates whether the routing target is currently running at a task rate that has reached its maximum tasks threshold.
java.lang.Long getRoutingLoad()
Routing Load
This is the routing load used by WLM route decision making for the target region. Note that this will not match the real CICS task count at the time of this query.
For an ACTIVE System Optimized WLM routing region this will be the approximate task load in the target region, taking into account 'Task Count Increment Value', 'RS Server Bottom Tier' and 'RS Server Top Tier'. The accuracy of this value is also affected by the RS Read Interval and RS Update frequency settings.
For target regions that are not connected to a RS Server, and are therefore in a non-optimized WLM state, this value will appear to be less accurate, when compared to the actual task count. This is because this is the normalized routing load for this region. It should be noted that when running in a non-optimized WLM state, this value can exceed the MAX TASK value, without the MAX TASK flag being set on, and is correct behaviour as the MAX TASK indicator is related to the target region's health status taken from actual task counts.
It is possible that a region could be the target for multiple workloads and show different routing weight values. This is not abnormal behaviour - it is a symptom of the synchronization latencies within workload manager. Workload optimization will nullify this effect. The workload manager runtime processes will continue to execute normally in spite of this disparity in the load values. To suppress these observed load differences, try to ensure that all MASes and CMASes that participate in the workload have a connectable region status server available.
java.lang.Long getMaxtasks()
Maximum task count for region
This is the defined maximum number of active tasks that may concurrently execute in this routing target.
java.lang.Long getCfUpdateCount()
Coupling Facility update count
This is the number of update calls that the RS Server has made to the coupling facility for this target region.
This value is reset to zero whenever the RS Server or the CICS region is started.
java.lang.String getRsPoolID()
RS 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 identified 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 share the same RS server pool.
This attribute is defined in the parent CICSplex definition of the current target region. 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 pool name is defined for the optimized workload function.
java.lang.String getOwningCMAS()
Owning CMAS name
The name of a CMAS that participates in the management of the target region.
java.lang.Long getTaskCountIncrement()
Task count increment value
This is the translation of the RS Server update frequency value to an actual task count value for the current target region. Each time the current task count reaches a boundary that is a factor of this value, then an update is sent to the RS server.
java.lang.Long getRsServerReadInterval()
RS server read interval
Within a region 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 this region as a possible target for a dynamic routing request.
The value range is from 0 to 2000, and represents units of milliseconds:
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 z/OS Coupling Facility.
A value of 1000 represents a one second interval. The default value is 200 milliseconds
This value may be modified for this specific region using the 'MASs known to CICSplex' views, or the 'CICS system definition' views.
java.lang.Long getRsServerUpdateFreq()
RS Server update frequency
Within a region running in optimized mode, this value specifies the frequency with which the CICS CFDT (RS) server will be called to modify the value of the task load within this target region.
The value range is from 0 to 25:
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:
The RS Server would be updated when the task load increments or decrements across these boundaries.
If a value is specified that 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 the 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 z/OS Coupling Facility.
This value may be modified for this specific region using the 'MASs known to CICSplex' views, or the 'CICS system definition' views.
java.lang.Long getTaskLoadHealthThreshold()
Task load health threshold
This specifies a percentage threshold of the current region's task load, which is calculated by dividing the current task count by the maximum task count. When the load for a target region reaches this threshold, then WLM considers the region to be relatively unhealthy. This will cause higher link weights to be applied to the WLM routing algorithm when evaluating this region.
When a target scope covers local and remote regions relative to the router, then WLM will favour local targets over remote ones. The effect of this attribute is that when this load threshold in the local regions is achieved, then WLM will start to favour remote targets instead. When all targets in the scope achieve this load threshold, then WLM will revert to favouring local targets again.
The value range is from 1 to 100, and the default value is 60. This value is specified within the CICSPlex SM CICS System Definition object. If you want this value to be changed, you must modify the system definition for the current region and then restart it. You may change the value in an active CICS region by using the CICSPlex SM MAS object. When the region restarts it will revert to the value specified in the system definition.
If this value is set to 0, then the current region is not at a high enough level to support the use of this attribute. You will not be able to change it, and the WLM route decision process will ignore it.
Note: this value is nullified when applied to the routing factor of link neutral dynamic routing requests. This is because the link weight itself is ignored for the LNQUEUE and LNGOAL algorithms.
java.lang.Long getRsServerTopTier()
RS server top tier
This is the 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 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.
java.lang.Long getRsServerBottomTier()
RS server bottom tier
This is 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 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.
IWorkloadTargetStatus.OptimizationEnablementValue getOptimizationEnablement()
Optimization enablement state
This field reports whether the current target region will support the optimized workload routing function.
The possible values are:
This value may be modified for this specific region using the 'MASs known to CICSplex' views, or the 'CICS system definition' views.
java.lang.String getReportingCMAS()
Reporting CMAS name
The name of a CMAS that provided this record.
IWorkloadTargetStatus.HealthMasNonresponsiveValue getHealthMasNonresponsive()
MAS non responsive
This field indicates the routing target is non responsive at the current time.
java.lang.String getCpsmver()
CICSPlex SM version
This is the CICSPlex SM version of the target region.
java.lang.Long getCfreadct()
Coupling Facility read count
This is the number of read calls that have been made by routing regions to the z/OS Coupling Facility for this region's status.
IWorkloadTargetStatusReference getCICSObjectReference()
getCICSObjectReference
in interface ICICSObject
<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IWorkloadTargetStatus> referenceAttribute)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |