DELETE LTERM command
Use the DELETE LTERM command to delete a Multiple Systems Coupling (MSC) remote LTERM.
Subsections:
Environment
The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords.
| Command / Keywords | DB/DC | DBCTL | DCCTL |
|---|---|---|---|
| DELETE LTERM NAME() OPTION() | X | X |
Syntax
Keywords
The following keywords are valid for the DELETE LTERM command:
- NAME
- Specify one or more 1-8 character names of MSC remote LTERMs. Wildcards are supported in the name. Examples of valid names are NAME(*) and NAME(abc*). If the NAME parameter specified is a specific or wildcard name, command responses are returned for all the resource names that are processed. For NAME(*), command responses are returned only for the resource names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the resource names that are processed.
- OPTION
- Specifies options for the command.
- ALLRSP
- Indicates that the response lines are to be returned for all resources that are processed on the command. The default action is to return response lines only for the resources that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values.
Usage notes
This command can be issued only through the OM API. This command applies to DB/DC systems and DCCTL systems. The DELETE LTERM command applies only to remote MSC LTERMs and is valid only when both MSC and the dynamic definition of MSC resources are enabled (MSC=Y is specified in the startup parameters and MSCRSCS=DYN is specified in the MSC section of the DFSDFxxx member).
The DELETE LTERM command is not valid on the XRF alternate or FDBR region.
This command is recoverable.
Before you attempt to delete an MSC remote LTERM, make sure that the remote LTERM is not in use. If the remote LTERM is in use, the delete fails. Issue the QUERY LTERM NAME(ltermname) SHOW(STATUS) command to check the status of the LTERM.
In a sysplex environment with multiple IMS systems, the delete might succeed on some IMS systems and fail on others.
Changes that are made to MSC resources by the DELETE command are logged to save them across warm and emergency restarts. The changes are not saved across a cold start of IMS unless the MSC resources are also deleted from the stage-1 system definition macro input.
If your MSC resources are defined by using stage-1 system definition macros, delete the resource definition by removing the macro that defines the resource from the stage-1 system definition input and regenerate the MSC resources into the DFSCLL3x member in the IMS.SDFSRESL data set.
Output fields
- Short label
- Contains the short label that is generated in the XML output.
- Long label
- Contains the long label that is generated in the XML output.
- Keyword
- Identifies keyword on the command that caused the field to be generated. N/A appears for output fields that are always returned. error appears for output fields that are returned only in 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. |
| CCTXT | CCText | error | Completion code text that briefly explains the nonzero completion code. |
| ERRT | ErrorText | error | Error text that provides diagnostic information. Error text can be returned for a nonzero completion code and further explains the completion code. |
| MBR | MbrName | N/A | IMSplex member that built the output line. |
| LTERM | Lterm | N/A | The name of the remote logical terminal. The remote logical terminal name is always returned. |
Return and reason codes
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 command completed successfully. The command output contains a line for each resource, which is accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), no output lines are returned. See the completion code table for details. |
| X'0000000C' | X'00003000' | 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. If NAME(*) is specified without OPTION(ALLRSP), only resources with nonzero completion codes are returned. See the completion code table for details. |
| X'0000000C' | X'00003004' | Command was not successful for any of the resources. The command output contains a line for each resource, which is accompanied by its completion code. See the completion code table for details. |
| X'00000010' | X'0000400C' | Command is not valid on the XRF alternate. |
| X'00000010' | X'0000402C' | Command is not valid because MSC is not enabled in the IMS system. |
| X'00000010' | X'0000402D' | Command is not allowed because dynamic definition is not enabled for MSC. MSCRSCS=DYN is not specified in the MSC section of the DFSDFxxx member of the IMS PROCLIB data set. |
| X'00000014' | X'00005004' | DFSOCMD response buffer could not be obtained. |
| X'00000014' | X'00005008' | DFSPOOL storage could not be obtained. |
| X'00000014' | X'00005010' | Unable to obtain latch. |
Completion codes
Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes.
| Completion code | Completion code text | Meaning |
|---|---|---|
| 0 | The command completed successfully for the resource. | |
| 10 | NO RESOURCES FOUND | The resource name is invalid or the value that is specified on the NAME keyword does not match the name of any resource within this resource type. |
| 17 | ANOTHER CMD IN PROGRESS | Another command (such as DELETE or UPDATE) is in progress for this LTERM. This could also mean this command, if the resource is specified by more than one specific or wildcard parameter. |
| 48 | NOT ALLOWED FOR IMS RESOURCE | The resource name is invalid as a remote lterm. The resource is an IMS-defined resource. |
| 90 | INTERNAL ERROR | An IMS system service failure. |
Examples
The following are examples of the DELETE LTERM command:
Example 1 for DELETE LTERM command
In the following example, the DELETE LTERM command is issued to delete MSC remote LTERMs LTERM20B, BADNAME, and LTERM23C. The delete is successful for remote LTERMs LTERM20B and LTERM23C, as shown by the completion code 0. The delete fails for BADNAME because no remote LTERM is named BADNAME.
DELETE LTERM NAME(LTERM20B,BADNAME,H0G5*,LTERM23C)Lterm MbrName CC CCText
BADNAME IMS1 10 NO RESOURCES FOUND
H0G50 IMS1 0
H0G51 IMS1 0
H0G52 IMS1 0
LTERM20B IMS1 0
LTERM23C IMS1 0OM API input:
CMD(DEL LTERM NAME(LTERM20B,BADNAME,H0G5*,LTERM23C))<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.7.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2014.268 16:10:13.937131</statime>
<stotime>2014.268 16:10:13.938009</stotime>
<staseq>CDCF651DB8FEBD05</staseq>
<stoseq>CDCF651DB9359185</stoseq>
<rqsttkn1>USRT011 10091013</rqsttkn1>
<rc>0200000C</rc>
<rsn>00003008</rsn>
<rsnmsg>CSLN054I</rsnmsg>
<rsntxt>None of the clients were successful.</rsntxt>
</ctl>
<cmderr>
<mbr name="IMS1 ">
<typ>IMS </typ>
<styp>DBDC </styp>
<rc>0000000C</rc>
<rsn>00003000</rsn>
<rsntxt>At least one request successful</rsntxt>
</mbr>
</cmderr>
<cmd>
<master>IMS1 </master>
<userid>USRT011 </userid>
<verb>DEL </verb>
<kwd>LTERM </kwd>
<input>DELETE LTERM NAME(LTERM20B,BADNAME,H0G5*,LTERM23C) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="LTERM" llbl="Lterm" scope="LCL" sort="a" key="1" scroll="n
o" len="8" dtype="CHAR" align="left" />
<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no"
len="8" dtype="CHAR" align="left" />
<hdr slbl="CC" llbl="CC" scope="LCL" sort="a" key="3" scroll="yes"
len="4" dtype="INT" align="right" skipb="no" />
<hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0"
scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" />
<hdr slbl="ERRT" llbl="ErrorText" scope="LCL" sort="n" key="0"
scroll="yes" len="*" dtype="CHAR" skipb="yes" align="left" />
</cmdrsphdr>
<cmdrspdata>
<rsp>LTERM(LTERM20B) MBR(IMS1 ) CC( 0) </rsp>
<rsp>LTERM(BADNAME ) MBR(IMS1 ) CC( 10) CCTXT(NO RESOURCES FOUND)
</rsp>
<rsp>LTERM(H0G52 ) MBR(IMS1 ) CC( 0) </rsp>
<rsp>LTERM(LTERM23C) MBR(IMS1 ) CC( 0) </rsp>
<rsp>LTERM(H0G51 ) MBR(IMS1 ) CC( 0) </rsp>
<rsp>LTERM(H0G50 ) MBR(IMS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout>