EMS Manual

Collector Commands and Responses
EMS Manual426909-005
19-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. If there are multiple
occurrences of this token, the collector returns a response record for each -
OBJNAME token. The basic SPI command language rules about returning multiple
response records are followed: the -CONTEXT token indicates when you must use
more than one SPI buffer to return the full command response. When more than
one object name is specified, the same command is applied to all named objects. If
different actions are desired on each named object, then you must use separate
commands.
ZCOM-TKN-SUB
is an optional token used to modify the STATUS and INFO commands. When it is
used, the object hierarchy is assumed to be one where ZCOM-OBJ-COLL is at the
top and ZCOM-OBJ-FILTER is a subordinate to ZCOM-OBJ-COLL. The
permissible values for the ZCOM-TKN-SUB token are:
ZCOM-TKN-SEL-SUMSTATE
ZCOM-TKN-CMD-POWER
ZCOM-TKN-CMD-TIMEOUT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-ALLOW
ZSPI-TKN-COMMENT
if present, these seven tokens are allowed and ignored.
ZSPI-TKN-CONTEXT
is a response continuation indicator. If a response cannot fit into the SPI response
buffer, this token is present in the incomplete response. This token is also required
in the next command to retrieve the remaining response information.
Common Response Tokens for ZCOM- Commands
Table 19-4 summarizes the common response tokens for the extended SPI-compliant
collector commands, their ZSPI token type, and special usage considerations. Detailed
descriptions of these common response tokens and their usage considerations are
provided after the table.
Value Command Applies to...
ZCOM-VAL-SUB-ONLY Only the named object’s subordinates
ZCOM-VAL-SUB-NONE Only the named object
ZCOM-VAL-SUB-ALL Both the named object and its subordinates
ZCOM-OBJ-FILTER Only the named object’s filter objects