|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICICSRegionDefinition
generated from CICS resourcetable CSYSDEF
Nested Class Summary | |
---|---|
static class |
ICICSRegionDefinition.AinsfailValue
Enumeration type for field AINSFAIL |
static class |
ICICSRegionDefinition.AutoinstValue
Enumeration type for field AUTOINST |
static class |
ICICSRegionDefinition.CreateOriginValue
Enumeration type for field CREATEORIGIN |
static class |
ICICSRegionDefinition.DaylghtsvValue
Enumeration type for field DAYLGHTSV |
static class |
ICICSRegionDefinition.DynrouteValue
Enumeration type for field DYNROUTE |
static class |
ICICSRegionDefinition.MonstatusValue
Enumeration type for field MONSTATUS |
static class |
ICICSRegionDefinition.MxtsevValue
Enumeration type for field MXTSEV |
static class |
ICICSRegionDefinition.NrmsevValue
Enumeration type for field NRMSEV |
static class |
ICICSRegionDefinition.RtastatusValue
Enumeration type for field RTASTATUS |
static class |
ICICSRegionDefinition.SamsevValue
Enumeration type for field SAMSEV |
static class |
ICICSRegionDefinition.SdmsevValue
Enumeration type for field SDMSEV |
static class |
ICICSRegionDefinition.SecbypassValue
Enumeration type for field SECBYPASS |
static class |
ICICSRegionDefinition.SeccmdchkValue
Enumeration type for field SECCMDCHK |
static class |
ICICSRegionDefinition.SecreschkValue
Enumeration type for field SECRESCHK |
static class |
ICICSRegionDefinition.SossevValue
Enumeration type for field SOSSEV |
static class |
ICICSRegionDefinition.StlsevValue
Enumeration type for field STLSEV |
static class |
ICICSRegionDefinition.TdmsevValue
Enumeration type for field TDMSEV |
static class |
ICICSRegionDefinition.WlmoptenValue
Enumeration type for field WLMOPTEN |
static class |
ICICSRegionDefinition.WlmqmodeValue
Enumeration type for field WLMQMODE |
static class |
ICICSRegionDefinition.WlmstatusValue
Enumeration type for field WLMSTATUS |
Field Summary |
---|
Fields inherited from interface com.ibm.cics.model.ICPSMDefinition |
---|
COPYRIGHT |
Method Summary | ||
---|---|---|
|
findReferences(IReferenceAttribute<From,ICICSRegionDefinition> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. |
|
java.lang.String |
getActvtime()
Getter for field ACTVTIME |
|
ICICSRegionDefinition.AinsfailValue |
getAinsfail()
Getter for field AINSFAIL |
|
java.lang.String |
getApplID()
Getter for field APPLID |
|
ICICSRegionDefinition.AutoinstValue |
getAutoinst()
Getter for field AUTOINST |
|
java.lang.Long |
getBotrsupd()
Getter for field BOTRSUPD |
|
ICICSRegionDefinitionReference |
getCICSObjectReference()
|
|
java.lang.Long |
getCicssamp()
Getter for field CICSSAMP |
|
java.lang.Long |
getConnsamp()
Getter for field CONNSAMP |
|
java.lang.String |
getContext()
Getter for field CONTEXT |
|
ICICSRegionDefinition.CreateOriginValue |
getCreateOrigin()
Getter for field CREATEORIGIN |
|
ICICSRegionDefinition.DaylghtsvValue |
getDaylghtsv()
Getter for field DAYLGHTSV |
|
java.lang.Long |
getDbxsamp()
Getter for field DBXSAMP |
|
java.lang.String |
getDescription()
Getter for field DESC |
|
ICICSRegionDefinition.DynrouteValue |
getDynroute()
Getter for field DYNROUTE |
|
java.lang.Long |
getFilesamp()
Getter for field FILESAMP |
|
java.lang.Long |
getGlblsamp()
Getter for field GLBLSAMP |
|
java.lang.String |
getHost()
Getter for field HOST |
|
java.lang.Long |
getJrnlsamp()
Getter for field JRNLSAMP |
|
ICICSRegionDefinition.MonstatusValue |
getMonstatus()
Getter for field MONSTATUS |
|
java.lang.String |
getMpcmasid()
Getter for field MPCMASID |
|
java.lang.String |
getMxtaction()
Getter for field MXTACTION |
|
ICICSRegionDefinition.MxtsevValue |
getMxtsev()
Getter for field MXTSEV |
|
java.lang.String |
getName()
Getter for field NAME |
|
java.lang.String |
getNetworkID()
Getter for field NETWORKID |
|
java.lang.String |
getNrmaction()
Getter for field NRMACTION |
|
ICICSRegionDefinition.NrmsevValue |
getNrmsev()
Getter for field NRMSEV |
|
ICICSType<ICICSRegionDefinition> |
getObjectType()
|
|
java.lang.Long |
getPort()
Getter for field PORT |
|
java.lang.String |
getPricmas()
Getter for field PRICMAS |
|
java.lang.Long |
getProgsamp()
Getter for field PROGSAMP |
|
java.lang.Long |
getReadrs()
Getter for field READRS |
|
java.lang.Long |
getRetention()
Getter for field RETENTION |
|
ICICSRegionDefinition.RtastatusValue |
getRtastatus()
Getter for field RTASTATUS |
|
java.lang.String |
getSamaction()
Getter for field SAMACTION |
|
ICICSRegionDefinition.SamsevValue |
getSamsev()
Getter for field SAMSEV |
|
java.lang.String |
getSdmaction()
Getter for field SDMACTION |
|
ICICSRegionDefinition.SdmsevValue |
getSdmsev()
Getter for field SDMSEV |
|
ICICSRegionDefinition.SecbypassValue |
getSecbypass()
Getter for field SECBYPASS |
|
ICICSRegionDefinition.SeccmdchkValue |
getSeccmdchk()
Getter for field SECCMDCHK |
|
ICICSRegionDefinition.SecreschkValue |
getSecreschk()
Getter for field SECRESCHK |
|
java.lang.String |
getSosaction()
Getter for field SOSACTION |
|
ICICSRegionDefinition.SossevValue |
getSossev()
Getter for field SOSSEV |
|
java.lang.String |
getStlaction()
Getter for field STLACTION |
|
ICICSRegionDefinition.StlsevValue |
getStlsev()
Getter for field STLSEV |
|
java.lang.String |
getSysID()
Getter for field SYSID |
|
java.lang.String |
getTdmaction()
Getter for field TDMACTION |
|
ICICSRegionDefinition.TdmsevValue |
getTdmsev()
Getter for field TDMSEV |
|
java.lang.Long |
getTdqsamp()
Getter for field TDQSAMP |
|
java.lang.Long |
getTermsamp()
Getter for field TERMSAMP |
|
java.lang.String |
getTmezone()
Getter for field TMEZONE |
|
java.lang.Long |
getTmezoneo()
Getter for field TMEZONEO |
|
java.lang.Long |
getToprsupd()
Getter for field TOPRSUPD |
|
java.lang.Long |
getTransamp()
Getter for field TRANSAMP |
|
java.lang.Long |
getUpdaters()
Getter for field UPDATERS |
|
ICICSRegionDefinition.WlmoptenValue |
getWlmopten()
Getter for field WLMOPTEN |
|
ICICSRegionDefinition.WlmqmodeValue |
getWlmqmode()
Getter for field WLMQMODE |
|
ICICSRegionDefinition.WlmstatusValue |
getWlmstatus()
Getter for field WLMSTATUS |
|
java.lang.Long |
getWlmthrsh()
Getter for field WLMTHRSH |
Methods inherited from interface com.ibm.cics.model.ICPSMDefinition |
---|
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime |
Methods inherited from interface com.ibm.cics.model.ICICSObject |
---|
getCICSType |
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject |
---|
getAttributeValue |
Method Detail |
---|
ICICSType<ICICSRegionDefinition> getObjectType()
getObjectType
in interface ICICSObject
getObjectType
in interface ICPSMDefinition
getObjectType
in interface IDefinition
getObjectType
in interface com.ibm.cics.model.meta.ITypedObject
java.lang.String getName()
CICS system definition name
The 1- to 8-character name for the CICS system to be associated with the CICSplex identified as the context.
getName
in interface ICICSObject
ICICSRegionDefinition.DynrouteValue getDynroute()
Target region active at startup
Indicates whether or not this CICS system is to be active as a target region and accept work for the workload for which it is a target at CICS startup.
The Target region in active workload (EYUSTARTWLMAWAOR) view may be used to Activate or Quiesce target regions in a workload.
A target region would normally have this option set to YES. A routing region may have this option set to YES, if it is also acting as a target region in the workload.
java.lang.Long getRetention()
Time data is kept after monitoring stops (minutes)
The number of minutes collected data is to be kept after resource monitoring stops. (Resource monitoring stops when the CICS system stops or when the MAS view command is used to stop resource monitoring for the CICS system.) The retention period can be:
java.lang.Long getCicssamp()
Sample interval for CICS region monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getGlblsamp()
Sample interval for global region monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getDbxsamp()
Sample interval for DB2/DBCTRL monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getConnsamp()
Sample interval for connection monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getFilesamp()
Sample interval for file monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getJrnlsamp()
Sample interval for journal monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getProgsamp()
Sample interval for program monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getTermsamp()
Sample interval for terminal monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getTdqsamp()
Sample interval for TDQ monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
java.lang.Long getTransamp()
Sample interval for transaction monitoring
The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.
ICICSRegionDefinition.MonstatusValue getMonstatus()
Monitoring status
Indicates whether resource monitoring is to be active when this CICS system is started. Specify:
ICICSRegionDefinition.RtastatusValue getRtastatus()
Real time analysis status
Indicates whether or not the system availability monitoring (SAM) and MAS resource monitoring (MRM) components of real-time analysis are to be active when this CICS system is started.
ICICSRegionDefinition.WlmstatusValue getWlmstatus()
Routing region active at startup
Indicates whether or not this CICS system is to participate in its associated workload as a routing region when the CICS system is started. Options are:
Use the WLM specifications to CICS systems link (EYUSTARTLNKSWSCS) view, the WLM specifications to CICS system group links (EYUSTARTLNKSWSCG) view, or Workload management Map function to identify the associated workload. If the CICS system is not associated with a workload, it will not be activated as a routing region.
A routing region would normally have this option set to YES. A target region must also have this option set to YES, if it is to receive requests using the CICS distributed routing model (DSRTPGM).
ICICSRegionDefinition.SeccmdchkValue getSeccmdchk()
Simulated CICS-command security checking status
Indicates whether or not CICSPlex SM security checking is to simulate CICS command checking for this CICS system. Specify:
ICICSRegionDefinition.SecreschkValue getSecreschk()
Simulated CICS-resource security checking status
Indicates whether CICSPlex SM security checking is to simulate CICS resource checking for this CICS system. Specify:
ICICSRegionDefinition.SecbypassValue getSecbypass()
Exemption from simulated security checks
Indicates whether CICSPlex SM Exemption security is active for this CICS system. Exemption security allows simulated CICS security checks to be bypassed.
ICICSRegionDefinition.SamsevValue getSamsev()
Severity for system availability monitoring event
The severity level that is to be associated with the named condition. The options are:
Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.
ICICSRegionDefinition.SossevValue getSossev()
Severity for short-on-storage (SOS) event
The severity level that is to be associated with the named condition. The options are:
Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.
ICICSRegionDefinition.SdmsevValue getSdmsev()
Severity for system dump event
The severity level that is to be associated with the named condition. The options are:
Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.
ICICSRegionDefinition.TdmsevValue getTdmsev()
Severity for transaction dump event
The severity level that is to be associated with the named condition. The options are:
Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.
ICICSRegionDefinition.MxtsevValue getMxtsev()
Severity for CICS-at-maximum-tasks event
The severity level that is to be associated with the named condition. The options are:
Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.
ICICSRegionDefinition.StlsevValue getStlsev()
Severity for CICS-stalled event
The severity level that is to be associated with the named condition. The options are:
Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.
java.lang.String getSamaction()
Action for system availability monitoring event
The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.
java.lang.String getSosaction()
Action for short on storage (SOS) event
The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.
java.lang.String getSdmaction()
Action for system dump event
The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.
java.lang.String getTdmaction()
Action for transaction dump event
The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.
java.lang.String getMxtaction()
Action for CICS-at-maximum-tasks event
The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.
java.lang.String getStlaction()
Action for CICS-stalled event
The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.
java.lang.String getPricmas()
Primary CMAS name
The name of the CMAS that is assigned the task of monitoring the availability of this CICS system. When the CICS system is part of a CICSplex that is managed by a single CMAS, specify the name of that CMAS. When multiple CMASs participate in managing the CICSplex, identify the CMAS to which the CICS system normally connects. Naming a CMAS does not prevent the CICS system from connecting to another CMAS when, for example, the primary CMAS is not available.
java.lang.String getActvtime()
Period definition name
The name of the period definition that identifies the hours during which this CICS system is to be running.
java.lang.String getDescription()
Description
A 1 to 58-character description of the CICS system definition.
java.lang.Long getTmezoneo()
Time zone offset
The adjustment value that is to be applied to the computed time. This value is used to resolve time references in areas that do not use a standard zone. Specify:
java.lang.String getTmezone()
Time zone
The time zone in which this CICS system is located. Specify:
ICICSRegionDefinition.DaylghtsvValue getDaylghtsv()
Daylight saving time in effect
Indicates whether you are currently recognizing daylight saving time. Specify:
java.lang.String getApplID()
Application ID
The application ID of a CICS system is the name by which it is known in the intercommunication network; that is, its netname.
ICICSRegionDefinition.AutoinstValue getAutoinst()
Install BAS resources option
Indicates whether resources associated with the system through a resource description should be automatically installed when the MAS connects to the CMAS:
ICICSRegionDefinition.AinsfailValue getAinsfail()
BAS install failure action
Indicates the action to be taken in the event of a BAS install failure. Options are:
java.lang.String getSysID()
System ID
The 4-character system ID of the CICS system. The value specified must match the CICS SYSIDNT SIT operand or override.
java.lang.String getNetworkID()
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.
java.lang.String getHost()
Host name
The 116-character host name of the system decimal IPv4 address (for example, 9.20.181.3), or its colon hexadecimal IPv6 address (for example ABCD:EF01::2345:6789). If an IPv4 address is entered as an IPv4 compatible IPv6 address (deprecated) or an IPv4 mapped IPv6 address (for example ::FFFF:1.2.3.4) it is converted to a standard IPv4 dotted decimal address. IPv6 addresses should not be used for CICS Transaction Server for z/OS, Version 3 Release 2 and earlier releases. This is used for IPIC SYSLINK connections.
java.lang.Long getPort()
Port number
This is used by IPIC SYSLINK processing to override the TCPIPSERVICE port number on which inbound requests are received. Valid values are a decimal number in the range of 1 to 65535.
java.lang.Long getReadrs()
RS server read interval
Within a workload running in optimized mode, this value specifies the minimum interval between target region status refreshes that a routing region would request from the CICS CFDT server. This value will be used to override the default interval value specified in CICSplex definition, which is the parent of this CICS system definition.
The value range is from 0 to 2000 or INHERIT, and represents units of milliseconds:
A low value mean that the router will refresh a target's status from the RS server more often 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 will be applied the next time this CICS region is started. If you want the change to be applied to a running instance of this CICS region, then it may be changed in-flight using the MAS views.
java.lang.Long getUpdaters()
RS server update frequency
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 value will be used to override the default frequency value specified in CICSplex definition, which is the parent of this CICS system definition.
The value range is from 0 to 25, or INHERIT:
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 coupling facility.
The value specified here will be applied the next time this CICS region is started. If you want the change to be applied to a running instance of this CICS region, then it may be changed in-flight using the MAS views.
java.lang.String getMpcmasid()
Maintenance point CMAS id
This is an output only field, identifying the maintenance point CMAS for the CICSplex. It is required to enable the Hyperlinks on the UPDATERS and READRS attributes.
java.lang.String getContext()
CSYSDEF context
This is an output only field, identifying the CICSplex context for a query. It is required to enable the Hyperlinks on the UPDATERS and READRS attributes.
java.lang.Long getToprsupd()
RS 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. This value will be used to override the default value specified in CICSplex definition, which is the parent of this CICS system definition.
The value range is from 1 to 25, or INHERIT.
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. Any change to this value will be applied at the next region startup.
java.lang.Long getBotrsupd()
RS 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, or INHERIT.
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. Any change to this value will be applied at the next region startup.
java.lang.Long getWlmthrsh()
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 60. The value specified here will be applied the next time this CICS region is started.
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.
ICICSRegionDefinition.WlmqmodeValue getWlmqmode()
Task load queue mode
This attribute is used by CICSPlex SM Workload Manager. This value specifies how the queued task load of a target CICS region is to be evaluated:
The default value is ALL. Any change to this value will be applied at the next region startup.
ICICSRegionDefinition.WlmoptenValue getWlmopten()
WLM optimization enablement
This attribute controls the enablement of the optimized dynamic routing function.
When set to ENABLED, the region will attempt to connect to the CICS Region Status server when the CICSplex SM workload management agent starts. If that connection is successful, then the region will be eligible to participate in optimized workload routing requests.
If this attribute is set to DISABLED, then the region will not connect to the Region Status server when it starts, and optimized dynamic workload routing requests will be suppressed.
The setting of this definition may be overridden at runtime through the MAS views.
ICICSRegionDefinition.NrmsevValue getNrmsev()
Severity for Non-responsive-MAS event
The severity level that is to be associated with the named condition. The options are:
Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.
java.lang.String getNrmaction()
Action for Non-responsive-MAS event
The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.
ICICSRegionDefinition.CreateOriginValue getCreateOrigin()
Definition origin
Identifies where the definition originated:
ICICSRegionDefinitionReference getCICSObjectReference()
getCICSObjectReference
in interface ICICSObject
getCICSObjectReference
in interface ICPSMDefinition
getCICSObjectReference
in interface IDefinition
<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ICICSRegionDefinition> referenceAttribute)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |