com.ibm.cics.model
Interface IManagedRegion

All Superinterfaces:
ICICSObject, ICPSMManager

public interface IManagedRegion
extends ICPSMManager

generated from CICS resourcetable MAS


Nested Class Summary
static class IManagedRegion.StateValue
          Enumeration type for field CICSSTATE
static class IManagedRegion.WlmoptenValue
          Enumeration type for field WLMOPTEN
static class IManagedRegion.WlmqmodeValue
          Enumeration type for field WLMQMODE
 
Method Summary
 java.lang.Long getBotrsupd()
          Getter for field BOTRSUPD
 java.lang.String getDescription()
          Getter for field DESC
 java.lang.String getHost()
          Getter for field HOST
 java.lang.String getName()
          Getter for field CICSNAME
 java.lang.String getNetworkid()
          Getter for field NETWORKID
 java.lang.Long getPort()
          Getter for field PORT
 java.lang.Long getReadrs()
          Getter for field READRS
 IManagedRegion.StateValue getState()
          Getter for field CICSSTATE
 java.lang.Long getToprsupd()
          Getter for field TOPRSUPD
 java.lang.Long getUpdaters()
          Getter for field UPDATERS
 IManagedRegion.WlmoptenValue getWlmopten()
          Getter for field WLMOPTEN
 IManagedRegion.WlmqmodeValue getWlmqmode()
          Getter for field WLMQMODE
 java.lang.Long getWlmthrsh()
          Getter for field WLMTHRSH
 

Method Detail

getName

java.lang.String getName()
Getter for field CICSNAME

CICS system name

The name of a CICS system that is currently known to CICSPlex SM. Once a CICS system makes itself known to CICSPlex SM, it is considered a MAS.

Specified by:
getName in interface ICICSObject

getState

IManagedRegion.StateValue getState()
Getter for field CICSSTATE

MAS status

The status of the MAS is either ACTIVE or INACTIVE. CICSPlex SM can only manage MASs that are active.

ACTIVE
The CICS system is active and connected to CICSPlex SM.
INACTIVE
The CICS system is inactive, or not connected to CICSPlex SM, or communication to the CMAS that manages the MAS is not active.

A MAS can be inactive for one of two reasons:

Other valid options are LOSTCONN, LOSTCMAS, and LOSTMAS. Note:

If this field is blank, the MAS is temporarily between an inactive and active state.


getDescription

java.lang.String getDescription()
Getter for field DESC

CICS system description

A description of the CICS system.


getHost

java.lang.String getHost()
Getter for field HOST

Host Name

The 116-character host name of the system (for example, www.example.com), or its dotted decimal IP address (for example, 9.20.181.3). This is used for IPIC SYSLINK connections.


getNetworkid

java.lang.String getNetworkid()
Getter for field NETWORKID

Network ID

The network ID of the system. NETWORKID is used in combination with the APPLID option to ensure unique naming for connecting systems via IPIC. This is used for IPIC SYSLINK connections.


getPort

java.lang.Long getPort()
Getter for field PORT

Port number

A decimal number, in the range 1 through 65535, specifying the port number to be used for outbound requests on this IPIC connection. That is, the number of the port on which the remote system will be listening. This is used for IPIC SYSLINK connections.


getReadrs

java.lang.Long getReadrs()
Getter for field READRS

RS server read interval

This attribute applies to CICSPlex SM Sysplex Optimized Workloads. If the MAS is not at a sufficiently high enough release to support Sysplex Optimized Workloads, then this value will contain zero, and will not be changeable to any other value.

If the MAS is at high enough release for Optimized Workload support, then the following help explanation applies:

Within a workload running in optimized mode, this value specifies the minimum interval between region status refreshes that a routing region would request from the CICS CFDT server. This is the current value used by this CICS region.

The value range is from 0 to 2000, and represents units of milliseconds:

A value of 1000 represents a one second interval. The default value is 200 milliseconds

You may change this value here to dynamically change the value assigned to the current CICS region. If you want the change to be applied to this CICS region after it has been restarted, then you must also change this value in the CICS System definition panel.


getUpdaters

java.lang.Long getUpdaters()
Getter for field UPDATERS

RS server update frequency

This attribute applies to CICSPlex SM sysplex optimized workloads. If the MAS is not at a sufficiently high enough release to support sysplex optimized workloads, then this value will contain zero, and will not be changeable to any other value.

If the MAS is at high enough release for optimized workload support, then the following help explanation applies:

Within a workload 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 a target CICS region. This is the current value used by this CICS 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 a regions task load increments or decrements across these boundaries.

If you specify a value 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 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 z/OS Coupling Facility.

You may change this value here to dynamically change the value assigned to the current CICS region. If you want the change to be applied to this CICS region after it has been restarted, then you must also change this value in the CICS System definition panel.


getToprsupd

java.lang.Long getToprsupd()
Getter for field TOPRSUPD

RS server top tier

This attribute applies to CICSPlex SM sysplex optimized workloads. If the MAS is not at a sufficiently high enough release to support sysplex optimized workloads, then this value will contain zero, and will not be changeable to any other value.

If the MAS is at high enough release for optimized workload support, then the following help explanation applies:

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, or INHERIT.

The default value is 5%. You may change this value here to dynamically change the value assigned to the current CICS region. If you want the change to be applied to this CICS region after it has been restarted, then you must also change this value in the CICS system definition panel.

You should only change this value after giving consideration to the impact that the change may have on your workload and coupling facility throughput.


getBotrsupd

java.lang.Long getBotrsupd()
Getter for field BOTRSUPD

RS server bottom tier

This attribute applies to CICSPlex SM sysplex optimized workloads. If the MAS is not at a sufficiently high enough release to support sysplex optimized workloads, then this value will contain zero, and will not be changeable to any other value.

If the MAS is at high enough release for optimized workload support, then the following help explanation applies:

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, or INHERIT.

The default value is 1%. You may change this value here to dynamically change the value assigned to the current CICS region. If you want the change to be applied to this CICS region after it has been restarted, then you must also change this value in the CICS system definition panel.

You should only change this value after giving consideration to the impact that the change may have on your workload and coupling facility throughput.


getWlmthrsh

java.lang.Long getWlmthrsh()
Getter for field WLMTHRSH

Task load health threshold

This attribute is used by CICSPlex SM Workload Manager. It 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 65. If this value specifies 0, then the current MAS is not at a high enough CICS release to support this function, and you will not be able to change it to any other value.

You may change this value here to dynamically change the value assigned to the current CICS region. If you want the change to be applied to this CICS region after it has been restarted, then you must also change this value in the CICS System definition panel.


getWlmqmode

IManagedRegion.WlmqmodeValue getWlmqmode()
Getter for field WLMQMODE

Task load queue mode

This attribute is used by CICSPlex SM Workload Manager and applies to target regions. This value specifies how the queued task load of a target CICS region is to be evaluated:

The default value is ALL.

If this value specifies N_a , then the current MAS is not at a high enough CICS release to support this function, and you will not be able to change it to any other value.

You may change this value here to dynamically change the value assigned to the current CICS region. If you want the change to be applied to this CICS region after it has been restarted, then you must also change this value in the CICS System definition panel.


getWlmopten

IManagedRegion.WlmoptenValue getWlmopten()
Getter for field WLMOPTEN

WLM optimization enablement

This attribute shows if optimized workload routing is enabled.

When set to ENABLED, this region can utilize optimized workload management.

If this attribute is set to DISABLED, then optimized workload management is suppressed.

The value can be changed to dynamically alter the value assigned to the current CICS region. If this change is to be applied to this CICS region after it has been restarted, then you must also change this value in the CICS System definitions panel.



Copyright © 2008-2009 IBM Corp. All Rights Reserved.