UPDATE IMSCON TYPE(RMTIMSCON) command
Use the UPDATE IMSCON TYPE(RMTIMSCON) command to enable communications for the remote IMS Connect connection after it has been stopped, or to stop the communications of the remote IMS Connect connection.
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(RMTIMSCON) command.
- NAME
- Specifies one or more remote IMS Connect connection names to be updated. You can specify a single remote IMS Connect connection name or a list of remote IMS Connect connection names separated by commas. Wildcards can be used in the names.
- START(COMM) | STOP(COMM)
- Mutually exclusive keywords that you use to start or stop communications
for the remote IMS Connect connection.
- START(COMM)
- Starts communications for the remote IMS Connect connection. After issuing this command, OTMA communications with the remote IMS Connect are enabled. To enable communications for MSC, you might need to additionally issue the UPDATE IMSCON TYPE(MSC) START(COMM) command in order to complete the MSC physical link to the remote IMS Connect if MSC communications were disabled with the UPDATE IMSCON TYPE(MSC) STOP(COMM) command.
- STOP(COMM)
- Stops communications for the remote IMS Connect connection.
When the UPDATE IMSCON TYPE(RMTIMSCON) STOP(COMM) command is issued, IMS Connect:
- Stops all communication with a remote IMS Connect instance on the connection specified in the command.
- Informs IMS that the connection to the remote IMS Connect instance has been stopped so that IMS can shut down any affected MSC logical links.
- Terminates existing socket connections and prevents new socket connections until the UPDATE RMTIMSCON START(COMM) or an equivalent command is issued.
- Changes the status of the connection to STOPPED.
- Issues message HWST3505I.
After the UPDATE IMSCON TYPE(RMTIMSCON) STOP(COMM) command is issued, if IMS Connect receives a message for the connection in the STOPPED state, IMS Connect returns a NAK response to OTMA and issues message HWST3575W. OTMA retains the message at the front of the queue.
Usage notes
You can issue the UPDATE IMSCON TYPE(RMTIMSCON) 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(RMTIMSCON) START(COMM) command is issued, IMS Connect resumes communications on the specified connection to a remote IMS Connect instance. IMS Connect changes the status of the connection to NOT ACTIVE until new sockets are opened for communications with the remote instance of IMS Connect.
The UPDATE IMSCON TYPE(RMTIMSCON) START(COMM) command is required only when communications on a connection with a remote IMS Connect instance have been previously stopped by either a STOPRMT command or an UPDATE RMTIMSCON STOP(COMM) command.
If the specified RMTIMSCON connection is defined with AUTOCONN=Y, when the UPDATE IMSCON TYPE(RMTIMSCON) START(COMM) is issued, IMS Connect automatically creates socket connections to the remote IMS Connect. The number of socket connections IMS Connect opens is determined by the RESVSOC parameter.
OTMA communications can resume as soon as IMS Connect executes the UPDATE IMSCON TYPE(RMTIMSCON) START(COMM) command.
For MSC communications, the UPDATE IMSCON TYPE(RMTIMSCON) START(COMM) command resumes only TCP/IP communications in IMS Connect, and does not change the stopped status of MSC links. If the MSC links have been stopped by an UPDATE IMSCON TYPE(MSC) STOP(COMM) command, a WTOR command STOPMSC, or an IMS Connect z/OS® command UPDATE MSC STOP(COMM), after you issue the UPDATE IMSCON TYPE(RMTIMSCON) START(COMM) command, you also need to restart the MSC links in IMS Connect by issuing the UPDATE IMSCON TYPE(MSC) START(COMM) command, the STARTMSC command, or the UPDATE MSC START(COMM) command.
Use the QUERY IMSCON TYPE(RMTIMSCON) command, the VIEWRMT command, or the QUERY RMTIMSCON command to display information about the current connections to a remote IMS Connect instance that are defined to the local IMS Connect instance.
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(RMTIMSCON) 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(RMTIMSCON) command | Equivalent IMS Connect WTOR command | Equivalent IMS Connect z/OS command |
|---|---|---|
| UPDATE IMSCON TYPE(RMTIMSCON) NAME(rmtimscon_name) START(COMM) | STARTRMT rmtimsconName | UPDATE RMTIMSCON NAME(rmtimsconName) START(COMM) |
| UPDATE IMSCON TYPE(RMTIMSCON) NAME(rmtimscon_name) STOP(COMM) | STOPRMT rmtimsconName | UPDATE RMTIMSCON NAME(rmtimsconName) STOP(COMM) |
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 4. |
| 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. |
| MBR | MbrName | N/A | Identifier of the IMS Connect that built the output line. The identifier is always returned. |
| RIC | RmtImsCon | N/A | Identifier of the remote IMS Connect connection to be acted upon. 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(RMTIMSCON) 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(RMTIMSCON) 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. |
| X'0C000014' | X'00005008' | The command processor failed to obtain storage via BPEGETM. |
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(RMTIMSCON) command completed successfully for the resources. | |
| 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 the communication for the remote IMS Connect connection,
but the BPECBGET request failed. The command output might also contain the following message: HWST3515W. |
| C | Create scheduler thread failed | During START(COMM) processing, IMS Connect attempted
to create the scheduler controller thread for the communication for
the remote IMS Connect connection,
but the BPETHDCR request failed. For more information, see the HWST3515W 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 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. |
| 11 | Resource is stopped | During STOP(COMM) processing, IMS Connect could not stop the communication for the remote IMS Connect connection because the communication for the remote IMS Connect connection is already stopped. |
| 12 | Resource is not stopped | During START(COMM) processing, IMS Connect could not start the communication for the remote IMS Connect connection because the communication for the remote IMS Connect connection is not stopped. |
| 3D | Start process was interrupted | START(COMM) processing was
interrupted by another command or because IMS Connect is
shutting down. The command output might also contain one or more
of the following messages:
|
| 42 | Started, connection(s) failed | The communication for the remote IMS Connect connection started, but there was a problem with starting at least one of the requested socket connections, which are specified in the RESVSOC parameter of the RMTIMSCON statement in the HWSCFGxx member of the IMS PROCLIB data set. IMS Connect is not trying to establish the failed socket connection again. |
| 43 | Started, retrying connection(s) | The communication for the remote IMS Connect connection
started, but there was a problem with starting at least one of the
requested socket connections, which are specified in the RESVSOC parameter
of the RMTIMSCON statement in the HWSCFGxx member of the IMS PROCLIB
data set. IMS Connect is
trying to establish the failed socket connection again. The command
output might also contain one or more of the following messages:
|
| 44 | Started, retry failed | The communication for the remote IMS Connect connection
started, but there was a problem with starting at least one of the
requested socket connections, which are specified in the RESVSOC parameter
of the RMTIMSCON statement in the HWSCFGxx member of the IMS PROCLIB
data set. In addition, the attempt to start a thread to reestablish
the failed socket connections also failed. The command output might
also contain one or more of the following messages:
|
| 49 | Unable to start RMTIMSCON | IMS Connect was
not able to start the communication for the remote IMS Connect connection. The
command output might also contain one or more of the following messages:
|
| 4A | Started, unable to notify OTMA | The communication for the remote IMS Connect connection
started, but IMS Connect encountered
an error when it attempted to notify OTMA that the communication for
the remote IMS Connect connection
started. The command output might also contain one or more of the
following messages:
|
Examples
Example 1 for UPDATE IMSCON TYPE(RMTIMSCON) command
TSO SPOC input:
UPDATE IMSCON TYPE(RMTIMSCON) NAME(CONNECT2) START(COMM)TSO SPOC output:
RmtImsCon MbrName CC
CONNECT2 HWS1 0OM API input:
CMD(UPDATE IMSCON TYPE(RMTIMSCON) NAME(CONNECT2) START(COMM))OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.5.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2010.298 02:55:46.185267</statime>
<stotime>2010.298 02:55:46.189428</stotime>
<staseq>C6C7869B9C4335C2</staseq>
<stoseq>C6C7869B9D474302</stoseq>
<rqsttkn1>USRID01 10195546</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>HWS1 </master>
<userid>USRID01 </userid>
<verb>UPD </verb>
<kwd>IMSCON </kwd>
<input>UPD IMSCON TYPE(RMTIMSCON) NAME(CONNECT2) START(COMM) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="RIC" llbl="RmtImsCon" scope="LCL" sort="a" key="2"
scroll="no" len="8" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="1" 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>RIC(CONNECT2) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout> Explanation: The remote IMS Connect connection for CONNECT2 has been started.