X25AM Management Programming Manual

Commands and Responses
X25AM Management Programming Manual—528037-001
6-4
Command Descriptions
Nonsensitive commands do not change the summary state of an object, and these
commands can be issued by any user.
The following X25AM commands are nonsensitive commands:
Command Descriptions
On the following pages, each X25AM command and its response is described in detail.
The command descriptions appear in alphabetical order.
Within each command description, there is a box that contains the symbolic name of
the command number, the symbolic names of all object types accepted by the
command, a list of tokens that can be present in the command buffer, and a list of
tokens that can be present in the response buffer.
With the exception of the tokens ZSPI-TKN-DATALIST and ZSPI-TKN-ENDLIST, the
order of the tokens in the lists of tokens in the command buffer and response buffer is
not necessarily the order in which they will actually appear in a command or response.
The token ZSPI-TKN-DATALIST, if present in a response, always appears at the
beginning of a response record. The token ZSPI-TKN-ENDLIST always appears at the
end of a response record started by the token ZSPI-TKN-DATALIST or of a list started
by the token ZSPI-TKN-ERRLIST.
The list of tokens in the response buffer, except for the context token ZSPI-TKN-
CONTEXT, represents the tokens that can be present in one response record of a
response that consists of multiple response records. For more information on such
responses, and for information on the context token, see the SPI Programming
Manual.
The notation used in the box for simple tokens is a shorthand version of the essential
information given in the DDL TOKEN-CODE statement. Extensible structured tokens
are defined by using DDL DEF statements.
For each token in the command buffer, and for each field of an extensible structured
token in the command buffer, the box contains an indication of whether or not the token
or field must be present in the command. For a token, the notation "!{}" means that the
token must be present (is required) in the command, the notation !{A} means that you
must choose only one of the set of tokens indicated by !{A}, and no notation means
that the token may or may not be present (is optional) in the command. For a field of
an extensible structured token, the notation "!{}" means that the field must have a value
ALTER STOP
DELETE SWITCH
DISCONNECT TRACE
GETVERSION STATISTICS
INFO STATUS
LISTOBJECTS