EMS Manual

Collector Commands and Responses
EMS Manual—426909-005
19-2
Sending a SPI Command
A command buffer always contains a command token named ZSPI-TKN-COMMAND,
which specifies the command to be carried out. A command buffer can also contain
additional tokens that define parameters unique to the command being sent.
A response buffer is a group of tokens containing all the information that results when
a command is performed. These tokens are:

A return token. A response buffer always contains a token named ZSPI-TKN-
RETCODE. If a command fails, this token contains an error number indicating the
reason for the failure. This error number is defined by the subsystem that issues
it—in this case, a collector.

One or more tokens that contain requested information or result from the
completed command.
Sending a SPI Command
Your program should perform these steps to send a command and receive the
response:
1. Define the buffer space.
2. Use SSINIT to initialize the buffer space.
3. Use SSPUT to add tokens to the buffer.
4. Use WRITEREAD to send the command buffer to $0 or to an alternate collector.
5. Use SSGET to retrieve tokens from the response buffer.
Summary of EMS Collector Commands
Table 19-1 summarizes the primary and alternate collector commands.
Commands with a ZCOM- prefix are extended SPI compliant. They use the extended
SPI interface, support specific object types (ZCOM-OBJ-COLL, ZCOM-OBJ-FILTER),
and have been designed to handle BDS and PLF information.
Commands with a ZEMS- prefix use and comply with the basic SPI interface. They do
not support specific object types (the object type is ZSPI-VAL-NULL-OBJECT-TYPE),
and generally do not use BDS or PLF information; only the updated fields added to the
ZEMS-MAP-COL-CONTROL and ZEMS-MAP-COL-STATUS token maps used by the
CONTROL and STATUS commands contain BDS and PLF information. The new
ZEMS-CMD-REPLACE command supports filter objects.