PAM Management Programming Manual

Commands and Responses
PAM Management Programming Manual—142481
5-28
LISTOBJECTS Command
Operational Notes
•
The ZCOM-TKN-OBJNAME token can contain a specific object name or an object-
name template, be zero length, or be absent. In some cases, only the object type
and/or a single object name are listed because there is only one such object in a
PAM subsystem. However, in most cases the ZCOM-TKN-OBJNAME token
contains an object-name template, and all objects that meet the template
requirements are listed in the response. If the ZCOM-TKN-OBJNAME token has a
zero length or is not present, all object names that correspond to the specified object
type are returned in the response.
•
Regardless of the number of objects to which the LISTOBJECTS command applies,
each object is returned in a separate data list.
•
You can use the ZCOM-TKN-SUB token to limit the number of objects to the
specified object and/or subordinate objects. The acceptable values for this token are
as follows:
ZCOM-VAL-SUB-ALL
lists the specified object and its subordinate objects, if any.
ZCOM-VAL-SUB-NONE
lists only the specified object and not any subordinate objects. This has the same
effect as not having the ZCOM-TKN-SUB token present.
ZCOM-VAL-SUB-ONLY
lists only subordinate objects and not the specified object itself.
•
You can use the ZCOM-TKN-SEL-SUMSTATE token to list only those objects that
are currently in a specified summary state.
•
You can use the ZCOM-TKN-SUB and the ZCOM-TKN-SEL-SUMSTATE tokens,
in combination, to list only those objects and/or subordinate objects in (or not in) a
specified summary state.
•
There is no summary state transition associated with the LISTOBJECTS command.
Error-Handling Notes
ZSPI-TKN-RETCODE is the standard SPI return-code token, whose value is a number
identifying successful completion (ZCOM-ERR-OK) or an error. There are no unique
errors that can occur in response to the LISTOBJECTS command.