deactivate_session

The deactivate_session command requests SNAplus2 to deactivate a particular session, or all sessions on a particular mode.

This command must be issued to a running node.

Supplied Parameters

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

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

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).

session_id

An 8-byte identifier of the session to deactivate. If you do not specify this parameter, SNAplus2 deactivates all sessions for the partner LU and mode.

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).

plu_alias

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.

mode_name

Name of the mode to be used by the LUs. This name is a type-A character string starting with a letter.

type

Type of deactivation. Possible values are:

DEACT_CLEANUP: Deactivate the session immediately, without waiting for a response from the partner LU.
DEACT_NORMAL: Do not deactivate the session until all conversations using the session have ended.

sense_data

If type is set to DEACT_CLEANUP, the sense_data parameter specifies the sense data to be used when deactivating the session (specified as a 4-byte hexadecimal number preceded by 0x, for example 0x84000007). Otherwise, this parameter is not used.

fqplu_name

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.

Returned Parameters

No parameters are returned by SNAplus2 when this command executes successfully.

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

Possible values are:

INVALID_CLEANUP_TYPE: The type parameter was not set to a valid value.
INVALID_LU_ALIAS: The lu_alias parameter did not match any defined LU alias.
INVALID_LU_NAME: The lu_name parameter did not match any defined LU name.
INVALID_MODE_NAME: The mode_name parameter did not match any defined mode name.
INVALID_PLU_NAME: The fqplu_name parameter did not match any defined partner LU name.

State Check

No specific state errors, other than those listed in Appendix A “Common Return Codes from snapadmin Commands” occur for this command.

Other Conditions

Appendix A “Common Return Codes from snapadmin Commands” lists combinations of primary and secondary return codes that are common to all commands.