 |
» |
|
|
|
The query_directory_entry command returns information about resources in the directory
database. The command can return summary or detailed information
about a specific resource or multiple resources, depending on the
options used. When the command is issued to a running node, it returns information about
the resources that have been explicitly defined (using define_directory_entry or define_adjacent_len_node) and the resources that have been located dynamically
in the directory database. If the node is not running, only explicitly
defined entries are returned. When the command is issued to an end node, it returns information
only about the end node and its resources, but not about other nodes contained
in the directory database. The first entry returned is for the end
node, followed by its LUs. (No entry is returned for the end node's network
node server.) Supplied Parameters | |
Parameter name Type Length Default
[query_directory_entry]
num_entries decimal 1
list_options constant SUMMARY + LIST_INCLUSIVE
resource_name character 17 (null string)
resource_type constant NONE
parent_name character 17 (null string)
parent_type constant NONE
|
Supplied parameters are: - num_entries
Maximum number of resources for which data should be
returned. You can specify 1 to return data
for a specific resource, a number greater than 1 to
return data for multiple resources, or 0 (zero)
to return data for all resources. - list_options
The level of information required for each entry
and the position in the list of resources from which SNAplus2 begins
to return data. The list is ordered by parent_name, then by resource_name, and finally by resource_type. Specify the level of information required with one of the
following values: - SUMMARY
Summary information only - DETAIL
Detailed information
Use a + character to combine this value
with one of the following values: - FIRST_IN_LIST
Start at the first entry in the list - LIST_INCLUSIVE
Start at the entry specified by the combination
of the parent_name, resource_name, and resource_type parameters - LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the combination of the parent_name, resource_name, and resource_type parameters
- resource_name
Fully qualified name of the resource for which information
is required, or the name to be used as an index into the list of
resources. This value is ignored if list_options is set to FIRST_IN_LIST. Specify
3-17 type-A characters consisting of a 1-8 character network
name, followed by a period, followed by a 1-8 character
resource name. - resource_type
Type of resource for which information is required. This
value is ignored if list_options is set to FIRST_IN_LIST. 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 - NONE
All resource types
- parent_name
Fully qualified resource 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. To return only
entries belonging to the specified parent, set this parameter to
the name of the parent resource and parent_type to the type of the resource parent; to return all entries,
do not specify either parameter. Specify 3-17 type-A characters consisting of a 1-8 character
network name, followed by a period, followed by a 1-8 character
parent name. - parent_type
Resource type of the parent resource. To return
only entries belonging to the specified parent, set this parameter
to the type of the parent resource and parent_name to the name of the parent resource; to return all entries,
do not specify either parameter. Possible values are: - ENCP_RESOURCE
Return only entries belonging to LU resources owned by
the end node named by the parent_name parameter. - NNCP_RESOURCE
Return only entries belonging to LU resources owned by
the network node, end node, or LEN node named by the parent_name parameter. - NONE
Return entries belonging to all parent resource
types.
Returned Parameters: Summary Information | |
Parameter name Type Length
resource_name character 17
resource_type constant
description character 31
|
If the command executes successfully and you specified SUMMARY as
the list_options parameter value, the following parameters are returned: - resource_name
Fully qualified name of the resource. - resource_type
Type of the resource. 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
- description
A text string describing the directory entry, as
specified in the definition of the directory entry.
Returned Parameters: Detailed Information | |
Parameter name Type Length
resource_name character 17
resource_type constant
description character 31
parent_name character 17
parent_type constant
entry_type constant
location constant
|
If the command executes successfully and you specified DETAIL as
the list_options parameter value, the following parameters are returned: - resource_name
Fully qualified name of the resource - resource_type
Type of the resource. 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
- description
A text string describing the directory entry, as
specified in the definition of the directory entry. - parent_name
Fully qualified resource 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. This parameter
is not used for a network node resource. - parent_type
Resource type of the parent resource. For a network node
resource, this parameter is not used. Possible values are: - ENCP_RESOURCE
End node (for an LU resource owned by an EN) - NNCP_RESOURCE
Network node (for an LU resource owned by a NN,
or for an EN or LEN resource)
- entry_type
Specifies the type of the directory entry. Possible
values are: - HOME
Local resource - CACHE
Cached entry
- location
Specifies the location of the resource. Possible
values are: - LOCAL
The resource is at the local node. - DOMAIN
The resource belongs to an attached end node. - CROSS_DOMAIN
The resource is not within the domain of the local
node.
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. 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_RES_NAME
The list_options parameter was set to LIST_INCLUSIVE to
list all entries starting from the supplied name, but the resource_name parameter value was not valid. - INVALID_RES_TYPE
The resouce_type parameter was not set to a valid value.
|
Printable version
