EMS Manual

Collector Commands and Responses
EMS Manual—426909-005
19-4
Common Definitions of ZCOM- Commands
Common Definitions of ZCOM- Commands
This subsection defines the tokens and error numbers common to the ZCOM-collector
commands and the ZEMS-CMD-REPLACE command. While the REPLACE command
is not extended SPI compliant, it supports filter objects (ZCOM-OBJ-FILTER) and you
can use it to replace a configured filter in an EMS collector with another filter.
The ZCOM- collector commands provide functional support for burst detection and
suppression (BDS) and pre-log filtration (PLF) that the basic ZEMS- commands do not
provide. These commands let collectors support multiple objects or field-level wild-card
objects and return multiple response records (one per object instance) where
appropriate. Supported object types are collector (ZCOM-OBJ-COLL) and filter
(ZCOM-OBJ-FILTER).
For ZCOM- collector commands that support the ZCOM-TKN-SUB token, an object
hierarchy exists. In these cases, ZCOM-OBJ-FILTER is considered subordinate to
ZCOM-OBJ-COLL. Hierarchical names are not allowed; however, object name
ambiguity is not likely because collector object names are process names, and filter
object names are file names.
Table 19-2 shows which ZCOM- commands (and the ZEMS-CMD-REPLACE
command) you can issue for filter and collector objects, whether wild-card (*) objects
are supported, and whether the ZCOM-TKN-SUB modifier token is supported. Values
in the ZCOM-OBJ-COLL and ZCOM-OBJ-FILTER columns mean:

Yes signifies that the command supports the associated object type; No signifies
that the command does not support the associated object type.

Only 1 signifies that only one of that object type is supported; >=1 signifies that
more than one of that object type is supported; NO OBJNAME signifies that the
object name need not be specified; * signifies that wild-card object types are
supported.

SUB signifies that the command supports the ZCOM-TKN-SUB modifier token.
Table 19-2. ZCOM- Command Capabilities
Collector Command ZCOM-OBJ-COLL ZCOM-OBJ-FILTER
ZCOM-CMD-ADD No Yes, >=1
ZCOM-CMD-ALTER Yes, Only 1 Yes, Only 1
ZCOM-CMD-DELETE No Yes, >=1
ZCOM-CMD-GETVERSION No No
ZCOM-CMD-INFO Yes, >=1, *, SUB Yes, >=1, *, SUB
ZCOM-CMD-LISTOBJECTS Yes, NO OBJNAME YES, NO OBJNAME
ZEMS-CMD-REPLACE No Yes, Only 1
ZCOM-CMD-STATUS Yes, >=1, *, SUB Yes, >=1,* SUB
ZCOM-CMD-STOP Yes, Only 1 No