NetBatch Management Programming Manual

NetBatch Management Programming Manual—522462-003
5-1
5 Commands and Responses
This section describes the syntax and semantics of all NetBatch programmatic
commands and the responses to those commands. The command descriptions appear
in alphabetic order. For each command, the section gives:
•
The command name
•
A command description
•
A box containing:
°
The symbolic names of the command and the object on which it operates.
°
Lists of the tokens that can be present in the command and response buffers.
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 actually appear in a
command or response, except:
•
The token ZSPI-TKN-DATALIST, if present in a response, always appears
at the beginning of a response record.
•
The token ZSPI-TKN-ERRLIST, if present in a response, always appears
at the beginning of an error list.
•
The token ZSPI-TKN-ENDLIST always appears at the end of a response
record that begins with the token ZSPI-TKN-DATALIST or at the end of an
error list that begins with the token ZSPI-TKN-ERRLIST.
Except for the context token ZSPI-TKN-CONTEXT, the list of tokens in the
response buffer represents the tokens that can be present in one reply
message that consists of a single or multiple response records. For more
information on such responses and on the context token, see the SPI
Programming Manual.
For each token in the command and response buffers, and each field of an
extensible structured token in the command and response buffers, there is
an indication of whether the token must be present in the command and of
other dependencies. For a description of the notation scheme used, see
Notation Conventions on page -xix.
Error lists are indicated by the token ZSPI-TKN-ERRLIST followed by an
ellipsis (…) and the token ZSPI-TKN-ENDLIST. The tokens following token
ZSPI-TKN-DATALIST, including ZSPI-TKN-ERRLIST, are indented to show
they are in the data list. The value of the token ZSPI-TKN-MAXRESP
determines whether data lists are used in the response. For more
information on data lists and error lists, see the SPI Programming Manual.
°
Information about the tokens in the command and response buffers that is not
covered in Section 4, Common Definitions.