PAM Management Programming Manual
SPI Programming Considerations for the PAM
Subsystem
PAM Management Programming Manual—142481
3-5
Object Names
Object Names
Most PAM commands and responses contain object-name tokens that, when combined
with the object-type information, designate which objects are to be or were affected by
the command. Most PAM commands accept up to 30 object names. Object-name
templates and the subordinate names option are supported.
In the management programming interface to the PAM subsystem, object names are in
three formats:
•
PROCESS or LINE name (for example, $PAM1)
•
LINE name and PORT name (for example, $PAM1.#ENET)
•
LINE name, PORT name, and SESSION name (for example,
$PAM1.#PORT1.SESSION1)
For more information on object names, refer to Section 1, Introduction
.
Event Numbers
All event messages contain a header token identifying the event by number. This event
number, in combination with the SSID header token, uniquely identifies the kind of
event being reported. Event numbers for event messages defined by the PAM subsystem
are identified in programs by symbolic names having the form ZPAM-EVT-name, where
name identifies the event being reported.
In these event numbers, the event-number header token (ZEMS-TKN-
EVENTNUMBER) can assume any one of the set of event numbers from the PAM
subsystem. The PAM subsystem event messages are described in Section 6, Event
Messages.
Subjects of Event Messages
An event message subject token is the token that immediately follows the ZEMS-TKN-
SUBJECT-MARK token. In PAM event messages, the subject token is ZPAM-TKN-
FNAME (the line name). To retrieve the subject token, you must first call EMSGET
with the token code ZEMS-TKN-SUBJECT-MARK to get the token code and index of
the subject token. Then call EMSGET again with this token code and index to get the
value of the subject token.
Other Tokens
In addition to the tokens already described, the PAM subsystem uses other tokens as
command parameters, results in responses, and elements of event messages and error
lists.