discoveredNeighbor
discoveredNeighbor - access discovered neighbors.
SYNOPSIS
discoveredNeighbor sub-command options
DESCRIPTION
The discoveredNeighbor command holds an entry for each neighbor discovered as a result of router discovery or neighbor discovery announcements. Each neighbor entry has:
- MAC address: the MAC address of the discovered interface.
- Router flag: if the neighbor is a router.
- Address list: a list of IP addresses associated with the neighbor's interface, accessed with the discoveredAddress command.
STANDARD OPTIONS
isRouter
(Read-only). Set to true if the neighbor is a router and false otherwise.
macAddress
(Read-only). The retrieved MAC address, as a character string in the form XX:XX:XX:XX:XX:XX.
COMMANDS
The discoveredNeighbor command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
discoveredNeighbor cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the discoveredNeighbor command.
discoveredNeighbor getFirstAddress
Gets the first address associated with the neighbor, which can be accessed with the discoveredAddress command. Specific errors are:
- Required commands have not been called.
- The list is empty.
discoveredNeighbor getNextAddress
Gets the next address associated with the neighbor, which can be accessed with the discoveredAddress command. Specific errors are:
- getFirstAddress has not been called.
- There are no more objects in the list.
EXAMPLES
See examples under interfaceTable