DEFINE_DIRECTORY_ENTRY defines a new entry in the node directory
database. This verb cannot be used to modify existing entries. The
verb provides a network qualified resource name along with a resource
type (network node, end node, LU or Wildcard).
When defining an adjacent node and its LUs, you are recommended
to use DEFINE_ADJACENT_LEN_NODE instead of DEFINE_DIRECTORY_ENTRY.
This allows you to define the node and its LUs with a single verb.
(DEFINE_DIRECTORY_ENTRY defines only a single entry, so you need
to use multiple verbs to define entries for the adjacent node and
for its LUs.)
Because the database is hierarchical, each entry includes
the 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. However, when DEFINE_DIRECTORY_ENTRY is
used on an end node or LEN node to define an adjacent LEN node resource
with which it communicates directly, the entry does not include
a parent resource name.
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).
VCB
Structure |
 |
typedef struct define_directory_entry
{
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 resource_name[17]; /* network qualified resource name */
unsigned char reserv1a; /* reserved */
AP_UINT16 resource_type; /* resource type */
unsigned char description[32]; /* resource description */
unsigned char reserv3[16]; /* reserved */
unsigned char parent_name[17]; /* fully qualified parent name */
unsigned char reserv1b; /* reserved */
AP_UINT16 parent_type; /* parent's resource type */
unsigned char reserv4[8]; /* reserved */
} DEFINE_DIRECTORY_ENTRY;
|
Supplied
Parameters |
|
The application supplies the following parameters:
- opcode
AP_DEFINE_DIRECTORY_ENTRY
- resource_name
Fully qualified name of the resource being registered. 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.
- resource_type
Specifies the type of the resource being defined. Possible
values are:
- AP_ENCP_RESOURCE
End node or LEN node
- AP_NNCP_RESOURCE
Network node
- AP_LU_RESOURCE
LU
- AP_WILDCARD_LU_RESOURCE
Wildcard LU name.
For an LU or wildcard LU, the directory entry for the parent
resource (the owning CP) must already be defined.
- description
A null-terminated text string (0-31 characters followed by
a null character) describing the directory entry. This string is
for information only; it is stored in the node's configuration file
and returned on the QUERY_DIRECTORY_ENTRY and QUERY_DIRECTORY_LU
verbs, but SNAplus2 does not make any other use of it.
- 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. 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.
This parameter should be set to all binary zeros in the following
cases:
When registering a network node CP
When the verb 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 being
defined. Possible values are:
- AP_ENCP_RESOURCE
End node (for an LU resource owned by an end node)
- AP_NNCP_RESOURCE
Network node (for an LU resource owned by a network
node, or for an EN or LEN resource).
Set this parameter to zero when no parent resource name is
supplied.
Returned
Parameters: Successful Execution |
|
If the verb executes successfully, SNAplus2 returns the following parameters:
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_FQ_OWNING_CP_NAME
The parent_name parameter did not match the name of a defined resource.
- AP_INVALID_LU_NAME
The resource_name parameter contained a character that was not valid
or was not in the correct format.
- AP_INVALID_RESOURCE_TYPE
The resource_type parameter was not set to a valid value.
- AP_INVALID_WILDCARD_NAME
The resource_type parameter was set to AP_WILDCARD_LU_RESOURCE, but
the resource_name parameter did not contain a valid wildcard entry.
- AP_DUPLICATE
The resource_name parameter contained a wildcard entry that has already
been defined.
- AP_INVALID_RESOURCE_NAME
The resource_name parameter specified a node name that clashed with the
name of the node to which the verb was issued.
Appendix A “Common
Return Codes” lists further
secondary return codes associated with AP_PARAMETER_CHECK,
which are common to all NOF verbs.
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.
Printable version
