EMS Manual

Distributor Commands and Responses
EMS Manual426909-005
17-12
Distributor Command Descriptions
Distributor Command Descriptions
This subsection describes the distributor commands, including both ZCOM- and
ZEMS- types. Each command description includes a summary of the command and
response tokens that are used. Many of these are common command and response
tokens that are described in Common Definitions for ZCOM- Commands on page 17-5
and Common Definitions for ZEMS- Commands on page 17-9.
ADD Command (ZCOM-CMD-ADD)
The ZCOM-CMD-ADD command adds objects to the EMS distributor. Supported
objects for the distributor are ZCOM-OBJ-FILTER, ZCOM-OBJ-SOURCE, and ZCOM-
OBJ-TEXTOUT. If a filter is added, it can be a compiled filter, a filter table, or a burst
filter. A maximum of 10 filters can be added to a single distributor.
If required parameter tokens are specified, these parameter tokens must be included in
the ADD command. If these parameter tokens are optional, including them in the ADD
command is optional.
If an event source is added, it can either be a primary or alternate collector or an event
log file.
If an event destination is added, it can be a terminal, printer, disk file, or process. A
maximum of 10 event sources or event destinations can be added.
Token Usage Considerations
Basic SPI signifies that the presence of this token in the command is dictated by
the basic SPI command language standards that govern multiple objects and
responses.
Note. In the command responses described in this subsection, the ZSPI-TKN-COMMAND,
ZSPI-TKN-OBJECT-TYPE, ZSPI-TKN-SSID, and ZSPI-TKN-SERVER-VERSION tokens are
not listed. Instead, their descriptions, which apply to all command responses, are provided in
Common Response Tokens for ZCOM- Commands
on page 17-7.
Command Tokens
ZSPI-TKN-MAXRESP
ZCOM-TKN-OBJNAME
<filter parameter
token(s)>
Token Type
ZSPI-TYP-INT
ZSPI-TYP-STRING
<token-
dependent>
Usage
Basic SPI
Required
Filter
Response Tokens
ZSPI-TKN-DATALIST
ZCOM-TKN-RETCODE
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZSPI-TKN-ENDLIST
ZSPI-TKN-ENDLIST
Token Type
ZSPI-TYP-LIST
ZSPI-TYP-INIT
ZSPI-TYP-LIST
ZSPI-TYP-ERROR
ZSPI-TYP-SSCTL
ZSPI-TYP-SSCTL
Usage
Basic SPI
Unconditional
Error only
Error only
Error only
Basic SPI