define_directory

The define_directory_entry command defines a new entry in the node directory database. It provides a network qualified resource name along with a resource type (network node, end node, LU, or Wildcard). This command cannot be used to modify existing entries.

When defining an adjacent node and its LUs, use define_adjacent_len_node instead of define_directory_entry. This enables you to define the node and its LUs with a single command. The define_directory_entry command defines only a single entry, so you need to use multiple commands to define entries for the adjacent node and for its LUs.

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 APPN.LU will match APPN.LUNAME or APPN.LU01 (but will not match APPN.NAMELU).

Supplied Parameters

Parameter name                 Type             Length       Default
[define_directory_entry]
resource_name                  character        17
resource_type                  constant                      LU_RESOURCE
description                    character        31           (null string)
parent_name                    character        17           (null string)
parent_type                    constant                      ENCP_RESOURCE

Supplied parameters are:

resource_name

Fully qualified name of the resource to be registered. 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 resource name.

resource_type

Specifies the type of the resource to be defined. Possible values are:

ENCP_RESOURCE: End node (EN) or low-entry networking (LEN) node
NNCP_RESOURCE: Network node (NN)
LU_RESOURCE: Logical unit (LU)
WILDCARD_LU_RESOURCE: Wildcard LU name

The owning control point (CP) on the node must be defined before you can specify an LU or wildcard LU resource type.

description

A text string describing the directory entry. SNAplus2 uses this string for information only. It is stored in the node's configuration file and returned on the query_directory_entry and query_directory_lu commands.

parent_name

Fully qualified name of the parent resource; for an LU the parent resource is the owning control point and for an end node or LEN node it is the network node server. 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 parent name.

Do not specify this parameter in the following cases:

When registering a network node CP.
When the command is being issued to an end node or LEN node to define an adjacent LEN node CP with which the local node communicates directly.

parent_type

Specifies the parent type of the resource to be defined. Possible values are:

ENCP_RESOURCE: End node (for an LU resource owned by an end node)
NNCP_RESOURCE: Network node (for an LU resource owned by a network node, or for an EN or LEN resource)

Do not specify this parameter when no parent name is supplied.

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_FQ_OWNING_CP_NAME: The parent_name parameter did not match the name of a defined parent resource.
INVALID_LU_NAME: The resource_name parameter contained a character that was not valid or was not in the correct format.
INVALID_RESOURCE_TYPE: The resource_type parameter was not set to a valid value.
INVALID_WILDCARD_NAME: The resource_type parameter was set to WILDCARD_LU_RESOURCE but the resource_name parameter did not contain a valid wildcard entry.
DUPLICATE: The resource_name parameter contained a wildcard entry that has already been defined.

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.

Returned Parameters

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

define_directory_entry

Technical documentation

» Table of Contents