PAM Management Programming Manual

Commands and Responses

PAM Management Programming Manual—142481

5-2

Command Descriptions

Each PAM programmatic command and its response is described in detail in this section.

The command descriptions are presented in alphabetical order; for commands that can

be applied to more than one object type, a separate description is given for each

command object-type pair.

Syntax Notation

Each command description includes a syntax box that names (in DDL form) the

command, the object type, the tokens in the command buffer, and the tokens in the

response buffer. Following the syntax box are descriptions of the tokens in the command

and the response, in the same order in which the tokens are listed in the box. Any special

considerations (operational notes) for this command are given.

The following values my appear to the right of a token in the syntax box:

If no value appears to the right of a token, this indicates that the token is optional.

The syntax notation used for simple tokens is a shorthand version of the information

given in the DDL TOKEN-CODE statement. The notation used for extensible structured

tokens gives the token map name first, followed by the DDL DEF statement declaring

the corresponding structure, which shows the structure’s fields and their types.

Each required field of an extensible structured token must have a value other than its

null value. Optional fields can have a value other than the field’s null value, but it is not

required. When a command or response uses one or more extensible structured tokens

(maps) for multiple objects, the DDL DEF statements and the explanations of the

individual fields associated with those tokens are provided in alphabetical order by

object type following the general explanation of the command or response.

STOP Yes X X X X

SWITCH Yes X

TRACE Yes X

!{A} Indicates that the token is one of several alternatives. You must

specify one of the alternatives shown.

!r Indicates that the token is required.

!-IP Indicates that the token is required only if the previous token is

set to TRUE.

!object-type Indicates that the token is applicable only to the specified object

type.

Table 5-1. PAM Programmatic Commands and Object Types (page 2 of 2)

Object Type

Programmatic

Command

Sensitive

Command LINE MSAP PORT PROCESS SESSION