EMS Manual

Distributor Commands and Responses
EMS Manual—426909-005
17-7
Common Response Tokens for ZCOM- Commands
ZCOM-TKN-OBJNAME
specifies the fully qualified name of the object to be selected for processing. At
least one of these tokens must be in the command. Multiple occurrences of this
token (with different object names) are allowed only for the ZCOM-CMD-ADD and
ZCOM-CMD-DELETE commands. A ZCOM-CMD-STATUS command with a wild-
card object name can have multiple responses. If it does, all occurrences are
returned and encapsulated in a data list if MAXRESP is nonzero. This process
deviates from the SPI common extension standards that are observed by EMS
collectors. For EMS distributors, multiple response buffers with context tokens are
not supported.
When more than one object name is specified, the same command is applied to all
of the named objects. If different actions are desired on each named object, you
must use separate commands. These examples illustrate these guidelines:

To change the GENTIME setting for distributor $dist1 from 8:00 to 9:00, use a
ZCOM-CMD-ALTER command (where the object type is ZCOM-OBJ-DIST and
the -OBJNAME value is $dist1) and one -DIST-CONTROL token map with the
GENTIME stamp set to 9:00.

To add event sources $0 and \tsii.$0 to distributor $dist2, use a ZCOM-CMD-
ADD command (where the object type is ZCOM-OBJ-SOURCE) and two -
OBJNAME tokens with the values $0 and \tsii.$0, respectively. Because the
command is sent to $dist2, there is no ambiguity as to which main object, with
its subordinate object, the command applies.
Common Response Tokens for ZCOM- Commands
Note. When an object type is ZCOM-OBJ-DIST, only one object name is allowed. For
example, the ZEMS-CMD-ALTER command can only affect a single distributor.
Table 17-7. Common Response Tokens for ZCOM- Distributor Commands
Response Token Token Type Special Usage
ZSPI-TKN-COMMAND ZSPI-TYP-ENUM SSINIT
ZSPI-TKN-OBJECT-TYPE ZSPI-TYP-ENUM SSINIT
ZSPI-TKN-SSID ZSPI-TYP-SSID SSINIT
ZSPI-TKN-SERVER-VERSION ZSPI-TYP-VERSION SSINIT
ZSPI-TKN-DATALIST ZSPI-TYP-LIST Basic SPI
ZCOM-TKN-RETCODE ZSPI-TYP-INIT Unconditional
ZSPI-TKN-ERRLIST ZSPI-TYP-LIST Error only
ZSPI-TKN-ERROR ZSPI-TYP-ERROR Error only
ZSPI-TKN-ENDLIST ZSPI-TYP-SSCTL Error only
ZSPI-TKN-ENDLIST ZSPI-TYP-SSCTL Basic SPI