PAM Management Programming Manual

Commands and Responses
PAM Management Programming Manual—142481
5-68
STOP Command
Operational Notes
There are a number of things you should remember when using the STOP command:
•
The STOP command stops the PAM process (it will no longer run).
•
You can use the ZCOM-TKN-SUB token to stop the operation of the specified
object and/or subordinate objects. The acceptable values for this token are as
follows:
ZCOM-VAL-SUB-ALL
stops the operation of the specified object and its subordinate objects, if any.
ZCOM-VAL-SUB-NONE
stops the operation of only the specified object and does not affect the operation
of any subordinate objects.
ZCOM-VAL-SUB-ONLY
stops the operation of only subordinate objects and does not affect the operation
of the specified object.
•
You can use the ZCOM-TKN-SEL-SUMSTATE token to stop only those objects
that are currently in the STARTED summary state.
•
You can use both the ZCOM-TKN-SUB and the ZCOM-TKN-SEL-SUMSTATE
tokens, in combination, to stop the operation of only those objects and/or
subordinate objects in (or not in) the STARTED summary state.
•
The STOP command leaves objects in the STOPPED summary state. When
stopping an object takes a long time to complete, the response from a STATUS
command will report the STOPPING summary state.
Error Handling Notes
ZSPI-TKN-RETCODE is the standard SPI return code token, whose value is a number
identifying successful completion (ZCOM-ERR-OK) or an error. Errors that can occur
in response to the STOP command are as follows:
ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE
is returned if the specified object is already in the STOPPED summary state, which
is normally the end result of the STOP command.
ZPAM-ERR-STOP-SUB-OBJ
is returned if a STOP command is received while the specified object still has
subordinate objects in summary states other than STOPPED. You must specify the
SUB-ALL modifier to stop the specified object and all of its subordinate objects.