X25AM Management Programming Manual

Commands and Responses
X25AM Management Programming Manual—528037-001
6-93
LISTOBJECTS Command (Lines or Subdevices)
(ZSPI-TKN-) MAXRESP, CONTEXT
,
RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT
are standard SPI tokens described in the SPI Programming Manual. With the
exception of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are not
allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST
is a standard SPI data list, as described in the SPI Programming Manual. The list
ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME
is an object-name token that contains the name of a line or subdevice that is
known to the X25AM subsystem. If there is no error, this token is present in every
response record.
If ZCOM-TKN-OBJTYPE contains the value ZCOM-OBJ-LINE, this token contains
a line name, and it occurs only once in the response record. This token is returned
if the object type in the command is ZCOM-OBJ-LINE and either the token ZCOM-
TKN-SUB is not present in the command, or it is present and it has a value other
than ZCOM-VAL-SUB-ONLY.
If ZCOM-TKN-OBJTYPE contains the value ZCOM-OBJ-SU, this token contains a
subdevice name, and it can occur multiple times in the response record. This token
is returned in the following two situations:
1. The object type in the command is ZCOM-OBJ-SU.
2. The object type in the command is ZCOM-OBJ-LINE and the token ZCOM-
TKN-SUB is present and has the value ZCOM-VAL-SUB-ONLY or ZCOM-VAL-
SUB-ALL.
ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions
.
ZCOM-TKN-OBJTYPE
is an object-type token that indicates the type of the object or objects named in
ZCOM-TKN-OBJNAME. This token can have the following values:
ZCOM-TKN-OBJTYPE is present in every response record, and it is described in
the SPI Common Extensions Manual.
ZSPI-TKN-RETCODE
is the standard SPI return token described in the SPI Programming Manual.
ZCOM-OBJ-LINE The object is a line.
ZCOM-OBJ-SU The object or objects are subdevices.