List Neighbor Cache Table (QtocLstNeighborTbl) API

The List Neighbor Cache Table (QtocLstNeighborTbl) API returns a list of all entries in the IPv6 Neighbor Cache table for a specified line or for all lines.

TCP/IP must be active on this system; otherwise, error message TCP84C0 will be issued.

Authorities and Locks

User Space Library Authority

*EXECUTE

User Space Authority

*CHANGE

User Space Lock

*SHRNUP

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

The user space that receives the information, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name. You can use these special values for the library name:

*CURLIB	The job's current library.
*LIBL	The library list.

Format name

INPUT; CHAR(8)

The format of the space information to be returned. The format names supported are:

NNCT0100

List of Neighbor Cache table entries for a specified line. Refer to NNCT0100 Format for details on the format.

Line name

INPUT; CHAR(10)

The name of the IPv6 enabled physical interface for which to retrieve Neighbor Cache table entries. The following special value may be used:

*ALL	Request all Neighbor Cache entries for all IPv6 enabled lines in the system.

Error Code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

Format of Neighbor Cache Table Lists

To request a list of Neighbor Cache table entries for a line, use format NNCT0100.

The Neighbor Cache table list consists of:

• A user area
• A generic header
• An input parameter section
• A header section
• A list data section:
  • NNCT0100 format.

For details about the user area and generic header, see User Space Format for List APIs. For details about the remaining items, see the following sections.

When you retrieve list entry information from a user space, you must use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid. For examples of how to process lists, see API Examples.

Input Parameter Section

Header Section

NNCT0100 Format

The following information about an entry in the Neighbor Cache table is returned for the NNCT0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.

Field Descriptions

Delay first probe time. The current value of the configured stack attribute named Neighbor solicitation delay first probe time. This attribute controls how long a Neighbor Cache entry will stay in the DELAY state before the stack will send another Neighbor Solicitation and move this Neighbor Cache entry's Reachability state to PROBE if reachability still has not been confirmed. Valid values range from 3 through 10 seconds.

Internet IPv6 address. The IPv6 address of the neighbor in IPv6 address format notation. This field is NULL padded.

Internet IPv6 address binary. The binary representation of the neighbor's IPv6 address. Even though this field is defined as a character field, binary data will be returned in it.

Is router. Whether this neighbor is a router. Possible values are:

Line name. The name of the communications line description that identifies the physical interface which is directly connected to this neighbor.

Link layer address. The MAC address of the neighbor's network interface. Format: XX:XX:XX:XX:XX:XX, where each 'X' is a hexadecimal digit.

Link layer address binary. The binary representation of the neighbor's six byte link layer address.

Max multicast solicits. The current value of the configured Neighbor solicitation max multicast solicits stack attribute. This attribute controls the maximum number of multicast Neighbor Solicitations which will be sent out when the system is performing link-layer address resolution for another host (neighbor). If no Neighbor Advertisement is received after the maximum number of Neighbor Solicitations have been sent out, address resolution has failed, and an ICMPv6 error message will be returned to the application. Valid values range from 1 through 5 transmissions.

Max unicast solicits. The current value of the configured Neighbor solicitation max unicast solicits stack attribute. This attribute controls the maximum number of unicast Neighbor Solicitations which will be sent out when the system is performing link-layer address resolution for another host with unicast Neighbor Solicitations. Multicast is the normal way to perform Neighbor Discovery, but unicast Neighbor Solicitations will be used if the local physical interface is not multicast-capable. If no Neighbor Advertisement is received after the maximum number of Neighbor Solicitations have been sent out, address resolution has failed, and an ICMPv6 error message will be returned to the application. Valid values range from 1 through 5 transmissions.

Number of multicast neighbor solicitation packets sent. The total number of multicast Neighbor Solicitations which have been sent from the local system to this neighbor.

Number of unicast neighbor solicitation packets sent. The total number of unicast Neighbor Solicitations which have been sent from the local system to this neighbor.

Reserved. An ignored field.

Reachability state. The reachability state of this neighbor cache entry. Possible values are:

Reachability state change - date. The date of the last change of this neighbor's Reachability state. The format of the characters in this field is "YYYYMMDD".

The meaning of those characters is as follows:

Reachability state change - time. The time of the last change of this neighbor's Reachability state. The format of the characters in this field is "HHMMSSmmm".

The meaning of those characters is as follows:

Reachability state error information. The error code for this Neighbor Cache entry when the Reachability state is ERROR. This value is only useful when the Reachability state field value is ERROR. Possible values are:

Reserved. An ignored field.

Time in reachable state. The length of time, in seconds, that this neighbor has been in the Reachable state. The following special value may be returned:

Error Messages