RESET_SESSION

The RESET_SESSION_LIMIT verb requests SNAplus2 to reset the session limits for a particular LU-LU-mode combination. Sessions may be deactivated as a result of processing this verb.

VCB Structure

typedef struct reset_session_limit
{
   AP_UINT16       opcode;                 /* verb operation code            */
   unsigned char   reserv2;                /* reserved                       */
   unsigned char   format;                 /* reserved                       */
   AP_UINT16       primary_rc;             /* primary return code            */
   AP_UINT32       secondary_rc;           /* secondary return code          */
   unsigned char   lu_name[8];             /* local LU name                  */
   unsigned char   lu_alias[8];            /* local LU alias                 */
   unsigned char   plu_alias[8];           /* partner LU alias               */
   unsigned char   fqplu_name[17];         /* fully qualified partner LU name*/
   unsigned char   reserv3;                /* reserved                       */
   unsigned char   mode_name[8];           /* mode name                      */
   unsigned char   mode_name_select;       /* select mode name               */
   unsigned char   set_negotiable;         /* set max negotiable limit to    */
                                           /*  zero?                         */
   unsigned char   reserv4[8];             /* reserved                       */
   unsigned char   responsible;            /* who is responsible for         */
                                           /*  deactivation                  */
   unsigned char   drain_source;           /* drain source                   */
   unsigned char   drain_target;           /* drain target                   */
   unsigned char   force;                  /* force                          */
   AP_UINT32       sense_data;             /* sense data                     */
} RESET_SESSION_LIMIT;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_RESET_SESSION_LIMIT

lu_name

LU name of the local LU, as defined to SNAplus2. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter than 8 bytes. To indicate that the LU is defined by its LU alias instead of its LU name, set this parameter to 8 binary zeros.

lu_alias

LU alias of the local LU, as defined to SNAplus2. This is an 8-byte ASCII string, using any locally displayable characters, padded on the right with spaces if the name is shorter than 8 bytes. It is used only if lu_name is set to zeros.

To indicate the LU associated with the CP (the default LU), set both lu_name and lu_alias to 8 binary zeros.

plu_alias

LU alias of the partner LU.

This is an 8-byte ASCII string, using any locally displayable characters, padded on the right with spaces if the name is shorter than 8 bytes. To indicate that the partner LU is defined by its fully qualified LU name instead of its LU alias, set this parameter to 8 binary zeros.

fqplu_name

Fully qualified LU name for the partner LU, as defined to SNAplus2. This parameter is used only if the plu_alias field is set to zeros; it is ignored if plu_alias is specified.

The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters.

mode_name

Name of the mode for which to reset session limits. This parameter is ignored if mode_name_select is set to AP_ALL.

This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the name is shorter than 8 bytes.

mode_name_select

Selects whether session limits should be reset on a single specified mode, or on all modes between the local and partner LUs. Possible values are:

AP_ONE: Reset session limits on the mode specified by mode_name.
AP_ALL: Reset session limits on all modes.

set_negotiable

Specifies whether the maximum negotiable session limit for this LU-LU-mode combination should be reset to zero. (The current limit may be the limit specified for the mode, or may have been changed by initialize_session_limit or change_session_limit). Possible values are:

AP_YES: Reset the maximum negotiable session limit for this LU-LU-mode combination to zero so that sessions cannot be activated until it is changed by INITIALIZE_SESSION_LIMIT.
AP_NO: Leave the maximum negotiable session limit unchanged.

responsible

Indicates whether the source (local) or target (partner) LU is responsible for deactivating sessions after the session limit is reset. Possible values are:

AP_SOURCE: The local LU is responsible for deactivating sessions.
AP_TARGET: The partner LU is responsible for deactivating sessions.

drain_source

Specifies whether the source LU satisfies waiting session requests before deactivating a session. Possible values are:

AP_YES: Waiting session requests are satisfied.
AP_NO: Waiting session requests are not satisfied.

drain_target

Specifies whether the target LU satisfies waiting session requests before deactivating a session. Possible values are:

AP_YES: Waiting session requests are satisfied.
AP_NO: Waiting session requests are not satisfied.

force

Specifies whether session limits will be set to zero even if CNOS negotiation fails. Possible values are:

AP_YES: Session limits will be set to zero.
AP_NO: Session limits will not be set to zero if CNOS negotiation fails.

Returned Parameters: Successful Execution

If the verb executes successfully, SNAplus2 returns the following parameters:

primary_rc

AP_OK

secondary_rc

Possible values are:

AP_FORCED: The session limits were set to zero even though CNOS negotiation failed.
AP_AS_NEGOTIATED: The session limits were changed, but one or more values were negotiated by the partner LU.
AP_AS_SPECIFIED: The session limits were changed as requested, without being negotiated by the partner LU.

Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

Possible values are:

AP_EXCEEDS_MAX_ALLOWED: A SNAplus2 internal error occurred.
AP_INVALID_LU_ALIAS: The lu_alias parameter did not match any defined local LU alias.
AP_INVALID_LU_NAME: The lu_name parameter did not match any defined local LU name.
AP_INVALID_MODE_NAME: The mode_name parameter did not match any defined mode name.
AP_INVALID_PLU_NAME: The fqplu_name parameter did not match any defined partner LU name.
AP_INVALID_MODE_NAME_SELECT: The mode_name_select parameter was not set to a valid value.
AP_INVALID_DRAIN_SOURCE: The drain_source parameter was not set to a valid value.
AP_INVALID_DRAIN_TARGET: The drain_target parameter was not set to a valid value.
AP_INVALID_FORCE: The force parameter was not set to a valid value.
AP_INVALID_RESPONSIBLE: The responsible parameter was not set to a valid value.
AP_INVALID_SET_NEGOTIABLE: The set_negotiable parameter was not set to a valid value.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

Returned Parameters: State Check

If the verb does not execute because of a state error, SNAplus2 returns the following parameters.

primary_rc

AP_STATE_CHECK

secondary_rc

AP_MODE_RESET: No sessions are currently active for this LU-LU-mode combination. Use INITIALIZE_SESSION_LIMIT instead of RESET_SESSION_LIMIT to specify the limits.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.

Returned Parameters: Session Allocation Error

If the verb does not execute because of a session allocation error, SNAplus2 returns the following parameters:

primary_rc

AP_ALLOCATION_ERROR

secondary_rc

AP_ALLOCATION_FAILURE_NO_RETRY: A session could not be allocated because of a condition that requires corrective action. Check the sense_data parameter and any logged messages to determine the reason for the failure, and take any action required. Do not attempt to retry the verb until the condition has been corrected.

sense_data

The SNA sense data associated with the allocation failure.

Returned Parameters: CNOS Processing Errors

If the verb does not execute because of an error, SNAplus2 returns the following parameters.

primary_rc

AP_CONV_FAILURE_NO_RETRY: The session limits could not be changed because of a condition that requires action (such as a configuration mismatch or a session protocol error). Check the SNAplus2 log file for information about the error condition, and correct it before retrying this verb.

primary_rc

AP_CNOS_PARTNER_LU_REJECT: The verb failed because SNAplus2 failed to negotiate the session limits with the partner. Check configuration at both the local LU and partner LU.

secondary_rc

AP_CNOS_COMMAND_RACE_REJECT: The verb failed because the specified mode was being accessed by another administration program (or internally by the SNAplus2 software) for session activation or deactivation, or for session limit processing. The application should retry the verb, preferably after a timeout to allow the race condition to be cleared.

Returned Parameters: Other Conditions

Appendix A “Common Return Codes” lists further combinations of primary and secondary return codes that are common to all NOF verbs.

RESET_SESSION_LIMIT

Technical documentation

» Table of Contents

» Index

VCB Structure

Supplied Parameters

Returned Parameters: Successful Execution

Returned Parameters: Parameter Check

Returned Parameters: State Check

Returned Parameters: Session Allocation Error

Returned Parameters: CNOS Processing Errors

Returned Parameters: Other Conditions