 |
» |
|
|
 |
The query_cn_port command returns information about ports defined on adjacent
connection networks. This command can be used to obtain information
about a specific port or about multiple ports, depending on the
options used. The command is valid only at an end node; it is not valid
at a LEN node. Supplied Parameters |  |
Parameter name Type Length Default [query_cn_port] num_entries decimal 1 list_options constant LIST_INCLUSIVE fqcn_name character 17 (null string) port_name character 8 (null string)
|
Supplied parameters are: - num_entries
Maximum number of ports for which data should be returned.
You can specify 1 to return data for a
specific port, a number greater than 1 to
return data for multiple ports, or 0 (zero)
to return data for all ports. - list_options
The position in the list of ports from which SNAplus2 begins
to return data. Possible values are: - FIRST_IN_LIST
Start at the first entry in the list - LIST_INCLUSIVE
Start at the entry specified by the port_name parameter - LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the port_name parameter
- fqcn_name
Fully qualified name of the CN on which the required port
is defined, or the name to be used as an index into the list of
CNs and ports. Specify 3-17 type-A characters consisting
of a 1-8 character network name, followed by a period,
followed by a 1-8 character CN name. This parameter must
always be set. - port_name
Name of the port for which information is required,
or the name to be used as an index into the list of ports. This
name is a string of 1-8 characters. This parameter is ignored
if list_options is set to FIRST_IN_LIST.
Returned Parameters |  |
Parameter name Type Length fqcn_name character 17 port_name character 8 tg_num decimal
|
If the command executes successfully, the following parameters
are returned: - fqcn_name
Fully qualified name of the CN. - port_name
Name of the port. - tg_num
Transmission group number for the specified port.
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_CN_NAME
The list_options parameter was set to LIST_INCLUSIVE to
list all entries starting from the supplied name, but the value
specified in the fqcn_name parameter was not valid. - INVALID_PORT_NAME
The list_options parameter was set to LIST_INCLUSIVE to
list all entries starting from the supplied name, but the value
specified in the port_name parameter was not valid.
If the command does not execute because the node's configuration
does not support it, SNAplus2 returns the following parameters: - primary_rc
- FUNCTION_NOT_SUPPORTED
The local node is a LEN node. This command is valid only
at an end node.
- secondary_rc
(This parameter is not used.)
|