WAN Manager SPI Programming Guide

WAN Manager SPI Programming Guide—540013-001
5-1
5
WAN Manager Commands and
Responses
This section describes WAN manager commands and relevant tokens. Some tokens
whose values are predetermined and do not vary with the commands are not listed.
These tokens (for example, ZSPI-TKN-SSID) are explained in Section 4, Commands
and Response Tokens. The tokens ZSPI-TKN-COMMAND, ZSPI-TKN-OBJECT-TYPE,
and ZCOM-TKN-OBJNAME are all required (!r) command buffer tokens apart from
the header tokens. These common tokens are described in Section 4, Commands and
Response Tokens.
The commands described in this section enable applications to:
•
Add objects such as ADAPTER, SERVER, PATH, IOP, TASK, and PROFILE
•
Alter the attributes of objects
•
Delete objects
•
Obtain the values of attributes of objects
•
Abort or stop objects
•
Obtain the status of an object or a group of objects
Command Buffer Sizes
Command buffers whose sizes do not exceed the value ZWAN_VAL_MAXBUFLEN are
accepted by the WAN manager. An attempt to send longer buffers might cause the
rejection of the request. The response buffer size should at least equal the value of
ZWAN_VAL_BUFLEN. Otherwise, minimum responses cannot be accommodated.
Addressed and Target Objects
An addressed object is the object specified in a command. A target object is the object
on which the command actually operates. The addressed and target objects are
usually the same.
For example, if the ABORT command is issued with an addressed object type of
ZCOM-OBJ-ADAPT, and ZCOM-TKN-SUB contains ZCOM-VAL-SUB-ONLY, the
ADAPT object is the addressed object, and the objects subordinate to the ADAPT
object are the target objects. In the case of a ZCOM-TKN-SUB value of
ZCOM-VAL-SUB-ALL, the addressed ADAPT object is a target object, along with all
Note. When ZCOM-TKN-SUB is used in a command, the addressed and target objects might
not be equivalent.