Administration Commands
path_switch
2.97 path_switch
The path_switch command requests that SNAplus2 switch a currently active Rapid Transport Protocol (RTP) connection to another path. If SNAplus2 cannot find a better path, it leaves the connection unchanged.
2.97.1 Supplied Parameters
Parameter name | Type | Length |
[path_switch]
rtp_connection_name character 8
Supplied parameter is:
rtp_connection_name
The RTP connection for which a change in path is requested.
2.97.2 Returned Parameters
No parameters are returned by SNAplus2 when this command executes successfully.
2.97.3 Error Return Codes
If the command cannot be executed, SNAplus2 returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.
Parameter Check
If the command does not execute because of a parameter error, SNAplus2 returns the following parameters:
primary_rc
PARAMETER_CHECK
secondary_rc
INVALID_RTP_CONNECTION_NAME_SPECIFIED
The value specified for the rtp_connection_name parameter did not match the name of an existing RTP connection.
State Check
If the command does not execute because of a state error, SNAplus2 returns the following parameters:
primary_rc
STATE_CHECK
secondary_rc
PATH_SWITCH_IN_PROGRESS
SNAplus2 is currently changing the path for the RTP connection specified by the rtp_connection_name parameter.
Path Switch Disabled
If the command does not execute because the RTP partner node has disabled path switch by setting the path switch timer to zero, SNAplus2 returns the following parameter:
primary_rc
293
