IMS type-2 command format

Type-2 commands can be issued only through the Operations Manager (OM) APIs by an automated operator program (AOP). An example of an AOP is the IBM-supplied TSO single point of control (SPOC) application. These commands cannot be entered from the system console, the MTO, an end-user terminal, or an IMS AOI application program. Type-2 commands are not passed to the IMS AOI user exits and are also not logged to the IMS secondary master.

Almost all commands issued through the OM API (including the IMS type-1 commands) do not require a command recognition character (for example, a slash). If one is supplied, the OM API will ignore it. The only exception to this rule is the type-1 /EXIT command, which requires a slash when entered from a TSO SPOC application.

>>-VERB--RESOURCETYPE------------------------------------------->

   .-,-------------------------------------.   
   V                                       |   
>----+-----------------------------------+-+-------------------><
     |              .-,--------------.   |     
     |         (1)  V                |   |     
     '-KEYWORD----(---+-parameter--+-+-)-'     
                      '-parameter*-'           

The following is a list of the parameters with a short description of each.

VERB

Identifies the action to be taken. The command verb can be abbreviated.

RESOURCETYPE

Identifies the type of resource the command acts upon. The following is a list of the resource types:

AREA

An area resource in an IMS.

DATAGRP

The members of a data group in an IMS.

DB

The database in an IMSplex.

DBDESC

The databases descriptor in an IMSplex.

IMSCON

IMS Connect resources.

IMS

Status and attributes of an IMS.

IMSPLEX

A group of IMS systems, CSL (SCI, OM, RM) members and CQSs.

LE

Language Environment® runtime parameter definitions.

MEMBER

An IMSplex component (For example, an IMS, OM, RM, or SCI).

MSLINK

Logical links.

MSPLINK

Physical links.

MSNAME

Logical link paths.

ODBM

Open Database Manager (ODBM), a component of the Common Service Layer (CSL).

OLC

An online change process.

OLREORG

An online reorganization of a HALDB partition.

OTMADESC

IMS Open Transaction Manager Access (OTMA) destination descriptor.

PGM

A program in an IMS.

PGMDESC

A program descriptor in an IMS.

RM

Resource Manager (RM) address space.

RTC

A Fast Path routing code.

RTCDESC

A Fast Path routing code descriptor.

STRUCTURE

A resource structure managed by RM.

TRAN

An IMS resource that is a message destination.

TRANDESC

An IMS descriptor that is a message destination.

KEYWORD()

Optional command elements, depending upon the specific command.

parameter

Identifies an IMS-defined value or an installation-defined or created resource. Most parameters can end with a wildcard (an asterisk - *). Parameters are listed in parentheses and must be replaced with parameter values. Multiple parameters are separated by a comma.

When a keyword and a keyword parameter are specified in the format KEYWORD(parameter), the parameter can include embedded blanks, commas, and parentheses. However, if parentheses are embedded in the parameter, the parentheses must be paired and properly nested. For example, KEYWORD(ABC(DEF)) is valid, but KEYWORD(ABC(DEF) is invalid.

If an optional keyword is specified without any parameters listed within the parentheses, the keyword is assigned a null value and is treated as if the keyword was not specified at all.

Generic parameters

You can use generic parameters to specify a group of resources whose names match a 1- to 8-character alphanumeric mask. Generic parameters apply to both type-1 and type-2 commands.

A generic parameter can include one or more of the following wildcard characters:

*

Matches zero or more characters. When used alone, it matches all the names for the keyword or resource.

%

Matches exactly one character.

The following examples illustrate some uses of wildcard characters:

CO*

Matches any string of any length that begins with CO. For instance: CO, COO, COOP

%%S

Matches any 3-character string that ends with S. For instance: IMS, XYS

CO*%%1

Matches any string of 5 or more characters that starts with CO, ends with 1, and has at least 2 characters between CO and 1. For instance: CONV1, CONV21, CONV221, CONV23B1

Specifying an asterisk alone as the generic parameter (such as NAME(*)) is equivalent to specifying ALL (such as NAME(ALL)). However, depending on the installation, other generic parameters can mean ALL. For example, the generic parameter %%%% means ALL to an installation whose resource names are all 4 characters long. Some commands support NAME(*) and do not support NAME(ALL) for a wildcard name.

When a generic parameter is used, IMS uses a serial search of all resources to match the generic name. Using a serial search of all resources can have performance implications in larger systems.

The following table lists some of the type-2 commands and keywords that support generic parameters.