UPDATE IMSCON TYPE(MSC) command
Use the UPDATE IMSCON TYPE(MSC) command to restart the MSC communications after it has been terminated and to terminate all communications to an MSC physical link, including all associated logical links.
Subsections:
Environment
The UPDATE IMSCON command
is applicable only to IMS™ Connect.
To issue this command, the following conditions must be satisfied:
- 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
.-,-------------. V | >>-+-UPDATE-+--IMSCON--TYPE(MSC)--NAME(---+-lclPlkid--+-+-)-----> '-UPD----' '-lclPlkid*-' >--+-START(COMM)-+--------------------------------------------->< '-STOP(COMM)--'
Keywords
The following keywords are valid for the UPDATE IMSCON TYPE(MSC) command.
- NAME
- Specifies the MSC physical link ID defined in the LCLPLKID parameter of the MSC statement. You can specify a single MSC physical link name or a list of MSC physical link name separated by commas. Wildcards can be used in the names.
- START(COMM)
- Starts or restarts the MSC communications of the MSC physical
link after it has been terminated by an UPDATE IMSCON TYPE(MSC)
STOP(COMM) command. The status of the MSC communication
for the MSC physical link is set to
ACTIVE
after the completion of the command. START(COMM) is mutually exclusive with STOP(COMM). - STOP(COMM)
- Terminates all communications to an MSC physical link, including
all its logical links. The status of the MSC communication for the
MSC physical link is set to
NOTACTIVE
after the completion of the command. STOP(COMM) is mutually exclusive with START(COMM).
Usage notes
You can issue the UPDATE IMSCON TYPE(MSC) 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(MSC) STOP(COMM) command is issued, IMS Connect:
- Stops communication on the specified MSC physical link, including communications on all the MSC logical links that are assigned to the physical link
- Informs IMS that communication has stopped on the physical link so that IMS can also terminate the physical link and any logical links that are assigned to the physical link
- Changes the status of the MSC physical link and its assigned logical links to NOT ACTIVE
- For TCP/IP generic resources, clears affinity of a physical link to the IMS system
- Issues message HWSF3305I
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(MSC) command.
Notes:
- 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(MSC) command | Equivalent IMS Connect WTOR command | Equivalent IMS Connect z/OS command |
|---|---|---|
| UPDATE IMSCON TYPE(MSC) NAME(lclPlkid) START(COMM) | STARTMSC lclPlkid | UPDATE MSC NAME(lclPlkid) START(COMM) |
| UPDATE IMSCON TYPE(MSC) NAME(lclPlkid) STOP(COMM) | STOPMSC lclPlkid | UPDATE MSC NAME(lclPlkid) 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. |
| MSC | MscName | N/A | The MSC physical link name. The MSC physical link name 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(MSC) 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(MSC) 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(MSC) 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 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. |
Examples
Example 1 for UPDATE IMSCON TYPE(MSC) command
TSO SPOC input:
UPDATE IMSCON TYPE(MSC) NAME(MSC12) STOP(COMM)TSO SPOC output:
MscName MbrName CC
MSC12 HWS1 0 OM API input:
CMD(UPDATE IMSCON TYPE(MSC) NAME(MSC12) STOP(COMM))OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.5.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2010.298 02:45:18.138130</statime>
<stotime>2010.298 02:45:18.155690</stotime>
<staseq>C6C78444A871292C</staseq>
<stoseq>C6C78444ACBAA9AC</stoseq>
<rqsttkn1>USRT001 10194518</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>HWS1 </master>
<userid>USRT001 </userid>
<verb>UPD </verb>
<kwd>IMSCON </kwd>
<input>UPD IMSCON TYPE(MSC) NAME(MSC12) STOP(COMM) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="MSC" llbl="MscName" scope="LCL" sort="a" key="1"
scroll="yes" 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>MSC(MSC12 ) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout> Explanation: The communication between IMS Connect, HWS1, and MSC MSC12 has been stopped.