Command Reference Guide

Administration Commands
query_local_topology
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_LU_ALIAS
The list_options parameter was set to LIST_INCLUSIVE to list all entries starting from the supplied
name, but the lu_alias parameter value was not valid.
INVALID_LU_NAME
The list_options parameter was set to LIST_INCLUSIVE to list all entries starting from the supplied
name, but the lu_name parameter value was not valid.
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.
2.137 query_local_topology
The SNAplus2 node maintains a local topology database that holds information about the TGs (transmission groups)
to all adjacent nodes. The query_local_topology command returns information about these TGs. This
command can be used to obtain summary or detailed information about a specific TG or about multiple TGs,
depending on the options used.
This command must be issued to a running node.
2.137.1 Supplied Parameters
Parameter name Type Length Default
[query_local_topology]
num_entries decimal 1
list_options constant SUMMARY + LIST_INCLUSIVE
dest character 17 (null string)
dest_type constant LEARN_NODE
tg_num decimal 0
Supplied parameters are:
num_entries
Maximum number of TGs for which data should be returned. You can specify 1 to return data for a specific
TG, a number greater than 1 to return data for multiple TGs, or 0 (zero) to return data for all TGs.
list_options
403