EMS Manual

Collector Commands and Responses
EMS Manual—426909-005
19-61
STOP Command (ZEMS-CMD-STOP)
Tokens in Response Buffer
ZSPI-TKN-SERVER-VERSION (type uint)
is the subsystem version number of the EMS collector.
ZSPI-TKN-COMMAND (type enum)
is the original command.
ZSPI-TKN-SSID (type ssid)
contains ZSPI-SSN-ZEMS, the subsystem ID for the Event Management Service.
ZSPI-TKN-RETCODE (type enum)
is the standard SPI return token. A zero value for this token signals the successful
execution of the command. A nonzero value signals that the command failed. For a
list of the values that can be returned in ZSPI-TKN-RETCODE, see Error-Handling
Notes on page 19-61.
Error-Handling Notes
The STOP command returns two error codes in ZSPI-TKN-RETCODE. One of these
error codes, ZEMS-ERR-LOGGING-STOPPED, is unique to the STOP command.
Table 19-9 shows the names and numbers of ZSPI-TKN-RETCODE values specific to
the STOP command.
Tokens in Response Buffer
ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-UINT.
ZSPI-TKN-COMMAND token-type ZSPI-TYP-ENUM.
ZSPI-TKN-SSID token-type ZSPI-TYP-SSID.
ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM.
Table 19-9. Values of ZSPI-TKN-RETCODE Specific to STOP Command
Name (ZEMS-ERR-) Number Description
ACC-VIOL 1048 Requester's user ID is not allowed to use the STOP
command. ZSPI-TKN-ERROR is returned in the
response error list.
LOGGING-STOPPED 1057 Alternate collector is currently holding events in the
event-buffer pool and cannot write them to disk
because logging has stopped.