UPDATE IMSCON TYPE(IMSPLEX) command
Use the UPDATE IMSCON TYPE(IMSPLEX) command to start or stop communication between IMS Connect and the specified IMSplex.
Subsections:
Environment
- IMS Connect must be active and configured to communicate with the Common Service Layer (CSL) Structured Call Interface (SCI).
- A type-2 command environment with Structured Call Interface (SCI) and Operations Manager (OM) must be active.
Syntax
Keywords
The following keywords are valid for the UPDATE IMSCON TYPE(IMSPLEX) command.
- NAME
- Specifies the name of the IMSplex. This name must be defined to the IMS Connect through the configuration member HWSCFGxx. In addition, this name must match the TMEMBER that is defined in the IMSplex configuration statement.
- START(COMM) | STOP(COMM)
- Mutually exclusive keywords that you use to start or stop communication
with the IMSplex.
- START(COMM)
- Starts communication with the IMSplex. Use this command to reestablish
communication with the IMSplex that is communicating with OM or ODBM
if communication between IMS Connect
and the IMSplex fails. For example, use this command to restart communication
when all activities for the IMSplex in the IMS Connect are terminated, or after an UPDATE
IMSCON TYPE(IMSPLEX) STOP(COMM) command terminated communication
with the IMSplex.
Type-2 commands require that communication between IMS Connect and the IMSplex of which OM is a member is already established. Therefore, the UPDATE IMSCON TYPE(IMSPLEX) START(COMM) command can be used only to start communication between IMS Connect and a different IMSplex. To start communication between IMS Connect and the IMSplex that is used for type-2 command support, use either the WTOR command STARTIP or OPENIP, or the z/OS® command UPDATE IMSPLEX START(COMM).
- STOP(COMM)
Stops communication with the IMSplex. Work currently in progress for the IMSplex is ended and communication with the IMSplex and its threads are terminated. This option can also be used for any error situation that requires immediate termination of communication with the IMSplex.
Note: If you stop communication with the IMSplex that is used for type-2 commands, you will not be able to issue further commands to IMS Connect through OM because the connection to SCI is terminated. To restart communication with the IMSplex, use either the WTOR command STARTIP or OPENIP, or the z/OS command UPDATE IMSPLEX START(COMM).
Usage notes
You can issue the UPDATE IMSCON TYPE(IMSPLEX) command only through the Operations Manager (OM) API.
IMS Connect can process IMS Connect type-2 commands only if the IMSplex from which the commands were issued has a status of ACTIVE.
When the UPDATE IMSCON TYPE(IMSPLEX) NAME(imsplexName) STOP(COMM) is issued, work currently in progress for the IMSplex ends and communication with the IMSplex and its threads are terminated. Any messages in progress are rejected and an error message is returned to the requester. STOPIP can also be used for any error situation that requires immediate termination of communication with the IMSplex.
If IMS Connect supports ISC TCP/IP links and the STOP(COMM) keyword is used, IMS Connect sends a notification to IMS for each ISC link to inform IMS that all of the ISC parallel sessions are terminated on the ISC link.
If IMS Connect supports MSC IMS-to-IMS TCP/IP connections and the STOP(COMM) keyword is used, IMS Connect sends a notification to IMS for each MSC physical link to inform IMS that all of the MSC logical links are terminated on the physical link.
Use the START(COMM) keyword to start communication with the IMSplex at a later time.
Output fields
- Short label
- Contains the short label that is generated in the XML output.
- Long label
- Contains the column heading displayed on the TSO SPOC screen.
- Keyword
- Identifies the keyword on the command that caused the field to be generated. N/A (not applicable) appears for output fields that are always returned. error appears for output fields that are returned only in the case of an error.
- Meaning
- Provides a brief description of the output field.
| Short label | Long label | Keyword | Meaning |
|---|---|---|---|
| CC | CC | N/A | Completion code that indicates whether IMS Connect was able to process the command for the specified resource. The completion code is always returned. See Table 3. |
| CCTXT | CCText | error | Completion code text that briefly explains the meaning of the nonzero completion code. This field is returned only for an error completion code. |
| IMSPLX | IMSplex | N/A | The IMSplex name. The IMSplex name is always returned. |
| MBR | MbrName | N/A | Identifier of the IMS Connect that built the output line. The identifier is always returned. |
Return, reason, and completion codes
The return and reason codes that can be returned as a result of the UPDATE IMSCON TYPE(IMSPLEX) command are standard for all commands entered through the OM API.
The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request.
| Return code | Reason code | Meaning |
|---|---|---|
| X'00000000' | X'00000000' | The UPDATE IMSCON TYPE(IMSPLEX) command completed successfully. The command output contains a line for each resource, accompanied by its completion code. |
| X'0C00000C' | X'00003000' | The command was successful for some resources but failed for others. The command output contains a line for each resource, accompanied by its completion code. |
| X'0C00000C' | X'00003004' | The command was not successful for any resource. The command output contains a line for each resource, accompanied by its completion code. |
Errors unique to the processing of this command are returned as completion codes. A completion code is returned for each action against an individual resource.
| Completion code | Completion code text | Meaning |
|---|---|---|
| 0 | The UPDATE IMSCON TYPE(IMSPLEX) command completed successfully for the resources. | |
| 9 | Data store table create failed | During START(COMM) processing, IMS Connect could
not create a data store table (DST) control block for communication
with the IMSplex. For more information, see the HWSD0212E message that is included in the command reply message. |
| A | TRWB creation failed | The command attempted to create a TWU control
block for the scheduler controller thread, the transmit thread, or
the receive thread for communication with the IMSplex, but the BPECBGET
request failed. The command output might also contain one of the
following messages:
|
| B | Data store table enqueue failed | During START(COMM) processing, IMS Connect attempted
to enqueue a DST control block to the active queue for communication
with the IMSplex, but the request failed. For more information, see the HWSD0212E message that is included in the command reply message. |
| C | Create scheduler thread failed | During START(COMM) processing, IMS Connect attempted
to create the scheduler controller thread for communication with the
IMSplex, but the BPETHDCR request failed. For more information, see the HWSD0212E message that is included in the command reply message. |
| D | Data store is in shutdown | IMS Connect could
not start communication with the IMSplex because communication with
the IMSplex was shutting down. For more information, see the HWSM0522W message that is included in the command reply message. |
| E | Data store block create failed | During START(COMM) processing, IMS Connect could
not start communication with the IMSplex because an attempt to create
a data store block (DSB) for either the transmit or receive thread
for communication with the IMSplex failed. For more information, see the HWSM0522W message that is included in the command reply message. |
| F | Create xmit/recv thread failed | During START(COMM) processing, IMS Connect attempted
to create either the transmit or receive thread for communication
with the IMSplex, but the BPETHDCR request failed. For more information, see the HWSM0522W message that is included in the command reply message. |
| 10 | No resources found | The resource name is unknown to the client that is processing the request. The resource name might have been typed in error or the resource might not be active at this time. If a wildcard was specified in the command, there were no matches for the name. Confirm that the correct spelling of the resource name is specified on the command. |
| 11 | Resource is stopped | During STOP(COMM) processing,IMS Connect could not stop communication with the IMSplex because communication with the IMSplex is already stopped. |
| 12 | Resource is not stopped | During START(COMM) processing, IMS Connect could not start communication with the IMSplex because communication with the IMSplex is not stopped. |
| 1A | BPEGETM error | During START(COMM) processing, IMS Connect failed
to obtain storage from the BPEGETM service. The command output might also contain the following message: HWSI1705W. |
| 2C | IMS Connect is waiting for SCI | During START(COMM) processing, IMS Connect has
detected that SCI is not available for communication with the IMSplex. IMS Connect is
waiting for SCI to become available because ODBMAUTOCONN=Y was specified
in the ODACCESS statement of the HWSCFGxx member of the IMS PROCLIB
data set. The command output might also contain the following message: HWSX0940A. |
| 2D | Deregistration from SCI failed | During START(COMM) processing, IMS Connect encountered
an error when it attempted to deregister from SCI for communication
with the IMSplex. The command output might also contain the following message: HWSI1815W. |
| 2E | Registration to SCI failed | During START(COMM) processing, IMS Connect encountered
an error when it attempted to register with SCI for communication
with the IMSplex. The command output might also contain the following message: HWSI1720W. |
| 2F | SCI is not available | During START(COMM) processing, IMS Connect has
detected that SCI is not available for communication with the IMSplex. The command output might also contain the following message: HWSI1816W. |
Equivalent WTOR and z/OS commands
The following table lists IMS Connect WTOR (Write to Operator with Reply) and IMS Connect z/OS commands that perform similar functions as the UPDATE IMSCON TYPE(IMSPLEX) command.
- IMS Connect WTOR commands are replies to the outstanding IMS Connect reply message.
- IMS Connect z/OS commands are issued through the z/OS (MVS™) interface by using the IMS Connect jobname.
| UPDATE IMSCON TYPE(IMSPLEX) command | Equivalent IMS Connect WTOR command | Equivalent IMS Connect z/OS command |
|---|---|---|
| UPDATE IMSCON TYPE(IMSPLEX) NAME(imsplex_name) START(COMM) | OPENIP imsplex_id | UPDATE IMSPLEX NAME(imsplex_name) START(COMM) |
| STARTIP imsplex_id | ||
| UPDATE IMSCON TYPE(IMSPLEX) NAME(imsplex_name) STOP(COMM) | STOPIP imsplex_id | UPDATE IMSPLEX NAME(imsplex_name) STOP(COMM) |
Examples
Example 1 for UPDATE IMSCON TYPE(IMSPLEX) command
TSO SPOC input:
UPDATE IMSCON TYPE(IMSPLEX) NAME(PLEX1) STOP(COMM)TSO SPOC output:
MbrName IMSplex CC
HWS1 PLEX1 0OM API input:
CMD(UPDATE IMSCON TYPE(IMSPLEX) NAME(PLEX1) STOP(COMM))OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.5.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2010.298 02:39:37.778072</statime>
<stotime>2010.298 02:39:37.787961</stotime>
<staseq>C6C7830010B98787</staseq>
<stoseq>C6C7830013239087</stoseq>
<rqsttkn1>USRID01 10193937</rqsttkn1>
<rc>02000004</rc>
<rsn>00001014</rsn>
<rsnmsg>CSLN055I</rsnmsg>
<rsntxt>At least one request completed with warning(s).</rsntxt>
</ctl>
<cmderr>
<mbr name="HWS1 ">
<typ>IMSCON </typ>
<rc>00000000</rc>
<rsn>00000000</rsn>
</mbr>
</cmderr>
<cmd>
<master>HWS1 </master>
<userid>USRID01 </userid>
<verb>UPD </verb>
<kwd>IMSCON </kwd>
<input>UPD IMSCON TYPE(IMSPLEX) NAME(PLEX1) STOP(COMM) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="IMSPLX" llbl="IMSplex" scope="LCL" sort="a" key="1"
scroll="no" len="8" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no"
len="8" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes"
len="4" dtype="INT" align="right" skipb="no" />
<hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0"
scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" />
</cmdrsphdr>
<cmdrspdata>
<rsp>IMSPLX(PLEX1 ) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout> Explanation: Communication between IMS Connect, HWS1, and the IMSplex, PLEX1, has been stopped.