PAM Management Programming Manual

Commands and Responses
PAM Management Programming Manual—142481
5-71
SWITCH Command
Tokens in Response Buffer
The tokens present in the response buffer returned for the SWITCH command are
described in Section 4, Common Definitions.
Operational Notes
There are a number of things you should remember when using the SWITCH command:
•
You can use the ZCOM-TKN-SEL-SUMSTATE token to switch only a line that is
currently in the STARTED summary state.
•
If the line is already using the target processor, then no switch occurs and the
SWITCH command returns a warning.
•
If the target processor is the backup but there is no backup processor specified, then
the SWITCH command is rejected.
•
The SWITCH command succeeds only if the line is 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) or an error. Errors that can occur
in response to the SWITCH command are as follows:
ZCOM-ERR-TKN-REQ
is returned when a required token is missing. You must supply all required tokens.
ZCOM-ERR-TKN-VAL-INV
is returned when a specified field (token and offset) has an incorrect value. You must
supply a correct value for this token, in this case probably the value of the ZCOM-
TKN-SWITCH-CPU token. A validation of this value is made before switching
processors. If the value is incorrect, the SWITCH command is rejected without
switching processors.
ZPAM-ERR-SAME-CPU
is returned if the processor of the current primary PAM process is specified as the
target processor in the SWITCH LINE command. You must specify another
processor number.
ZCOM-ERR-RES-NOT-CONFIG
is returned if the target processor specified in a SWITCH LINE command is not
configured as the backup processor, or if the specified processor is down. If the
target processor specified is not configured as the backup processor, an additional
token (ZPAM-TKN-ERR-DETL) is returned that contains the processor number
originally specified (the one that is not configured as the backup processor). Reload
the target processor or determine the correct backup processor for the LINE.