UPDATE IMSCON TYPE(LINK) command
Use the UPDATE IMSCON TYPE(LINK) command to stop communications on an MSC logical link that is assigned to an MSC physical link in IMS Connect.
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(LINK) command.
- MSC
- 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 names separated by commas. Wildcards
can be used in the names.
This is an optional keyword. If specified, the command applies only to those logical links that are associated with the specified physical link ID. If omitted, then the command applies to logical links that are associated with any physical link ID.
- NAME
- Specifies the MSC logical link name. You can specify a single MSC logical link name or a list of MSC logical link name separated by commas. Wildcards can be used in the names.
- STOP(COMM)
- Stops logical link communication for the MSC that is associated with the link.
Usage notes
You can issue the UPDATE IMSCON TYPE(LINK) 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(LINK) command to clean up the resources associated with an MSC logical link when the link has already been terminated, but the IMS Connect resources associated with the link were not cleaned up correctly.
When the UPDATE IMSCON TYPE(LINK) command is issued, IMS Connect:
- Stops communication on the MSC logical link
- Informs IMS that communication has stopped on the logical link
- Deletes the control blocks associated with the logical link and frees the associated storage
- Issues message HWSF3310I
To avoid accidentally stopping a logical link that uses the same logical link name on another physical link, limit the command processing to a specific physical link by specifying the name of the target physical link as the lclplk_id value.
If the UPDATE IMSCON TYPE(LINK) command is issued against two or more physical links, or the lclplk_id value is omitted, IMS Connect stops communication on all MSC logical links that match the logical_link_name specified on the UPDATE IMSCON TYPE(LINK) command.
To display information about the MSC logical links that are assigned to the MSC physical links that are defined to an IMS Connect instance, use any of the following commands:
- In the IMS type-2 command format, either QUERY IMSCON TYPE(LINK) or QUERY IMSCON TYPE(MSC)
- In the WTOR command format, VIEWMSC
- In the z/OS® MODIFY command format, QUERY MSC
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(LINK) 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(LINK) command | Equivalent IMS Connect WTOR command | Equivalent IMS Connect z/OS command |
|---|---|---|
| UPDATE IMSCON TYPE(LINK) NAME(logical_link_name) STOP(COMM) | STOPLINK logical_link_name | DELETE LINK NAME(linkName) |
| UPDATE IMSCON TYPE(LINK) NAME(logical_link_name) MSC(lclplk_id) STOP(COMM) | STOPLINK logical_link_name lclplk_id | DELETE LINK NAME(linkname) LCLPLKID(lclPlkid) |
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. |
| LINK | Link | N/A | Specifies the MSC logical link that was terminated. The identifier is always returned. |
| MBR | MbrName | N/A | Identifier of the IMS Connect that built the output line. The identifier is always returned. |
| MSC | MscName | N/A | Identifier of the MSC physical link associated with the logical link that was terminated. The identifier, which is defined on the LCLPLKID parameter, 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(LINK) 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(LINK) 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(LINK) 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(LINK) command
TSO SPOC input:
UPDATE IMSCON TYPE(LINK) NAME(MSCLINK1) STOP(COMM)TSO SPOC output:
Link MscName MbrName CC
MSCLINK1 MSC12 HWS1 0OM API input:
CMD(UPDATE IMSCON TYPE(LINK) NAME(MSCLINK1) STOP(COMM))OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.5.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2010.298 02:42:55.240634</statime>
<stotime>2010.298 02:42:55.245578</stotime>
<staseq>C6C783BC615BAEFC</staseq>
<stoseq>C6C783BC6290A27C</stoseq>
<rqsttkn1>USRID01 10194255</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(LINK) NAME(MSCLINK1) STOP(COMM) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="LINK" llbl="Link" scope="LCL" sort="n" key="0" scroll="yes"
len="8" dtype="CHAR" align="left" skipb="no" />
<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>LINK(MSCLINK1) MSC(MSC12 ) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout> Explanation: The communication for the MSC, MSC12, associated with the logical link MSCLINK1 has been stopped.