|
|
|
|
The deactivate_session command requests SNAP-IX to deactivate one or more sessions using a particular local LU/mode/partner LU combination.
To identify a local LU/mode/partner LU combination specify the following:
Specify the local LU using either the lu_name or the lu_alias parameter. If neither are specified then the LU associated with the CP (the default LU) is used.
Specify the mode.
Specify the remote LU using either the fqplu_name or the plu_alias parameter.
To deactivate a particular session using the specified local LU/mode/partner LU combination, specify its session identifier. If no session identifier is specified then all sessions using the specified local LU/mode/partner LU are deactivated.
This command must be issued to a running node.
Parameter name Type Length Default [deactivate_session] lu_name character 8 (null string) lu_alias character 8 (null string) session_id hex number 8 0x0 plu_alias character 8 (null string) mode_name character 8 type constant DEACT_NORMAL sense_data hex number 4 0x0 fqplu_name character 17 (null string)
Supplied parameters are:
LU name of the local LU. This name is a type-A character string. To indicate that the LU is defined by its LU alias instead of its LU name, do not specify this parameter.
LU alias of the local LU. This alias is a character string using any locally displayable characters. This parameter is used only if lu_name is not specified.
If lu_name and lu_alias are not specified, the command is forwarded to the LU associated with the CP (the default LU).
An 8-byte identifier of the session to deactivate. If you do not specify this parameter, SNAP-IX deactivates all sessions for the LU-MODE-LU combination.
An error code is not returned when the specified session ID does not match the session ID of an active session (implying that the session has already been deactivated).
LU alias of the partner LU. This alias is a character string using any locally displayable characters. To indicate that the partner LU is defined by its fully qualified LU name instead of its LU alias, do not specify this parameter.
Name of the mode to be used by the LUs. This name is a type-A character string starting with a letter.
Type of deactivation. Possible values are:
Deactivate the session immediately, without waiting for a response from the partner LU.
Do not deactivate the session until all conversations using the session have ended.
If type is set to
Fully qualified name of the partner LU. Specify 3-17 type-A characters that consist of a 1-8 character network name, followed by a period, followed by a 1-8 character partner LU name.
This parameter is used only if the plu_alias parameter is not specified; it is ignored if plu_alias is specified.
No parameters are returned by SNAP-IX when this command executes successfully.
If the command cannot be executed, SNAP-IX 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.
If the command does not execute because of a parameter error, SNAP-IX returns the following parameters:
PARAMETER_CHECK
Possible values are:
The type parameter was not set to a valid value.
The lu_alias parameter did not match any defined LU alias.
The lu_name parameter did not match any defined LU name.
The mode_name parameter did not match any defined mode name.
The fqplu_name parameter did not match any defined partner LU name.
No specific state errors, other than those listed in Common Return Codes from snaadmin Commands, occur for this command.
Common Return Codes from snaadmin Commands, lists combinations of primary and secondary return codes that are common to all commands.
|
|
|
 |
|