DEFINE_ADJACENT_LEN

DEFINE_ADJACENT_LEN_NODE adds entries to the node directory database for an adjacent LEN node and its associated LUs, or adds additional LU entries for a previously-defined LEN node.

This verb is equivalent to a series of DEFINE_DIRECTORY_ENTRY verbs for the LEN node and its associated LUs; it provides a fast method of defining the LEN node's configuration with a single verb. To query the directory entries created by this verb, use QUERY_DIRECTORY_ENTRY.

If the verb is issued to an end node, the LEN node's resources are accessible only to that end node.

VCB Structure

typedef struct define_adjacent_len_node
{
      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     cp_name[17];         /* CP name                      */
      unsigned char     description[32];     /* resource description         */
      unsigned char     reserv1[16];         /* reserved                     */
      unsigned char     num_of_lus;          /* number of LUs                */
      unsigned char     wildcard_lus;        /* wildcard LUs                 */
      unsigned char     reserv3[8];          /* reserved                     */
      unsigned char     lu_names[10][8];     /* LU names                     */
} DEFINE_ADJACENT_LEN_NODE;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_DEFINE_ADJACENT_LEN_NODE

cp_name

The fully qualified name of the CP in the adjacent LEN end node. This should match the name the LEN node sends on its XIDs (if it supports them), and the adjacent CP name specified on the DEFINE_LS for the link to the LEN node.

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.

description

A null-terminated text string (0-31 characters followed by a null character) describing the adjacent LEN node. This string is for information only; it is stored in the configuration and returned on the QUERY_DIRECTORY_ENTRY verb, but SNAplus2 does not make any other use of it.

num_of_lus

The number of LUs to be defined, in the range 0-10. To define an adjacent node with more than 10 LUs, use multiple DEFINE_ADJACENT_LEN_NODE verbs for the same CP name.

wildcard_lus

Indicates whether the specified LU names are wildcard entries or explicit LU names. Possible values are:

AP_YES: The specified LU names are wildcard entries.
AP_NO: The specified LU names are explicit entries.

lu_names

The names of the LUs being defined on the LEN node. Each name is an 8-byte type-A EBCDIC character string, right-padded with EBCDIC spaces, corresponding to the second part of the fully qualified LU name (the first part of the fully qualified name is defined by the cp_name parameter above).

To define the LU associated with the LEN node's control point (the CP LU or default LU), specify the node's fully qualified CP name in the cp_name parameter, and include the “network name” part of this name (the 8 characters after the EBCDIC dot) as one of the LU names.

You can specify a wildcard LU name to match multiple LU names, by specifying only the initial characters of the name. For example, the wildcard LU name “LU” will match “LUNAME” or “LU01” (but will not match “NAMELU”). However, all the LU names specified on a single verb must be of the same type (wildcard or explicit), as defined by the wildcard_lus parameter. To add both types of LU names for the same LEN node, use multiple DEFINE_ADJACENT_LEN_NODE verbs.

Returned Parameters: Successful Execution

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

primary_rc: AP_OK

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_INVALID_CP_NAME: The cp_name parameter contained a character that was not valid.
AP_INVALID_LU_NAME: One or more of the specified LU names contained a character that was not valid.
AP_INVALID_NUM_LUS: The num_of_lus parameter was not in the valid range.
AP_INVALID_WILDCARD_NAME: The wildcard_lus parameter was set to AP_YES, but one or more of the specified LU names was already defined on a different parent node.

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

Possible values are:

AP_INVALID_CP_NAME: The specified CP name is already defined in a directory entry, and is not a LEN node.
AP_INVALID_LU_NAME: One or more of the specified LU names was already defined on a different parent node.

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.

DEFINE_ADJACENT_LEN_NODE

Technical documentation

» Table of Contents