SPI Common Extensions Manual

Commands and Responses
SPI Common Extensions Manual—427508-001
5-4
Common Command Tokens
ZCOM-TKN-OBJNAME
specifies the name or name template that the subsystem uses to select objects for
processing. At least one OBJNAME token must be included in most commands. If
no MANAGER token is included in the command, SCP tries to derive the
subsystem manager process name from the OBJNAME token.
ZCOM-TKN-SUB
is a command modifier specifying that the command should act on a certain subset
of a hierarchy of objects. The token code and token value are assigned to the
command message with SSPUTTKN. This token is optional.
ZCOM-TKN-SEL-SUMSTATE
is a command modifier specifying which objects to act on based on their summary
state. The token code and token value are assigned using the SSPUTTKN
procedure. This token is optional. For a list of defined summary states, see ZCOM-
TKN-SEL-SUMSTATE on page 4-15.
ZCOM-TKN-CMD-POWER
can be included in some commands to specify how forcefully the command should
be applied. The token code and token value are assigned using the SSPUTTKN
procedure. This token is optional. For valid values, see ZCOM-TKN-CMD-POWER
on page 4-3.
ZCOM-TKN-CMD-TIMEOUT
is a command modifier specifying the maximum amount of time, in microseconds,
that the subsystem has to process a command. The token code and token value
are assigned to the command message with SSPUTTKN. If a command is not
completed within this time, the SCP process cancels the command and returns a
response with the error number ZCOM-ERR-CMD-TIMEOUT. If the token is not
included in the command message, the subsystem has forever to process the
command. Therefore, the token should be included in the command message.
subsys-type-name
represents a subsystem-defined token. A syntax description containing this symbol
indicates that subsystem-defined tokens are allowed in that particular command or
response. For descriptions of the specific tokens, see the appropriate subsystem
management programming manual.