PAM Management Programming Manual

Commands and Responses
PAM Management Programming Manual—142481
5-4
ABORT Command
Tokens in Response Buffer
The tokens present in the buffer received in response to an ABORT command are also
described in Section 4, Common Definitions.
Operational Notes
There are several things you should remember when using the ABORT command:
•
You can use the ZCOM-TKN-SUB token to abort the operation of the specified
object and/or its subordinate objects, if any. The values for this token are
•
ZCOM-VAL-SUB-ALL aborts the operation of the specified object and its
subordinate objects, if any.
•
ZCOM-VAL-SUB-NONE aborts the operation of the specified object but does
not affect the operation of subordinate objects. All subordinate objects must be
in the STOPPED summary state when you use the SUB-NONE modifier.
•
ZCOM-VAL-SUB-ONLY aborts the operation of subordinate objects but does
not affect the operation of the specified object.
•
You can use the ZCOM-TKN-SEL-SUMSTATE token to apply the ABORT
command to 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 abort the operation of only those objects and/or
subordinate objects that are currently in the STARTED summary state.
•
When LLC2 ports are aborted, they are automatically deleted and cease to exist.
•
The ABORT command leaves objects in the STOPPED 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), an informational warning, or an error.
Errors or warnings that can occur in response to the ABORT command are
ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE
is a warning that is returned if the specified object is already in the STOPPED
summary state, which is normally the end result of an ABORT command.
ZPAM-ERR-STOP-SUB-OBJ
is an error that is returned if the specified object still has subordinate objects in
summary state(s) other than the STOPPED summary state. You must specify the
SUB-ALL modifier to abort the specified object and all of its subordinate
objects.