Interface IManagedRegion
-
- All Superinterfaces:
ICICSObject
,ICPSMManager
,com.ibm.cics.model.meta.ITypedObject
public interface IManagedRegion extends ICPSMManager
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IManagedRegion.AinsfailValue
Enumeration type for field AINSFAILstatic class
IManagedRegion.AutoinstValue
Enumeration type for field AUTOINSTstatic class
IManagedRegion.DaylightSavingValue
Enumeration type for field DAYLGHTSVstatic class
IManagedRegion.MonitoringStatusValue
Enumeration type for field MONSTATUSstatic class
IManagedRegion.MxtsevValue
Enumeration type for field MXTSEVstatic class
IManagedRegion.NrmsevValue
Enumeration type for field NRMSEVstatic class
IManagedRegion.RTAStatusValue
Enumeration type for field RTASTATUSstatic class
IManagedRegion.SamsevValue
Enumeration type for field SAMSEVstatic class
IManagedRegion.SdmsevValue
Enumeration type for field SDMSEVstatic class
IManagedRegion.SecbypassValue
Enumeration type for field SECBYPASSstatic class
IManagedRegion.SeccmdchkValue
Enumeration type for field SECCMDCHKstatic class
IManagedRegion.SecreschkValue
Enumeration type for field SECRESCHKstatic class
IManagedRegion.SossevValue
Enumeration type for field SOSSEVstatic class
IManagedRegion.StateValue
Enumeration type for field CICSSTATEstatic class
IManagedRegion.StlsevValue
Enumeration type for field STLSEVstatic class
IManagedRegion.TdmsevValue
Enumeration type for field TDMSEVstatic class
IManagedRegion.TypeValue
Enumeration type for field MASTYPEstatic class
IManagedRegion.WlmoptenValue
Enumeration type for field WLMOPTENstatic class
IManagedRegion.WlmqmodeValue
Enumeration type for field WLMQMODEstatic class
IManagedRegion.WLMStatusValue
Enumeration type for field WLMSTATUS
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICPSMManager
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getActvtime()
Getter for field ACTVTIMEIManagedRegion.AinsfailValue
getAinsfail()
Getter for field AINSFAILjava.lang.String
getApplid()
Getter for field APPLIDIManagedRegion.AutoinstValue
getAutoinst()
Getter for field AUTOINSTjava.lang.String
getBastrace()
Getter for field BASTRACEjava.lang.Long
getBotrsupd()
Getter for field BOTRSUPDjava.lang.String
getChetrace()
Getter for field CHETRACEIManagedRegionReference
getCICSObjectReference()
java.lang.String
getCMASName()
Getter for field CMASNAMEjava.lang.String
getComtrace()
Getter for field COMTRACEjava.lang.Long
getConnectionSampleInterval()
Getter for field CONNSAMPjava.lang.String
getCpsmver()
Getter for field CPSMVERjava.lang.String
getDattrace()
Getter for field DATTRACEIManagedRegion.DaylightSavingValue
getDaylightSaving()
Getter for field DAYLGHTSVjava.lang.Long
getDB2SampleInterval()
Getter for field DBXSAMPjava.lang.String
getDescription()
Getter for field DESCjava.lang.Long
getFileSampleInterval()
Getter for field FILESAMPjava.lang.Long
getGlobalSampleInterval()
Getter for field GLBLSAMPjava.lang.String
getHost()
Getter for field HOSTjava.lang.Long
getJournalSampleInterval()
Getter for field JRNLSAMPjava.lang.String
getKernelTrace()
Getter for field KNLTRACEjava.lang.String
getMASTrace()
Getter for field MASTRACEjava.lang.String
getMessageTrace()
Getter for field MSGTRACEIManagedRegion.MonitoringStatusValue
getMonitoringStatus()
Getter for field MONSTATUSjava.lang.String
getMxtaction()
Getter for field MXTACTIONIManagedRegion.MxtsevValue
getMxtsev()
Getter for field MXTSEVjava.lang.String
getName()
Getter for field CICSNAMEjava.lang.String
getNetworkid()
Getter for field NETWORKIDjava.lang.String
getNrmaction()
Getter for field NRMACTIONIManagedRegion.NrmsevValue
getNrmsev()
Getter for field NRMSEVICICSType<IManagedRegion>
getObjectType()
java.lang.Long
getPort()
Getter for field PORTjava.lang.String
getPrimaryCMAS()
Getter for field PRICMASjava.lang.Long
getProgramSampleInterval()
Getter for field PROGSAMPjava.lang.String
getQuetrace()
Getter for field QUETRACEjava.lang.Long
getReadrs()
Getter for field READRSjava.lang.Long
getRetention()
Getter for field RETENTIONIManagedRegion.RTAStatusValue
getRTAStatus()
Getter for field RTASTATUSjava.lang.String
getRtatrace()
Getter for field RTATRACEjava.lang.String
getSamaction()
Getter for field SAMACTIONjava.lang.Long
getSampleInterval()
Getter for field CICSSAMPIManagedRegion.SamsevValue
getSamsev()
Getter for field SAMSEVjava.lang.String
getSdmaction()
Getter for field SDMACTIONIManagedRegion.SdmsevValue
getSdmsev()
Getter for field SDMSEVIManagedRegion.SecbypassValue
getSecbypass()
Getter for field SECBYPASSIManagedRegion.SeccmdchkValue
getSeccmdchk()
Getter for field SECCMDCHKIManagedRegion.SecreschkValue
getSecreschk()
Getter for field SECRESCHKjava.lang.String
getServicesTrace()
Getter for field SRVTRACEjava.lang.String
getSosaction()
Getter for field SOSACTIONIManagedRegion.SossevValue
getSossev()
Getter for field SOSSEVIManagedRegion.StateValue
getState()
Getter for field CICSSTATEjava.lang.String
getStlaction()
Getter for field STLACTIONIManagedRegion.StlsevValue
getStlsev()
Getter for field STLSEVjava.lang.String
getTdmaction()
Getter for field TDMACTIONIManagedRegion.TdmsevValue
getTdmsev()
Getter for field TDMSEVjava.lang.Long
getTDQSampleInterval()
Getter for field TDQSAMPjava.lang.Long
getTerminalSampleInterval()
Getter for field TERMSAMPjava.lang.String
getTimeZone()
Getter for field TMEZONEjava.lang.Long
getTimeZoneOffset()
Getter for field TMEZONEOjava.lang.Long
getToprsupd()
Getter for field TOPRSUPDjava.lang.String
getToptrace()
Getter for field TOPTRACEjava.lang.Long
getTransactionSampleInterval()
Getter for field TRANSAMPjava.lang.String
getTratrace()
Getter for field TRATRACEIManagedRegion.TypeValue
getType()
Getter for field MASTYPEjava.lang.Long
getUpdaters()
Getter for field UPDATERSIManagedRegion.WlmoptenValue
getWlmopten()
Getter for field WLMOPTENIManagedRegion.WlmqmodeValue
getWlmqmode()
Getter for field WLMQMODEIManagedRegion.WLMStatusValue
getWLMStatus()
Getter for field WLMSTATUSjava.lang.Long
getWlmthrsh()
Getter for field WLMTHRSHjava.lang.String
getWLMTrace()
Getter for field WLMTRACE-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICPSMManager
getCICSContainer
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IManagedRegion> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceICPSMManager
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field CICSNAMECICS 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 interfaceICICSObject
-
getCMASName
java.lang.String getCMASName()
Getter for field CMASNAMECMAS name
The name of a CMAS that participates in the management of the specified MAS.
-
getType
IManagedRegion.TypeValue getType()
Getter for field MASTYPEMAS type
The type of relationship that exists between this MAS and the specified CMAS:
- LOCAL - The MAS resides in the same MVS image as the CMAS and uses the CICSPlex SM ESSS facility to communicate with it.
- REMOTE - The MAS is a stand-alone CICS region (SMSS).
- N_A - The MAS is not currently active; its type cannot be determined.
-
getState
IManagedRegion.StateValue getState()
Getter for field CICSSTATEMAS 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:
- The Stop action was used to stop the MAS agent
- The CICS system itself is inactive, but is still known
If this field is blank, the MAS is temporarily between an inactive and active state.
-
getMonitoringStatus
IManagedRegion.MonitoringStatusValue getMonitoringStatus()
Getter for field MONSTATUSMonitoring status
Indicates whether resource monitoring is active in this MAS. The valid values are:
- YES
- Resource monitoring is active in this MAS.
- NO
- Resource monitoring is inactive in this MAS. If the MAS has just been initialized or has been updated to turn monitoring on, this value is displayed until monitoring is fully initialized.
- N_A
- The MAS is not connected to its CMAS (the MAS Status field shows INACTIVE).
- FORCE
- To stop resource monitoring even if it is being used by real-time analysis. All resource monitoring will stop. If an evaluation definition names a monitor table resource, that evaluation definition becomes inactive.
Note: For Monitoring to become fully initialized the MAS must have a Monitoring Specification associated with it.
-
getRTAStatus
IManagedRegion.RTAStatusValue getRTAStatus()
Getter for field RTASTATUSReal time analysis status
Indicates whether real time analysis (RTA) is active in this MAS. The valid values are:
- YES
- System availability monitoring and MAS resource monitoring are active.
- NO
- No RTA monitoring is active. If the MAS has just been initialized or has been updated to turn analysis on, NO is displayed until RTA is fully initialized.
- SAM
- System availability monitoring is active.
- MRM
- MAS resource monitoring is active.
- N_A
- The MAS is not connected to its CMAS (the MAS Status field shows INACTIVE).
Note: For Real time analysis to become fully initialized the MAS must have a Real time analysis Specification associated with it.
-
getWLMStatus
IManagedRegion.WLMStatusValue getWLMStatus()
Getter for field WLMSTATUSWorkload manager status
Indicates whether the workload manager (WLM) is active in this MAS. The valid values are:
- YES
- The workload manager (WLM) is active in this MAS.
- NO
- The workload manager (WLM) is inactive in this MAS. If the MAS has just been initialized or has been updated to turn workload management on, this value is displayed until WLM is fully initialized.
- N_A
- The MAS is not connected to its CMAS (the MAS Status field shows INACTIVE).
Note: For the workload manager to become fully initialized the MAS must have a workload manager Specification associated with it.
-
getRetention
java.lang.Long getRetention()
Getter for field RETENTIONMonitoring data retention period
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:
- 1 - 1440
- Collected data is to be kept the specified number of minutes.
- 0
- Collected data is not to be kept.
-
getSampleInterval
java.lang.Long getSampleInterval()
Getter for field CICSSAMPSample 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 0 means that no resource monitoring is to occur.
-
getGlobalSampleInterval
java.lang.Long getGlobalSampleInterval()
Getter for field GLBLSAMPSample 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 0 means that no resource monitoring is to occur.
-
getDB2SampleInterval
java.lang.Long getDB2SampleInterval()
Getter for field DBXSAMPSample 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 0 means that no resource monitoring is to occur.
-
getConnectionSampleInterval
java.lang.Long getConnectionSampleInterval()
Getter for field CONNSAMPSample 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 0 means that no resource monitoring is to occur.
-
getFileSampleInterval
java.lang.Long getFileSampleInterval()
Getter for field FILESAMPSample 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 0 means that no resource monitoring is to occur.
-
getJournalSampleInterval
java.lang.Long getJournalSampleInterval()
Getter for field JRNLSAMPSample 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 0 means that no resource monitoring is to occur.
-
getProgramSampleInterval
java.lang.Long getProgramSampleInterval()
Getter for field PROGSAMPSample 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 0 means that no resource monitoring is to occur.
-
getTerminalSampleInterval
java.lang.Long getTerminalSampleInterval()
Getter for field TERMSAMPSample 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 0 means that no resource monitoring is to occur.
-
getTDQSampleInterval
java.lang.Long getTDQSampleInterval()
Getter for field TDQSAMPSample 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 0 means that no resource monitoring is to occur.
-
getTransactionSampleInterval
java.lang.Long getTransactionSampleInterval()
Getter for field TRANSAMPSample 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 0 means that no resource monitoring is to occur.
-
getKernelTrace
java.lang.String getKernelTrace()
Getter for field KNLTRACEKernel linkage trace flags
The kernel linkage trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getTratrace
java.lang.String getTratrace()
Getter for field TRATRACETrace services trace flags
The trace services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getMessageTrace
java.lang.String getMessageTrace()
Getter for field MSGTRACEMessage services trace flags
The message services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getServicesTrace
java.lang.String getServicesTrace()
Getter for field SRVTRACECommon services trace flags
The external services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getChetrace
java.lang.String getChetrace()
Getter for field CHETRACECache services trace flags
The cache services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getQuetrace
java.lang.String getQuetrace()
Getter for field QUETRACEQueue services trace flags
The queue services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getComtrace
java.lang.String getComtrace()
Getter for field COMTRACECommunications trace flags
The communications trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getMASTrace
java.lang.String getMASTrace()
Getter for field MASTRACEMAS services trace flags
The MAS services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getWLMTrace
java.lang.String getWLMTrace()
Getter for field WLMTRACEWorkload management trace flags
The workload management trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getToptrace
java.lang.String getToptrace()
Getter for field TOPTRACETopology trace flags
The topology trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getRtatrace
java.lang.String getRtatrace()
Getter for field RTATRACEReal time analysis (RTA) trace flags
The real time analysis trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getDattrace
java.lang.String getDattrace()
Getter for field DATTRACEData repository services trace flags
The data repository services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getBastrace
java.lang.String getBastrace()
Getter for field BASTRACEBusiness Application Services (BAS) trace flags
Business Application Services trace flag settings.
Alter trace flag settings only when asked to by IBM System Support center personnel.
-
getSeccmdchk
IManagedRegion.SeccmdchkValue getSeccmdchk()
Getter for field SECCMDCHKSimulated security command check
Indicates whether or not CICSPlex SM security checking is to simulate CICS command checking for this CICS system. Specify:
- YES - Simulate CICS security checking for this CICS system.
- NO - Do not simulate CICS security checking for this CICS system.
- INHERIT - Use the value assigned to the CICSplex with which this CICS system is associated.
- N_A - Not applicable.
-
getSecreschk
IManagedRegion.SecreschkValue getSecreschk()
Getter for field SECRESCHKSimulated security resource check
Indicates whether CICSPlex SM security checking is to simulate CICS command checking for this CICS system. Specify:
- YES - Simulate CICS security checking for this CICS system.
- NO - Do not simulate CICS security checking for this CICS system.
- INHERIT (asterisk) - Use the value assigned to the CICSplex with which this CICS system is associated.
-
getSecbypass
IManagedRegion.SecbypassValue getSecbypass()
Getter for field SECBYPASSSimulated security exemption check
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 (asterisk) - Use the value assigned to the CICSplex with which this CICS system is associated.
- N_A - Not applicable.
-
getSamsev
IManagedRegion.SamsevValue getSamsev()
Getter for field SAMSEVSeverity for system availability monitoring event
The severity level that is to be associated with the named condition. The severity codes are: VLS, LS, LW, HW, HS, or VHS. Specify N_A to exclude this condition from monitoring.
-
getSossev
IManagedRegion.SossevValue getSossev()
Getter for field SOSSEVSeverity for short on storage (SOS) event
The severity level that is to be associated with the named condition. The severity codes are: VLS, LS, LW, HW, HS, or VHS. Specify N_A to exclude this condition from monitoring.
-
getSdmsev
IManagedRegion.SdmsevValue getSdmsev()
Getter for field SDMSEVSeverity for system dump event
The severity level that is to be associated with the named condition. The severity codes are: VLS, LS, LW, HW, HS, or VHS. Specify N_A to exclude this condition from monitoring.
-
getTdmsev
IManagedRegion.TdmsevValue getTdmsev()
Getter for field TDMSEVSeverity for transaction dump event
The severity level that is to be associated with the named condition. The severity codes are: VLS, LS, LW, HW, HS, or VHS. Specify N_A to exclude this condition from monitoring.
-
getMxtsev
IManagedRegion.MxtsevValue getMxtsev()
Getter for field MXTSEVSeverity for CICS-at-maximum-tasks event
The severity level that is to be associated with the named condition. The severity codes are: VLS, LS, LW, HW, HS, or VHS. Specify N_A to exclude this condition from monitoring.
-
getStlsev
IManagedRegion.StlsevValue getStlsev()
Getter for field STLSEVSeverity for CICS-stalled event
The severity level that is to be associated with the named condition. The severity codes are: VLS, LS, LW, HW, HS, or VHS. Specify N_A to exclude this condition from monitoring.
-
getSamaction
java.lang.String getSamaction()
Getter for field SAMACTIONAction for system availability monitoring event
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getSosaction
java.lang.String getSosaction()
Getter for field SOSACTIONAction for short on storage (SOS) event
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getSdmaction
java.lang.String getSdmaction()
Getter for field SDMACTIONAction for system dump event
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getTdmaction
java.lang.String getTdmaction()
Getter for field TDMACTIONAction for transaction dump event
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getMxtaction
java.lang.String getMxtaction()
Getter for field MXTACTIONAction for CICS-at-maximum-tasks event
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getStlaction
java.lang.String getStlaction()
Getter for field STLACTIONAction for CICS-stalled event
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getPrimaryCMAS
java.lang.String getPrimaryCMAS()
Getter for field PRICMASPrimary CMAS name
The name of the CMAS that is assigned the task of monitoring the availability of this CICS system.
-
getActvtime
java.lang.String getActvtime()
Getter for field ACTVTIMEPeriod definition name
The name of the period definition that identifies the hours during which this CICS system is to be running.
-
getDescription
java.lang.String getDescription()
Getter for field DESCCICS system description
A description of the CICS system.
-
getTimeZoneOffset
java.lang.Long getTimeZoneOffset()
Getter for field TMEZONEOTime 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:
- A value between 0 and 59 to identify the number of minutes to be added to the time for that time zone (for areas that do not use a standard time zone).
- INHERIT - Inherit the time zone offset assigned to the CMAS to which this CICS system is connected, or the primary CMAS, if the CICS system is inactive
-
getTimeZone
java.lang.String getTimeZone()
Getter for field TMEZONETime zone
The time zone in which this CICS system is located. Specify:
- A code in the range B through Z.
- INHERIT - Inherit the time zone offset assigned to the CMAS to which this CICS system is connected, or the primary CMAS, if the CICS system is inactive.
-
getDaylightSaving
IManagedRegion.DaylightSavingValue getDaylightSaving()
Getter for field DAYLGHTSVDaylight saving time in effect
Indicates whether you are currently recognizing daylight saving time. Specify:
- YES - Recognize daylight saving time.
- NO - Do not recognize daylight saving time.
- INHERIT - Use the value assigned to the daylight time indicator assigned to the CMAS to which this CICS system is connected, or the primary CMAS, if the CICS system is inactive.
- N_A - Not applicable.
-
getAutoinst
IManagedRegion.AutoinstValue getAutoinst()
Getter for field AUTOINSTAutoinstall request type
Indicates whether resources associated with the system through a resource description should be automatically installed when the MAS connects to the CMAS:
- ALWAYS - Install resources every time the MAS connects after a CICS startup.
- COLDONLY - Install resources only when the MAS connects after a CICS INITIAL or COLD start.
- NEVER - Resources should never be automatically installed in this CICS system.
- WARMONLY - Install resources only when the MAS connects after a CICS warm start or emergency restart (AUTO).
-
getAinsfail
IManagedRegion.AinsfailValue getAinsfail()
Getter for field AINSFAILAutoinstall failure action
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getHost
java.lang.String getHost()
Getter for field HOSTHost 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 NETWORKIDNetwork 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 PORTPort 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 READRSRS 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 0 means that a routing region will request a status update of this region on every occasion that it examines this region's status.
- Values between 1 and 2000 specify the minimum millisecond time interval that must expire
before this region's status data can be refreshed.
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
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 UPDATERSRS 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:
- 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 this CICS region.
- 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 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.
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 TOPRSUPDRS 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.
- A value of INHERIT means assign the value that is specified for this attribute in the parent CICSplex definition (CPLEXDEF) object for this CICS region. This is the default setting for this attribute.
- Values between 1 and 25 are 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 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 BOTRSUPDRS 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.
- A value of INHERIT means assign the value that is specified for this attribute in the parent CICSplex definition (CPLEXDEF) object for this CICS region. This is the default setting for this attribute.
- Values between 1 and 25 are applied as an arithmetic percentage to a region's MAXTASKS setting. The task count value from zero up to this value is deemed to be the task load bottom tier. If the task load in a region falls into this range, then it will be broadcast to the coupling facility for every change in the load. Once the load reaches this value, then the RS server update frequency task rules will be activated.
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 WLMTHRSHTask 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. 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.
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.
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 WLMQMODETask 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:
- MAXTASK - specifies that both active and MAXTASK queued tasks are to be included in the task load evaluation for the region.
- ALL - specifies that the task load evaluation for the region will include active tasks, tasks queued for the MAXTASK limit and tasks that are queued because of a TRANCLASS limit.
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 WLMOPTENWLM 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.
-
getNrmsev
IManagedRegion.NrmsevValue getNrmsev()
Getter for field NRMSEVSeverity for Non-responsive-MAS event
The severity level that is to be associated with the named condition. The severity codes are: VLS, LS, LW, HW, HS, or VHS. Specify N_A to exclude this condition from monitoring.
-
getNrmaction
java.lang.String getNrmaction()
Getter for field NRMACTIONAction for Non-responsive-MAS event
The name of the action definition to be used when generating notification about the named condition. Specify inherit to derive the action definition action from the analysis specification.
-
getCpsmver
java.lang.String getCpsmver()
Getter for field CPSMVERCPSM version of MAS
The CICSPlex SM version of the current MAS.
-
getApplid
java.lang.String getApplid()
Getter for field APPLIDCICS system APPLID
The current APPLID of this CICS system, if active.
-
getCICSObjectReference
IManagedRegionReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICPSMManager
-
-