UPDATE IMSCON TYPE(ISCUSER) command
Use the UPDATE IMSCON TYPE(ISCUSER) command to stop an ISC user session (ISCUSER) that is assigned to an ISC 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(ISCUSER) command.
- ISC
- Specifies the ISC link ID defined in the ID parameter of the ISC
statement. You can specify a single ISC link ID or a list of ISC link
IDs separated by commas. Wildcards can be used in the names.
ISC is an optional keyword. If specified, the command applies only to those user sessions that are associated with the specified link ID. If omitted, then the command applies to user sessions that are associated with any link ID.
- NAME
- Specifies the ISC user session name. You can specify a single ISC user name or a list of ISC user names that are separated by commas. Wildcards can be used in the names.
- STOP(COMM)
- Stops communication for the ISC user.
Usage notes
You can issue the UPDATE IMSCON TYPE(ISCUSER) 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(ISCUSER) STOP(COMM) command to clean up IMS Connect resources that are associated with an ISC user session when the user session was already terminated, but the IMS Connect resources that are associated with the user session were not cleaned up correctly.
When the UPDATE IMSCON TYPE(ISCUSER) STOP(COMM) command is issued, IMS Connect:
- Stops communication on the ISC user session
- Informs IMS that communication is stopped on the user session
- Deletes the control blocks associated with the user session and frees the associated storage
- Issues message HWSG4010I
To avoid accidentally stopping a user session that uses the same user session name on another ISC link, limit the command processing to a specific ISC link by specifying the ID of the target ISC link on the ISC keyword.
If the UPDATE IMSCON TYPE(ISCUSER) command is issued against two or more ISC links, or the isc_link_id value is omitted, IMS Connect stops all of the ISC user sessions that match the specified ISC user names on each ISC link.
To display information about the ISC user sessions that are assigned to the ISC links that are defined to an IMS Connect instance, use either of the IMS type-2 commands QUERY IMSCON TYPE(ISCUSER) or QUERY IMSCON TYPE(ISC).
Equivalent WTOR and z/OS commands
The UPDATE IMSCON TYPE(ISCUSER) command does not have an equivalent IMS Connect WTOR (Write to Operator with Reply) or IMS Connect 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 3. |
| CCTXT | CCText | error | Completion code text that briefly explains the meaning of the nonzero completion code. The CCText field is returned only for an error completion code. |
| IUSER | ISCUser | N/A | Specifies the ISC user session 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. |
| ISC | ISCName | N/A | Identifier of the ISC link that is associated with the user session that was terminated. The identifier, which is defined on the ID parameter of the ISC statement, 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(ISCUSER) 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(ISCUSER) 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'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(ISCUSER) command. |
| X'0C000008' | X'00002020' | The STOP keyword must 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. |
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(ISCUSER) command completed successfully for the resources. | |
| 8 | Command processing error | The ISCUSER resource could not be processed because of an internal processing error. Refer to the command return and reason codes for more details. |
| 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 currently. 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. |
Example
In the following example, the command stops the ISC user session, ISCUSER1, which is associated with the ISC link ISCLINK1.
TSO SPOC input:
UPDATE IMSCON TYPE(ISCUSER) NAME(ISCUSER1) STOP(COMM)TSO SPOC output:
ISCUser ISCName MbrName CC
ISCUSER1 ISCLINK1 HWS1 0OM API input:
CMD(UPDATE IMSCON TYPE(ISCUSER) NAME(ISCUSER1) STOP(COMM))OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.6.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2012.335 17:33:09.520770</statime>
<stotime>2012.335 17:33:09.535112</stotime>
<staseq>CA8CA13CBF18231A</staseq>
<stoseq>CA8CA13CC2988D9A</stoseq>
<rqsttkn1>USRID01 10093309</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(ISCUSER) NAME(ISCUSER1) STOP(COMM) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="IUSER" llbl="ISCUser" scope="LCL" sort="a" key="1"
scroll="no" len="8" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="ISC" llbl="ISCName" 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="3" 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>IUSER(ISCUSER1) ISC(ISCLINK1) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout>