Server state protocol command

The state data for the server state protocol command is mapped by the TMAMHDR DSECT of the DFSYMSG macro.

The server state protocol command is used by OTMA both to notify the OTMA client about the current state or a change in the state of IMS processing and as a heartbeat message, which is issued at 60 second intervals.

The server state protocol command is identified by X'3C' in the command type field (TMAMCTYP) of the message control information section of the OTMA header.

The following table summarizes the format of state data for the server state protocol command. The summary includes byte, length, content, hexadecimal value, the meaning, and includes usage comments.

Table 1. Server state protocol command format
Dec offset Hex offset Length Field name Value and description
0 X'00' 2 TMAMHLEN Length of the state-data section, including the length field itself.
2 X'02' 2 TMAMRSIM_STATUS The state of OTMA resources in the server.
X'03' - Normal state
IMS is available and processing OTMA messages normally.
X'02' - Degraded state
IMS is processing OTMA messages slowly. OTMA issues a degraded state protocol command when one or more conditions indicate that IMS is not processing OTMA messages as quickly as it should.
X'01' - Unavailable state
IMS can no longer accept OTMA transactions for processing. OTMA issues the unavailable state protocol command to alert the OTMA client that one or more severe conditions prevent IMS from processing OTMA messages.
4 X'04' 1 TMAMRSIM_SVRFLG1 Flags for resource in the first group of unavailable resources.
X'80' - TMAMRSIM_S1SHTDN
The IMS server is shutting down and no longer available.
5 X'05' 1 TMAMRSIM_SVRFLG2 Reserved
6 X'06' 1 TMAMRSIM_SVRFLG3 Reserved
7 X'07' 1 TMAMRSIM_SVRFLG4 Flags for resource in the fourth group of unavailable resources.
X'01' - TMAMRSIM_S4FLOOD
The server is flooded with OTMA messages that are waiting to be processed and is no longer available.
8 X'08' 1 TMAMRSIM_WRNFLG1 Flags for resources in the first group of degraded resources.
X'80' - TMAMRSIM_W1FLOOD
Global flood warning for all OTMA clients
X'40' - TMAMRSIM_W1MTP
Warning for OTMA clients that specify a maximum allowable number of tpipes: the total number of tpipes has reached the global warning threshold defined by the highest value specified on the MAXTP parameter of any OTMA client descriptor.
X'20' - TMAMRSIM_W1MTPF
The MAXTP limit defined by the DFSOTMA client descriptor entry was reached. Subsequent requests for new tpipes from all OTMA clients are rejected. An exception to this is when MAXTPBE=NO is defined for a backend IMS system for application GU processing in a shared queues environment.
X'10' - TMAMRSIM_W1MTP80
The number of tpipes in the IMS system reached eighty percent of the global tpipe limit that is defined by the MAXTP parameter in the DFSOTMA system client descriptor.
9 X'09' 1 TMAMRSIM_WRNFLG2 Reserved
10 X'0A' 1 TMAMRSIM_WRNFLG3 Reserved
11 X'0B' 1 TMAMRSIM_WRNFLG4 Flags for resources in the fourth group of degraded resources.
X'08' - TMAMRSIM_W5MTP
The number of tpipes for this OTMA client has reached the maximum allowable number of tpipes set for this client on the MAXTP parameter of the OTMA client descriptor. No new tpipes can be created for this OTMA client until the number of tpipes drops.
X'04' - TMAMRSIM_W4MTP
The number of tpipes for this OTMA client has reached 80% of the maximum allowable number of tpipes set for this client on the MAXTP parameter of the OTMA client descriptor.
X'02' - TMAMRSIM_AWE
Message AWE reaches 80% flood
X'01' - TMAMRSIM_W4FLOOD
Flood warning for this client only. The number of OTMA messages waiting to be processed on the server is at eighty percent of the maximum allowable number defined for the server.
12 X'0C' 1 TMAMRSIM_NRSFLGS Other flags for non-resource related indicators.
X'80' - TMAMRSIM_HB60S
Identifies this message as a heartbeat message. The server is available and resource usage is within normal limits. Heartbeat messages are sent every 60 seconds.
13 X'0D' 3 Reserved  
16 X'10' 16 TMAMRSIM_SRVNAME The 16 character z/OS® cross-system coupling facility (XCF) member name of the OTMA server.
32 X'20' 16 TMAMRSIM_CLTNAME The 16 character XCF member name of the OTMA client.
48 X'30' 20 Reserved  
68 X'44' 12 TMAMRSIM_UTC UTC time for this message