UPDATE IMSCON TYPE(SENDCLNT) command
Use the UPDATE IMSCON TYPE(SENDCLNT) command to terminate the send socket clients on a specified connection to either a remote IMS Connect instance or a remote CICS® subsystem.
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(SENDCLNT) command:
- NAME
- Specifies the client ID of the send socket to terminate. You can specify a single send client name or a wildcard name.
- RMTCICS
- Specifies the remote CICS connection that the send client is on. Either the RMTCICS keyword or the RMTIMSCON keyword must be specified.
- RMTIMSCON
- Specifies the remote IMS Connect connection that the send client is on. Either the RMTCICS keyword or the RMTIMSCON keyword must be specified.
- STOP(COMM)
- Terminates the send socket clients for a specified remote IMS Connect connection.
Usage notes
You can issue the UPDATE IMSCON TYPE(SENDCLNT) 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.
Modifications that are made to IMS Connect resources by use of this command are not saved across restarts of IMS Connect.
Use the UPDATE IMSCON TYPE(SENDCLNT) command to terminate send sockets on a connection to either another IMS Connect instance or a remote CICS subsystem.
To identify the IDs of the send sockets that you need to terminate, use the QUERY IMSCON TYPE(SENDCLNT) type-2 command.
- In the WTOR command format, VIEWRMT
- In the z/OS® MODIFY command format, QUERY RMTIMSCON
If the socket connections are used for MSC links, do not use the UPDATE IMSCON TYPE(SENDCLNT) command to terminate the sockets. Issuing the UPDATE IMSCON TYPE(SENDCLNT) command breaks MSC links. Instead, stop MSC links by issuing the IMS command /PSTOP LINK from IMS, which automatically terminates the associated send and receive sockets in IMS Connect.
An alternative method of terminating send sockets that are used for MSC messages is by using the IMS Connect WTOR command STOPLINK or the IMS Connect z/OS modify command DELETE LINK. These commands terminate the send sockets and receive sockets that are used by the MSC link. The IMS type-2 command equivalent is UPDATE IMSCON TYPE(LINK).
If a socket connection is used for OTMA messages and the send socket connection is in RECV state when the UPDATE IMSCON TYPE(SENDCLNT) command is issued, IMS Connect issues a NAK to OTMA and then terminates the send socket connection. OTMA reroutes the message to the dead letter queue, HWS$DLQ.
Do not use the UPDATE IMSCON TYPE(SENDCLNT) command to terminate socket connections that are used for ISC links. The UPDATE IMSCON TYPE(SENDCLNT) command breaks ISC links. Instead, stop ISC links by issuing the IMS command /QUIESCE NODE USER from IMS, which automatically terminates the associated send and receive sockets in IMS Connect.
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(SENDCLNT) 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(SENDCLNT) command | Equivalent IMS Connect WTOR command | Equivalent IMS Connect z/OS command |
|---|---|---|
| UPDATE IMSCON TYPE(SENDCLNT) NAME(sendclient_name) RMTIMSCON(rmtimscon_name) STOP(COMM) | STOPSCLN rmtimscon sendclient | DELETE RMTIMSCON NAME(rmtimsconname) SENDCLNT(clientid) |
| UPDATE IMSCON TYPE(SENDCLNT) NAME(sendclient_name) RMTCICS(rmtcics_name) STOP(COMM) | STOPSCLN rmtcics sendclient | No equivalent z/OS command |
Output fields
- Short label
- Contains the short label that is generated in the XML output.
- Long label
- Contains the column heading that is displayed on the TSO SPOC screen.
- Keyword
- Identifies the keyword on the command that caused the field to be generated. N/A (not applicable) is displayed for output fields that are always returned. error is displayed 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 4. |
| CCTXT | CCText | error | Completion code text that briefly explains the meaning of the nonzero completion code. The CCTXT field is returned only for an error completion code. |
| RIC | RmtImsCon | RMTIMSCON | Identifier of the remote IMS Connect connection to be acted upon. |
| RCICS | RmtCICS | RMTCICS | Identifier of the remote CICS connection to be acted upon. |
| SCL | SendClnt | N/A | Identifier of the client ID of the send socket to be terminated. The SCL field 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(SENDCLNT) command are standard for all commands that are 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(SENDCLNT) command completed successfully. The command output contains a line for each resource, which is accompanied by its completion code. |
| X'0C000008' | X'00002004' | An invalid keyword or keyword parameter was specified. |
| X'0C000008' | X'00002010' | A generic name was specified in the RMTIMSCON or RMTCICS keyword. Only specific names can be specified. |
| X'0C000008' | X'00002014' | An invalid character was specified in the NAME() parameter. |
| X'0C000008' | X'00002018' | The NAME keyword was not specified, but is a required keyword for the UPDATE IMSCON TYPE(SENDCLNT) command. |
| X'0C000008' | X'0000201C' | Neither the RMTIMSCON keyword nor the RMTCICS keyword was specified. One of these keywords is required. |
| X'0C000008' | X'00002020' | The STOP keyword must be specified. |
| X'0C000008' | X'0000202C' | Both the RMTIMSCON and RMTCICS keywords were specified. Only one of these keywords can be specified. |
| X'0C000008' | X'00002133' | Multiple names were specified in the RMTIMSCON or RMTCICS keyword. Only one name can be specified. |
| X'0C00000C' | X'00003000' | The command was successful for some resources but failed for others. The command output contains a line for each resource, which is 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, which is accompanied by its completion code. |
| X'0C000014' | X'00005000' | The command processor failed to obtain storage via BPECBGET. |
| X'0C000014' | X'00005050' | The command processor failed because of an internal processing error. Refer to any error messages returned with the command or displayed on the system console for more details. |
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(SENDCLNT) command completed successfully for the resources. | |
| 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 now. 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. |
Examples
Example of UPDATE IMSCON TYPE(SENDCLNT) RMTIMSCON(rmtimscon) command
In the following example, a send client socket, OTM12345, is stopped. The stopped send socket is on the remote IMS Connect connection, CONNECT2.
TSO SPOC input:
UPDATE IMSCON TYPE(SENDCLNT) NAME(OTM12345) RMTIMSCON(CONNECT2) STOP(COMM)TSO SPOC output:
SendClient RmtImsCon MbrName CC
OTM12345 CONNECT2 HWS1 0OM API input:
CMD(UPDATE IMSCON TYPE(SENDCLNT) NAME(OTM12345) RMTIMSCON(CONNECT2) STOP(COMM))OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.5.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2010.298 03:01:07.108399</statime>
<stotime>2010.298 03:01:07.112686</stotime>
<staseq>C6C787CDAAA2F767</staseq>
<stoseq>C6C787CDABAEE8C7</stoseq>
<rqsttkn1>USRID01 10200107</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>HWS1 </master>
<userid>USRID01 </userid>
<verb>UPD </verb>
<kwd>IMSCON </kwd>
<input>UPDATE IMSCON TYPE(SENDCLNT) NAME(OTM12345) RMTIMSCON(CONNECT2)
STOP(COMM) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="SCL" llbl="SendClnt" scope="LCL" sort="n" key="1"
scroll="no" len="8" dtype="CHAR" align="lfet" skipb="no" />
<hdr slbl="RIC" llbl="RmtImsCon" scope="LCL" sort="n" key="0"
scroll="yes" len="8" dtype="CHAR" align="left" skipb="yes" />
<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>SCL(OTM12345) RIC(CONNECT2) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout>
Example of UPDATE IMSCON TYPE(SENDCLNT) RMTCICS(rmtcics) command
In the following example, a send client socket, ISC98765, is stopped. The stopped send socket is on the remote CICS connection, CICSA1.
TSO SPOC input:
UPDATE IMSCON TYPE(SENDCLNT) NAME(ISC98765) RMTCICS(CICSA1) STOP(COMM)TSO SPOC output:
SendClnt RmtCICS MbrName CC
ISC98765 CICSA1 HWS1 0OM API input:
CMD(UPDATE IMSCON TYPE(SENDCLNT) NAME(ISC98765) RMTCICS(CICSA1) STOP(COMM) )OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.6.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2012.339 23:27:56.704048</statime>
<stotime>2012.339 23:27:56.707079</stotime>
<staseq>CA91F7FFA1530C9C</staseq>
<stoseq>CA91F7FFA210779C</stoseq>
<rqsttkn1>USRID01 10152756</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>HWS1 </master>
<userid>USRID01 </userid>
<verb>UPD </verb>
<kwd>IMSCON </kwd>
<input>UPDATE IMSCON TYPE(SENDCLNT) NAME(ISC98765) RMTCICS(CICSA1)
STOP(COMM) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="SCL" llbl="SendClnt" scope="LCL" sort="n" key="1"
scroll="no" len="8" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="RCICS" llbl="RmtCICS" scope="LCL" sort="n" key="0"
scroll="yes" len="8" dtype="CHAR" align="left" skipb="yes" />
<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>SCL(ISC98765) RCICS(CICSA1 ) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout>