| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Line name | Input | Char(10) |
| 4 | Error Code | I/O | Char(*) |
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.
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. |
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. |
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. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
To request a list of Neighbor Cache table entries for a line, use format NNCT0100.
The Neighbor Cache table list consists of:
For details about the user area and generic header, see User spaces. 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 Examples: APIs and exit programs.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format name specified |
| 28 | 1C | CHAR(10) | Line name specified |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name |
| 10 | A | CHAR(10) | User space library name used |
| 20 | 14 | CHAR(10) | Line name used |
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.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(45) | Internet IPv6 address |
| 45 | 2D | CHAR(3) | Reserved |
| 48 | 30 | CHAR(16) | Internet IPv6 address binary |
| 64 | 40 | CHAR(17) | Link layer address |
| 81 | 51 | CHAR(7) | Reserved |
| 88 | 58 | BINARY(8) | Link layer address binary |
| 96 | 60 | CHAR(10) | Line name |
| 106 | 6A | CHAR(2) | Reserved |
| 108 | 6C | BINARY(4) | Reachability state |
| 112 | 70 | CHAR(8) | Reachability state change - date |
| 120 | 78 | CHAR(9) | Reachability state change - time |
| 129 | 81 | CHAR(3) | Reserved |
| 132 | 84 | BINARY(4) | Reachability state error information |
| 136 | 88 | BINARY(4) | Time in reachable state |
| 140 | 8C | BINARY(4) | Is router |
| 144 | 90 | BINARY(4) | Number of unicast neighbor solicitation packets sent |
| 148 | 94 | BINARY(4) | Number of multicast neighbor solicitation packets sent |
| 152 | 98 | BINARY(4) | Delay first probe time |
| 156 | 9C | BINARY(4) | Max unicast solicits |
| 160 | A0 | BINARY(4) | Max multicast solicits |
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:
| 0 | No, this neighbor is not a router. |
| 1 | Yes, this neighbor is a router. |
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:
| -1 | ERROR - An error has occured while verifying the reachability of this neighbor. Use the returned Reachability state error information field value for more information about this error. |
| 1 | INCOMPLETE - Address resolution is being performed on the entry. Specifically, a Neighbor Solicitation has been sent to the solicited-node multicast address of the target, but the corresponding Neighbor Advertisement has not yet been received. |
| 2 | REACHABLE - Positive confirmation was received that the forward path to the neighbor was functioning properly. While REACHABLE, no special action takes place as packets are sent. |
| 3 | STALE - The STALE state is entered upon receiving
an unsolicited Neighbor Discovery message that updates the cached link-layer
address. Receipt of such a message does not confirm reachability, and entering
the STALE state insures reachability is verified quickly if the entry is
actually being used. However, reachability is not actually verified until the
entry is actually used. While STALE, no action takes place until a packet is
sent. |
| 4 | DELAY - This neighbor is assumed to be reachable,
and the system is now trying to verify reachability. |
| 5 | PROBE - A reachability confirmation is actively being sought by retransmitting Neighbor Solicitations every "Retransmit interval" seconds until a reachability confirmation is received. |
| 6 | DELETING - The TCP/IP stack is currently in the process of deleting this neighbor entry from the Neighbor Cache. |
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:
| YYYY | Year |
| MM | Month |
| DD | Day |
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:
| HH | Hours |
| MM | Minutes |
| SS | Seconds |
| mmm | Milliseconds |
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:
| 0 | No error. |
| 1 | Unknown. An unknown error has occurred. |
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:
| -1 | This neighbor currently is not in the Reachable state. |
| Message ID | Error Message Text |
|---|---|
| TCP84C0 E | TCP/IP stack not active. |
| TCP84C3 E | The specified line name does not exist. |
| TCP84C5 E | API error providing TCP/IP Network Status information. |
| TCP84C6 E | Internal operations error - RESULT &1 CC &2 RC &3 ERRNO &4. |
| TCP84C9 I | Information returned incomplete. |
| TCP84CB E | Specified line &1 not configured for IPv6. |
| TCP84CC E | Specified line &1 does not support Neighbor Discovery for IPv6. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9807 E | One or more libraries in library list deleted. |
| CPF9808 E | Cannot allocate one or more libraries on library list. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |