DELETE RTCDESC command

Use the DELETE RTCDESC command to delete Fast Path routing code descriptors.

Subsections:

Environment

The following table lists the environments (DB/DC, DBCTL, and DCCTL) in which you can use the command and keywords.

Table 1. Valid environments for the DELETE RTCDESC command and keywords
Command / Keywords DB/DC DBCTL DCCTL
DELETE RTCDESC X   X
NAME X   X
OPTION X   X

Syntax

Read syntax diagramSkip visual syntax diagramDELETEDELRTCDESCNAME(,name*)OPTION(ALLRSP)

Keywords

The following keywords are valid for the DELETE RTCDESC command:

NAME
Specifies the 1-8 character name of the routing code descriptor. 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 descriptor names that are processed. For NAME(*), command responses are returned only for the descriptor names that resulted in an error. OPTION(ALLRSP) can be specified with NAME(*) to obtain the command responses for all the descriptor names that are processed.
OPTION
Specifies additional functions to be performed along with the command.
ALLRSP
Indicates that the response lines are to be returned for all descriptors that are processed on the command. The default action is to return response lines only for the descriptors that resulted in an error. It is valid only with NAME(*). ALLRSP is ignored for other NAME values.

Usage notes

This command can only be issued through the Operations Manager API. This command applies to DB/DC systems and DCCTL systems. The DELETE RTCDESC command applies if Fast Path is installed.

The DELETE RTCDESC command is not valid on the XRF alternate or FDBR region. The DELETE RTCDESC command is not valid if online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC or MODBLKS not defined).

This command is recoverable.

Each descriptor is deleted individually. Individual deletion does not work like online change where either all descriptors are deleted or no descriptors are deleted. Descriptors can be successfully deleted if they are not currently in use. If a descriptor is in use, the delete fails. In a sysplex environment, the delete might succeed on some IMS systems and fail on others. A descriptor is in use if another command is in progress that references the descriptor.

The descriptors remain deleted across an IMS warm start or emergency restart. To ensure they remain deleted across a cold start, the existing descriptor definitions must be exported to an RDDS and then imported from the RDDS at cold start.

The IMS-defined routing code descriptor (DBFDSRT1) cannot be deleted with the DELETE RTCDESC command.

Output fields

The following table shows the DELETE RTCDESC output fields. The columns in the table are as follows:
Short label
Contains the short label generated in the XML output.
Long label
Contains the long label 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.
Table 2. Output fields for the DELETE RTCDESC command
Short label Long label Keyword Meaning
CC CC N/A Completion code.
CCTXT CCText error Completion code text that briefly explains the meaning of the non-zero completion code.
DESC DescName RTCDESC Routing code descriptor name.
ERRT ErrorText error Error text that provides diagnostic information. Error text can be returned for a non-zero completion code and further explains the completion code.
MBR MbrName N/A IMSplex member that built the output line.

Return, reason, and completion 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.

Table 3. Return and reason codes for the DELETE RTCDESC command
Return code Reason code Meaning
X'00000000' X'00000000' Command completed successfully. The command output contains a line for each descriptor, 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 descriptors but failed for others. The command output contains a line for each descriptor, accompanied by its completion code. If NAME(*) is specified without OPTION(ALLRSP), only descriptors with non-zero completion codes are returned. See the completion code table for details.
X'0000000C' X'00003004' Command was not successful for any of the descriptors. The command output contains a line for each descriptor, 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'00004024' No Fast Path defined.
X'00000010' X'00004120' Online change phase is in progress.
X'00000010' X'00004300' Command is not allowed because online change for MODBLKS is enabled (DFSDFxxx or DFSCGxxx defined with MODBLKS=OLC, or MODBLKS not defined).
X'00000014' X'00005004' DFSOCMD response buffer could not be obtained.
X'00000014' X'00005008' DFSPOOL storage could not be obtained.
X'00000014' X'0000500C' AWE could not be obtained.

Errors unique to the processing of this command are returned as completion codes. The following table includes an explanation of the completion codes.

Table 4. Completion codes for the DELETE RTCDESC command
Completion code Completion code text Meaning
0   Command completed successfully for routing code descriptor.
10 NO RESOURCES FOUND Routing code descriptor name is invalid, or the wildcard parameter specified does not match any routing code descriptor names.
17 ANOTHER CMD IN PROGRESS Another command (such as DELETE or UPDATE) is in progress for this routing code descriptor. This could also mean this command, if the descriptor is specified by more than one specific or wildcard parameter.
27 REJECTED FOR DEFAULT DESCRIPTOR DELETE command not allowed for user-defined default descriptor. You must issue an UPDATE command to set another descriptor as the default before deleting this descriptor.
48 NOT ALLOWED FOR IMS RESOURCE DELETE command not allowed for IMS descriptor. An example of an IMS descriptor is DBFDSRT1.
1D7 IMPORT CHANGE LIST ERROR Descriptor is in the process of being imported from the change list in the IMSRSC repository, or the import from the change list failed. The descriptor cannot be deleted until it is successfully imported.

Examples

The following are examples of the DELETE RTCDESC command:

Example 1 for DELETE RTCDESC command

TSO SPOC input:
DEL RTCDESC NAME(*) OPTION(ALLRSP)  
TSO SPOC output:
Response for: DEL RTCDESC NAME(*) OPTION(ALLRSP)      
DescName MbrName    CC CCText                         
DBFDSRT1 IMS1       48 NOT ALLOWED FOR IMS RESOURCE   
DESC001  IMS1        0                                
DESC002  IMS1        0                                
DESC003  IMS1        0                                
DESC004  IMS1        0                                
DESC005  IMS1        0                                
RTCDESC1 IMS1       27 REJECTED FOR DEFAULT DESCRIPTOR   
OM API input:
CMD(DEL RTCDESC NAME(*) OPTION(ALLRSP))
OM API output:
<imsout>                                   
<ctl>                                      
<omname>OM1OM   </omname>                  
<omvsn>1.3.0</omvsn>                       
<xmlvsn>20  </xmlvsn>                      
<statime>2006.310 22:57:13.782312</statime>
<stotime>2006.310 22:57:13.783073</stotime>
<staseq>BFAAC4A6CD428992</staseq>                    
<stoseq>BFAAC4A6CD721DC0</stoseq>                    
<rqsttkn1>USRT011 10145713</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>RTCDESC         </kwd>                          
<input>DEL RTCDESC NAME(*) OPTION(ALLRSP) </input>   
</cmd>                                                                 
<cmdrsphdr>                                                            
<hdr slbl="DESC" llbl="DescName" scope="LCL" sort="a" key="1"          
 scroll="no" 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="n" key="0" scroll="yes"     
 len="4" dtype="INT" align="right" />                                  
<hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0"           
 scroll="yes" len="32" dtype="CHAR" align="left" skipb="yes" />        
</cmdrsphdr>                                                           
<cmdrspdata>                                                           
<rsp>DESC(DESC004 ) MBR(IMS1) CC(   0) </rsp>                          
<rsp>DESC(DESC005 ) MBR(IMS1) CC(   0) </rsp>                          
<rsp>DESC(DESC001 ) MBR(IMS1) CC(   0) </rsp>                          
<rsp>DESC(RTCDESC1) MBR(IMS1) CC(  27) CCTXT(REJECTED FOR DEFAULT      
 DESCRIPTOR) </rsp>                                                    
<rsp>DESC(DBFDSRT1) MBR(IMS1) CC(  48) CCTXT(NOT ALLOWED FOR IMS       
 RESOURCE) </rsp>                                                      
<rsp>DESC(DESC002 ) MBR(IMS1) CC(   0) </rsp>                          
<rsp>DESC(DESC003 ) MBR(IMS1) CC(   0) </rsp>                          
</cmdrspdata>                                                        
</imsout>

Explanation: A DELETE RTCDESC command is issued to delete all routing code descriptors from an active IMS system. Many routing code descriptors are successfully deleted, as indicated by the completion code 0. Because the DELETE command attempted to delete all of the routing code descriptors, OPTION(ALLRSP) is specified to display the successfully deleted routing code descriptors. Routing code descriptor RTCDESC1 fails, because it is the default routing code descriptor. Routing code descriptor DBFDSRT1 fails, because it is the IMS-defined routing code descriptor.