EMS Manual

Collector Commands and Responses
EMS Manual—426909-005
19-27
Common Definitions of ZEMS- Commands
ZEMS-TKN-EVT-GENTIME
is a token of the type ZSPI-TYP-TIMESTAMP that contains the generation
timestamp of the event being examined when a PLF error occurred. This token is
stored in the ZEMS-TKN-FILTER-ERROR event.
ZEMS-TKN-NEW-OBJNAME
is a token of the type ZSPI-TYP-STRING that contains the fully qualified name of a
new object. This token is used in the ZEMS-CMD-REPLACE command where it
contains the name of the filter that is to replace the filter specified in the ZCOM-
TKN-OBJNAME token.
ZEMS-TKN-ZOPR-CMD
is a token of the type ZSPI-TYP-ENUM that is put into a SPI reply when an error
occurs during communication with the $ZOPR process. The value stored in this
token is the specific $ZOPR command.
Common Definitions of ZEMS- Commands
This subsection defines the tokens and error numbers common to the older, basic SPI-
compliant collector commands: ZEMS-CMD-CONTROL, ZEMS-CMD-STATUS, ZEMS-
CMD-GETVERSION, and ZEMS-CMD-STOP.
Common Tokens for ZEMS- Commands
Tokens common to all of these SPI commands are defined here in alphabetical order.
All SPI commands use additional tokens defined with the command in which they are
used.
Token types abbreviated in italics represent SPI types. For example, int represents
ZSPI-TYP-INT.
ZSPI-TKN-COMMAND (type enum)
is the standard SPI token for defining the command to be executed. It is contained
in both the request and reply buffers. It can have these values for the primary and
alternate collector:
ZEMS-CMD-GETVERSION 0
ZEMS-CMD-STATUS 1
ZEMS-CMD-CONTROL 2
ZEMS-CMD-STOP 9 (alternate collector only)
ZSPI-TKN-RETCODE (type enum)
is the standard SPI return token. For ZEMS-TKN-RETCODE values and related
information, see Common ZSPI-TKN-RETCODE Values on page 19-28.