SNAP-IX Administration Command Reference - 2.6 deactivate_conv

2.6 deactivate_conv_group

The deactivate_conv_group command requests SNAP-IX to deactivate the session corresponding to the specified APPC conversation group. Although this command is available within the command-line administration program, deactivating a session identified by its conversation group is more usually done using the NOF verb DEACTIVATE_CONV_GROUP from within an APPC TP. The conversation group identifier is returned by the APPC verbs [MC_]ALLOCATE, [MC_]GET_ATTRIBUTES, and RECEIVE_ALLOCATE.

This command must be issued to a running node.

2.6.1 Supplied Parameters

Parameter name                    Type           Length     Default
[deactivate_conv_group]
lu_name                           character      8          (null string)
lu_alias                          character      8          (null string)
conv_group_id                     decimal
type                              constant                  DEACT_NORMAL
sense_data                        hex number     4          0x0

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

conv_group_id

Conversation group identifier for the session to be deactivated.

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.

2.6.2 Returned Parameters

No parameters are returned by SNAP-IX when this command executes successfully.

2.6.3 Error Return Codes

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.

Parameter Check

If the command does not execute because of a parameter error, SNAP-IX returns the following parameters:

primary_rc

PARAMETER_CHECK

secondary_rc

Possible values are:

DEACT_CG_INVALID_CGID: The conv_group_id parameter did not match any valid conversation group ID.
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.

State Check

No specific state errors, other than those listed in Common Return Codes from snaadmin Commands, occur for this command.

Other Conditions

Common Return Codes from snaadmin Commands, lists combinations of primary and secondary return codes that are common to all commands.