Retrieve OSPF State Information (QtooRtvOSPFDta) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format Name | Input | Char(8) |
| 4 | Error Code | I/O | Char(*) |
Service Program: QTOOOSPF1
Threadsafe: Yes
The Retrieve Open Shortest Path First State Information (QtooRtvOSPFDta) API retrieves the Open Shortest Path First (OSPF) statistics from the OMPROUTED TCP server. The functions provided by this API is to retrieve statistics generated by the OSPF protocol, OSPF interfaces statistics, and OSPF Neighbor statistics using diferent formats. When the OMPROUTED server is not active this API will retrieve only the configuration information from the OSPF configuration file. This API has some similar functionalities of the Display OSPF (DSPOSPF) command.
Authorities and Locks
- Service Program Authority
- *USE
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The reciever variable that recieves the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the lengh parameter correctly. As as result, the API returns only the data that the area can hold.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable provided. The length of the receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of the reciever variable parameter specified is larger than the allocated size of the reciever variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.
- Format name
- INPUT; CHAR(8)
The format of the information returned. You must use the following format name:
SPFI0100 The OSPF general statistics. For more information, see SPFI0100 Format. - Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is ommited, diagnostic and escape messages are issued to the application.
SPFI0100 Format
Format SPFI0100 returns OSPF State information.| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(15) | Router identifier |
| 23 | 17 | CHAR(1) | Reserved |
| 24 | 18 | BINARY(4) | Attached areas |
| 28 | 1C | BINARY(4) | Number of dijkstra runs |
| 32 | 20 | BINARY(4) | OSPF packets recieved |
| 36 | 24 | BINARY(4) | Link state advertisements allocated |
| 40 | 28 | BINARY(4) | Offset to IPv4 OSPF area list entries |
| 44 | 2C | BINARY(4) | Number of IPv4 OSPF area list entries |
| 48 | 30 | BINARY(4) | Length of IPv4 OSPF area list entries |
| 52 | 34 | BINARY(4) | Offset to IPv6 OSPF area list entries |
| 56 | 38 | BINARY(4) | Number of IPv6 OSPF area list entries |
| 60 | 3C | BINARY(4) | Length of IPv6 OSPF area list entries |
| 64 | 40 | BINARY(4) | Offset to IPv4 OSPF interface list entries |
| 68 | 44 | BINARY(4) | Number of IPv4 OSPF interface list entries |
| 72 | 48 | BINARY(4) | Length of IPv4 OSPF interface list entries |
| 76 | 4C | BINARY(4) | Offset to IPv6 OSPF interface list entries |
| 80 | 50 | BINARY(4) | Number of IPv6 OSPF interface list entries |
| 84 | 54 | BINARY(4) | Length of IPv6 OSPF interface list entries |
| 88 | 58 | BINARY(4) | Offset to IPv4 OSPF neighbor list entries |
| 92 | 5C | BINARY(4) | Number of IPv4 OSPF neighbor list entries |
| 96 | 60 | BINARY(4) | Length of IPv4 OSPF neighbor list entries |
| 100 | 64 | BINARY(4) | Offset to IPv6 OSPF neighbor list entries |
| 104 | 68 | BINARY(4) | Number of IPv6 OSPF neighbor list entries |
| 108 | 6C | BINARY(4) | Length of IPv6 OSPF neighbor list entries |
| 112 | 70 | BINARY(4) | Offset to IPv4 OSPF virtual link list entries |
| 116 | 74 | BINARY(4) | Number of IPv4 OSPF virtual link list entries |
| 120 | 78 | BINARY(4) | Length of IPv4 OSPF virtual link list entries |
| 124 | 7C | BINARY(4) | Offset to IPv6 OSPF virtual link list entries |
| 128 | 80 | BINARY(4) | Number of IPv6 OSPF virtual link list entries |
| 132 | 84 | BINARY(4) | Length of IPv6 OSPF virtual link list entries |
| 136 | 88 | BINARY(4) | Offset to IPv4 OSPF link state advertisement list entries |
| 140 | 8C | BINARY(4) | Number of IPv4 OSPF link state advertisement list entries |
| 144 | 90 | BINARY(4) | Length of IPv4 OSPF link state advertisement list entries |
| 148 | 94 | BINARY(4) | Offset to IPv6 OSPF link state advertisement list entries |
| 152 | 98 | BINARY(4) | Number of IPv6 OSPF link state advertisement list entries |
| 156 | 9C | BINARY(4) | Length of IPv6 OSPF link state advertisement list entries |
| These fields repeat for each IPv4 OSPF Area entry | CHAR(15) | IPv4 OSPF area identifier | |
| CHAR(1) | Reserved | ||
| BINARY(4) | SPF runs | ||
| BINARY(4) | Area border routers count | ||
| BINARY(4) | Total number of link state advertisements in this area | ||
| These fields repeat for each IPv6 OSPF Area entry | CHAR(15) | IPv6 OSPF area identifier | |
| CHAR(1) | Reserved | ||
| BINARY(4) | SPF runs | ||
| BINARY(4) | Area border routers count | ||
| BINARY(4) | Total number of link state advertisements in this area | ||
| These fields repeat for each IPv4 OSPF Interface entry | CHAR(15) | IP address | |
| CHAR(15) | Interface OSPF area identifier | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Interface Type | ||
| BINARY(4) | Designated router priority | ||
| BINARY(4) | Transmission Delay | ||
| BINARY(4) | Retransmission interval | ||
| BINARY(4) | Hello interval | ||
| BINARY(4) | Inactive router timeout | ||
| BINARY(4) | Poll interval | ||
| BINARY(4) | Interface state | ||
| CHAR(15) | Designated router | ||
| CHAR(15) | Backup designated router | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Cost | ||
| CHAR(10) | Point-to-Point connection profile | ||
| CHAR(2) | Reserved | ||
| These fields repeat for each IPv6 OSPF Interface entry | CHAR(15) | IPv6 address | |
| CHAR(15) | Interface OSPF area identifier | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Interface Type | ||
| BINARY(4) | Designated router priority | ||
| BINARY(4) | Transmission Delay | ||
| BINARY(4) | Retransmission interval | ||
| BINARY(4) | Hello interval | ||
| BINARY(4) | Inactive router timeout | ||
| BINARY(4) | Poll interval | ||
| BINARY(4) | Interface state | ||
| CHAR(15) | Designated router | ||
| CHAR(15) | Backup designated router | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Cost | ||
| CHAR(10) | Point-to-Point connection profile | ||
| CHAR(2) | Reserved | ||
| These fields repeat for each IPv4 OSPF Neighbor entry | CHAR(15) | OSPF interface IP address | |
| CHAR(15) | Neighbor IP address | ||
| CHAR(15) | Neighbor router identifier | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Neighbor options | ||
| BINARY(4) | Neighbor priority | ||
| BINARY(4) | Neighbor state | ||
| BINARY(4) | Neighbor events | ||
| These fields repeat for each IPv6 OSPF Neighbor entry | CHAR(15) | OSPF interface IP address | |
| CHAR(15) | Neighbor IP address | ||
| CHAR(15) | Neighbor router identifier | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Neighbor options | ||
| BINARY(4) | Neighbor priority | ||
| BINARY(4) | Neighbor state | ||
| BINARY(4) | Neighbor events | ||
| These fields repeat for each IPv4 OSPF Virtual Link | CHAR(15) | Transit area identifier | |
| CHAR(15) | Router identifier | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Virtual link transit delay | ||
| BINARY(4) | Virtual link retransmission interval | ||
| BINARY(4) | Virtual link hello interval | ||
| BINARY(4) | Virtual link state | ||
| These fields repeat for each IPv6 OSPF Virtual Link | CHAR(15) | Transit area identifier | |
| CHAR(15) | Router identifier | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Virtual link transit delay | ||
| BINARY(4) | Virtual link retransmission interval | ||
| BINARY(4) | Virtual link hello interval | ||
| BINARY(4) | Virtual link state | ||
| These fields repeat for each IPv4 OSPF Link State Advertisement | CHAR(15) | LSA area identifier | |
| CHAR(1) | Reserved | ||
| BINARY(4) | Link state advertisement type | ||
| BINARY(4) | Link state identifier | ||
| BINARY(4) | Link state router identifier | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Link state advertisement sequence | ||
| BINARY(4) | Link state advertisement age | ||
| BINARY(4) | Link state advertisement checksum | ||
| These fields repeat for each IPv6 OSPF Link State Advertisement | CHAR(15) | LSA area identifier | |
| CHAR(1) | Reserved | ||
| BINARY(4) | Link state advertisement type | ||
| BINARY(4) | Link state identifier | ||
| BINARY(4) | Link state router identifier | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Link state advertisement sequence | ||
| BINARY(4) | Link state advertisement age | ||
| BINARY(4) | Link state advertisement checksum | ||
Field Descriptions
Attached areas. The number of areas in which this system has OSPF interfaces.
Bytes available. The number of bytes of data available to be returned to the user.
Bytes returned. The number of bytes that were returned to the user. This is the lesser of the number of bytes available to be returned or the length of the reciever variable.
Length of IPv4 OSPF area list entries. The length in bytes of each element in the list of IPv4 OSPF list entries. If there are no IPv4 OSPF areas, this value is zero.
Length of IPv4 OSPF interfaces list entries. The length in bytes of each element in the list of IPv4 OSPF interface list entries. If there are no IPv4 OSPF interfaces, this value is zero.
Length of IPv4 OSPF link state advertisement list entries. The length in bytes of each element in the list of IPv4 OSPF link state advertisement list entries. If there are no IPv4 OSPF link state advertisements, this value is zero.
Length of IPv4 OSPF neighbor list entries. The length in bytes of each element in the list of IPv4 OSPF neighbor list entries. If there are no IPv4 OSPF neighbors, this value is zero.
Length of IPv4 OSPF virtual link list entries. The length in bytes of each element in the list of IPv4 OSPF virtual link list entries. If there are no IPv4 OSPF virtual links, this value is zero.
Length of IPv6 OSPF area list entries. The length in bytes of each element in the list of IPv6 OSPF list entries. If there are no IPv6 OSPF areas, this value is zero.
Length of IPv6 OSPF interfaces list entries. The length in bytes of each element in the list of IPv6 OSPF interface list entries. If there are no IPv6 OSPF interfaces, this value is zero.
Length of IPv6 OSPF link state advertisement list entries. The length in bytes of each element in the list of IPv6 OSPF link state advertisement list entries. If there are no IPv6 OSPF link state advertisements, this value is zero.
Length of IPv6 OSPF neighbor list entries. The length in bytes of each element in the list of IPv6 OSPF neighbor list entries. If there are no IPv6 OSPF neighbors, this value is zero.
Length of IPv6 OSPF virtual link list entries. The length in bytes of each element in the list of IPv6 OSPF virtual link list entries. If there are no IPv6 OSPF virtual links, this value is zero.
Link state advertisements allocated. The number of link state advertisements that have been placed in the LSA database.
Number of dijkstra runs. The number of times that the SPF algorithm has run in OMPROUTED.
Number of IPv4 OSPF area list entries. The number of IPv4 OSPF area list entries. If there are no IPv4 OSPF area entries, this value is zero.
Number of IPv4 OSPF interfaces list entries. The number of IPv4 OSPF interfaces list entries. If there are no IPv4 OSPF interfaces list entries, this value is zero.
Number of IPv4 OSPF link state advertisement list entries. The number of IPv4 OSPF link state advertisement list entries. If there are no IPv4 OSPF link state advertisement list entries, this value is zero.
Number of IPv4 OSPF neighbor list entries. The number of IPv4 OSPF neighbor list entries. If there are no IPv4 OSPF neighbor list entries, this value is zero.
Number of IPv4 OSPF virtual link list entries. The number of IPv4 OSPF virtual link list entries. If there are no IPv4 OSPF virtual link list entries, this value is zero.
Number of IPv6 OSPF area list entries. The number of IPv6 OSPF area list entries. If there are no IPv6 OSPF area entries, this value is zero.
Number of IPv6 OSPF interfaces list entries. The number of IPv6 OSPF interfaces list entries. If there are no IPv6 OSPF interfaces list entries, this value is zero.
Number of IPv6 OSPF link state advertisement list entries. The number of IPv6 OSPF link state advertisement list entries. If there are no IPv6 OSPF link state advertisement list entries, this value is zero.
Number of IPv6 OSPF neighbor list entries. The number of IPv6 OSPF neighbor list entries. If there are no IPv6 OSPF neighbor list entries, this value is zero.
Number of IPv6 OSPF virtual link list entries. The number of IPv6 OSPF virtual link list entries. If there are no IPv6 OSPF virtual link list entries, this value is zero.
Offset to IPv4 OSPF area list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv4 OSPF area information. If there is no IPv4 OSPF area, this value is zero.
Offset to IPv4 OSPF interface list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv4 OSPF interface information. If there is no IPv4 OSPF interface, this value is zero.
Offset to IPv4 OSPF link state advertisement list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv4 OSPF link state advertisement information.
Offset to IPv4 OSPF neighbor list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv4 OSPF neighbor information. If there is no IPv4 OSPF neighbor, this value is zero.
Offset to IPv4 OSPF virtual link list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv4 OSPF virtual link information. If there is no IPv4 OSPF virtual link, this value is zero.
Offset to IPv6 OSPF area list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv6 OSPF area information. If there is no IPv4 OSPF area, this value is zero.
Offset to IPv6 OSPF interface list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv6 OSPF interface information. If there is no IPv6 OSPF interface, this value is zero.
Offset to IPv6 OSPF link state advertisement list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv6 OSPF link state advertisement information.
Offset to IPv6 OSPF neighbor list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv6 OSPF neighbor information. If there is no IPv6 OSPF neighbor, this value is zero.
Offset to IPv6 OSPF virtual link list entries. The offset in bytes from the beginning of the receiver variable to the list of IPv6 OSPF virtual link information. If there is no IPv6 OSPF virtual link, this value is zero.
OSPF packets received. The number of packets that this system has received. The starting point for this will be when the OMPROUTED server has been started and one of the configured OSPF interfaces starts receiving OSPF packets.
Reserved. An ignored field.
Router identifier. The unique identifier for this system in OSPF routing domain. The router identifier is represented as IPv4 address in dotted-decimal format.
Field Descriptions for Each IPv4 OSPF Area Entry
Area border routers count. The total number of area border routers reachable within this area. This value is typically zero and is calculated in each SPF pass.
IPv4 OSPF area identifier. The unique identifier for an area in OSPF routing domain. The area identifier is represented as an IPv4 address in dotted-decimal format.
Reserved. An ignored field.
SPF runs. The number of times that the intra-area route table has been calculated using this area's link-state database. This is typically done by using the Dijkstra's algorithm.
Total number of link state advertisements in this area. The total number of link-state advertisements in this area's link-state database, excluding AS External LSA's.
Field Descriptions for Each IPv6 OSPF Area Entry
Area border routers count. The total number of Area border routers reachable within this area. This is typically zero and is calculated in each SPF pass.
IPv6 OSPF area identifier. The unique identifier for an area in OSPF routing domain. The area identifier is represented as an IPv4 address in dotted-decimal format.
Reserved. An ignored field.
SPF runs. The number of times that the intra-area route table has been calculated using this area's link-state database. This is typically done by using the Dijkstra's algorithm.
Total number of link state advertisements in this area. The total number of link-state advertisements in this area's link-state database, excluding AS External LSA's.
Field Descriptions for Each IPv4 OSPF Interface Entry
Backup designated router. The IP address of the backup designated router.
Cost. The cost of this particular interface.
Designated router. The IP address of the designated router.
Designated router priority. The Priority of this interface.
Hello interval. The length of time, in seconds, between the Hello packets that the router sends on the interface.
Inactive router timeout. The number of seconds that Hello packets have not been seen before its neighbor declares the router down.
Interface OSPF area identifier. The unique identifier for an area represented as an IPv4 address in dotted-decimal format to which the interface is attached.
Interface state. The OSPF interface state. The valid state values are as follows:
| 1 | IFSDOWN - This is the initial interface state. In this state, the TCP/IP stack has indicated that the interface is not operative. No protocol traffic will be sent or received over this interface. |
| 2 | IFSBACKUP - In this interface state, the interface will not carry OSPF data traffic until the primary interface fails. In this case, the backup interface has been configured in the same subnet as primary interface and only the primary interface will send and receive routing traffic if there are more configured OSPF interfaces in the system connected to the same subnet. |
| 4 | IFSLOOPED - In this state, the interface to the network is looped back. The interface will not be available for regular data traffic. |
| 8 | IFSWAIT - In this state, the OMPROUTED server is trying to determine the identity of the Designated Router for the network in which this interface is attached. |
| 16 | IFSPP - In this state, the interface is operational, and connects either to a physical point-to-point link or to a virtual link. |
| 32 | IFSOTHER - The interface is attached to a broadcast or an NBMA (nonbroadcast-multiaccess) network on which another router has been elected to be the Designated Router. In this state, the system itself has not been selected Backup Designated Router either. |
| 64 | IFSBDR - In this state, the router itself is the Backup Designated Router on the attached network. It will be promoted to Designated Router when the present Designated Router fails. |
| 128 | IFSDR - In this state, the system itself is the Designated Router on the attached network. |
Interface type. The OSPF interface type. The valid OSPF interface types are as follows:
| 1 | BCST - This interface is attached to a broadcast network. |
| 2 | PP - This interface is attached to a point-to-point link. |
| 3 | MA - This interface is attached to a nonbroadcast multiaccess network. |
| 4 | VL - This is a configured virtual link. |
IP address. The IP address of this OSPF interface.
Point-to-point connection profile. This profile indicates that this interface sends and receives OSPF packets over a point-to-point link.
Poll interval. The larger time interval, in seconds, between the Hello packets sent to an inactive nonbroadcast multi-access neighbor.
Reserved. An ignored field.
Retransmission interval. The number of seconds between link-state advertisement retransmissions.
Transmission delay. The estimated number of seconds it takes to transmit a link state update packet over this interface.
Field Descriptions for each IPv6 OSPF Interface Entry
Backup designated router. The IP address of the backup designated router.
Cost. The cost of this particular interface.
Designated router. The IP address of the designated router.
Designated router priority. The priority of this interface.
Hello interval. The length of time, in seconds, between the Hello packets that the router sends on the interface.
Inactive router timeout. The number of seconds that Hello packets have not been seen before its neighbor declares the router down.
Interface OSPF area identifier. The unique identifier for an area represented as an IPv4 address in dotted-decimal format to which the interface is attached.
Interface state. The OSPF interface state. The valid state values are as follows:
| 1 | IFSDOWN - This is the initial interface state. In this state, the TCP/IP stack has indicated that the interface is not operative. No protocol traffic will be sent or received over this interface. |
| 2 | IFSBACKUP - In this interface state, the interface will not carry OSPF data traffic until the primary interface fails. In this case the backup interface has been configured in the same subnet as primary interface and only the primary interface will send and receive routing traffic if there are more configured OSPF interfaces in the system connected to the same subnet. |
| 4 | IFSLOOPED - In this state, the interface to the network is looped back. The interface will not be available for regular data traffic. |
| 8 | IFSWAIT - In this state, the OMPROUTED server is trying to determine the identity of the Designated Router for the network in which this interface is attached. |
| 16 | IFSPP - In this state, the interface is operational, and connects either to a physical point-to-point link or to a virtual link. |
| 32 | IFSOTHER - The interface is attached to a broadcast or an NBMA (nonbroadcast-multiaccess) network on which another router has been elected to be the Designated Router. In this state, the system itself has not been selected Backup Designated Router either. |
| 64 | IFSBDR - In this state, the router itself is the Backup Designated Router on the attached network. It will be promoted to Designated Router when the present Designated Router fails. |
| 128 | IFSDR - In this state, the system itself is the Designated Router on the attached network. |
Interface type. The OSPF interface type. The valid OSPF interface types are as follows:
| 1 | BCST - This interface is attached to a broadcast network. |
| 3 | MA - This interface is attached to a nonbroadcast multiaccess network. |
| 4 | VL - This is a configured virtual link. |
IPv6 address. The IPv6 address of this OSPF interface.
Poll interval. The larger time interval, in seconds, between the Hello packets sent to an inactive nonbroadcast multi-access neighbor.
Reserved. An ignored field.
Retransmission interval. The number of seconds between link-state advertisement retransmissions.
Transmission delay. The estimated number of seconds it takes to transmit a link state update packet over this interface.
Field Descriptions for Each IPv4 OSPF Neighbor Entry
Neighbor events. The number of times this neighbor relationship has changed the state.
Neighbor IP address. The IP address this neighbor is using in its IP Source Address.
Neighbor options. A bit mask corresponding to the neighbor's options field. In this OSPF implementation, 3 bits have been assigned to describe the neighbor options, and these bits reside in the first 8 bits of the first byte of this field.
E-bit: This is the bit 1 of the first 8 bits of the first byte. It describes the way Autonomous System-External-Link state advertisements are flooded, as described in sections 3.6, 9.5, 10.8 and 12.1.2 of the RFC 2328.
MC-bit: This is the bit 2 of the first 8 bits of the first byte. It describes whether IP multicast datagrams are forwarded.
DC-bit: This is the bit 1 of the first 8 bits of the first byte. It describes whether the attached neighbor router handles demand circuits.
Neighbor priority. The priority of this neighbor in the designated router election algorithm.
Neighbor router identifier. The unique identifier for the neighbor router represented as an IPv4 address in dotted-decimal format.
Neighbor state. The state of the relationship with this neighbor. The valid neighbor state values are as follows:
| 1 | DOWN - This is the initial state of a neighbor. It indicates that there has not been received information from the neighbor. |
| 2 | ATTEMPT - This state is only valid for neighbors attached to nonbroadcast multiaccess networks. This state indicates that the information has not been received from the neighbor recently. |
| 4 | INIT - In this state, a Hello packet has been recently seen from the neighbor, but bidirectional communication has not yet been established with the neighbor. |
| 8 | 2WAY - In this state, communication between the two routers is bidirectional. |
| 16 | EXSTART - This state indicates the first step in creating an adjacency between the two neighboring routers. |
| 32 | EXCHANGE - In this state, the system describes its entire link state database by sending Database Description packets to the neighbor. neighboring routers. |
| 64 | LOADING - In this state, Link State Request packets are sent to the neighbor asking for the more recent links state advertisements that have been discovered in the exchange state. |
| 128 | FULL - In this state, the neighboring router is fully adjacent. |
OSPF interface IP address. The IP address of the interface on which this neighboring router has been created a relationship.
Reserved. An ignored field.
Field Descriptions for Each IPv6 OSPF Neighbor Entry
Neighbor events. The number of times this neighbor relationship has changed the state.
Neighbor IP address. The IP address this neighbor is using in its IP Source Address.
Neighbor options. A bit mask corresponding to the neighbor's options field. In this OSPF implementation for IPv6, 3 bits have been assigned to describe the neighbor options, and these bits reside in the first 8 bits of the first byte of this field.
V6-bit: This is the bit 0 of the first 8 bits of the first byte. If this bit is clear, the router/link should be excluded from IPv6 routing calculations. See section 3.6 of RFC 2740 for more details.
E-bit: This is the bit 1 of the first 8 bits of the first byte.This bit describes the way Autonomous System-external-link state advertisements are flooded, as described in sections 3.6, 9.5, 10.8 and 12.1.2 of RFC 2328.
MC-bit: This is the bit 2 of the first 8 bits of the first byte.This bit describes whether IP multicast datagrams are forwarded.
N-bit: This is the bit 3 of the first 8 bits of the first byte. This bit describes the handling of Type-7 Link State advertisement, as specified in RFC 2740.
R-bit: This is the bit 4 of the first 8 bits of the first byte. This bit called as the Router bit indicates whether the originator is an active router. If this bit is clear, routes that transit the advertising node cannot be computed.
Neighbor priority. The priority of this neighbor in the designated router election algorithm.
Neighbor router identifier. The unique identifier for the neighbor router represented as an IPv4 address in dotted-decimal format.
Neighbor state. The state of the relationship with this neighbor. The valid neighbor state values are as follows:
| 1 | DOWN - This is the initial state of a neighbor. It indicates that there has not been received information from the neighbor. |
| 2 | ATTEMPT - This state is only valid for neighbors attached to nonbroadcast multiaccess networks. This state indicates that the information has not been received from the neighbor recently. |
| 4 | INIT - In this state, a Hello packet has been recently seen from the neighbor, but bidirectional communication has not yet been established with the neighbor. |
| 8 | 2WAY - In this state, communication between the two routers is bidirectional. |
| 16 | EXSTART - This state indicates the first step in creating an adjacency between the two neighboring routers. |
| 32 | EXCHANGE - In this state, the system describes its entire link state database by sending Database Description packets to the neighbor. neighboring routers. |
| 64 | LOADING - In this state, Link State Request packets are sent to the neighbor asking for the more recent links state advertisements that have been discovered in the exchange state. |
| 128 | FULL - In this state, the neighboring router is fully adjacent. |
OSPF interface IP address. The IP address of the interface on which this neighboring router has been created a relationship.
Reserved. An ignored field.
Field Descriptions for Each IPv4 OSPF Virtual Link Entry
Reserved. An ignored field.
Router identifier. The indentifier represented as an IPv4 address in dotted-decimal of the router in the other end point in which the virtual link will be established.
Transit area identifier. The transit area that the virtual link transverses.
Virtual link hello interval. The length of time, in seconds, between the Hello packets that the router sends on the interface.
Virtual link retransmission interval. The number of seconds between link-state advertisement retransmissions.
Virtual link state. OSPF virtual link state. The valid state values are as follows:
| 1 | VTDOWN - This is the initial virtual state. No protocol traffic will be sent or received over this virtual link. |
| 2 | VTPP - In this state, the virtual link is operational. |
Virtual transit delay. The estimated number of seconds it takes to transmit a link-state update packet over this interface.
Field Descriptions for Each IPv6 OSPF Virtual Link Entry
Reserved. An ignored field.
Router identifier. The indentifier represented as an IPv4 address in dotted-decimal of the router in the other end point in which the virtual link will be established.
Transit area identifier. The transit area that the virtual link transverses.
Virtual link hello interval. The length of time, in seconds, between the Hello packets that the router sends on the interface.
Virtual link retransmission interval. The number of seconds between link-state advertisement retransmissions.
Virtual link state. OSPF virtual link state. The valid state values are as follows:
| 1 | VTDOWN - This is the initial virtual state. No protocol traffic will be sent or received over this virtual link. |
| 2 | VTPP - In this state, the virtual link is operational. |
Virtual transit delay. The estimated number of seconds it takes to transmit a link-state update packet over this interface.
Field Descriptions for Each IPv4 OSPF Link State Advertisement Entry
Link state advertisement age. This field is the age of the link state advertisement in seconds.
Link state advertisement checksum. This field is the checksum of the complete contents of the advertisement excepting age field.
Link state advertisement sequence. The sequence number field is a signed 32-bit integer.
Link state advertisement type. The type of the link state advertisement.
| 1 | LSTRL - Router-Link advertisement. Originated for all routers. This link state advertisement describes the collected states of the router's interfaces to an area. They are flooded throughout a single area only. |
| 2 | LSTNL - Network-Link advertisement. Originated for broadcast and nonbroadcast multiaccess networks by the Designated Router. This link state advertisement contains the list of routers connected to the network. They are flooded throughout a single area only. |
| 3 | LSTSL - Summary-Link advertisement. Originated by area border routers, and flooded throughout the associated area of the Link state advertisement. Each summary-LSA describes a route to a destination outside the area that is still inside the Autonomous System. (inter-area router). |
| 4 | LSTSRL - Summary Link advertisement describes summary-LSA to routes to Autonomous System boundary routers. |
| 5 | LSTASL - Autonomous System external link advertisement. Originated by Autonomous System boundary routers and flooded throughout the Autonomous System. Each AS-external-LSA describes a route in another Autonomous System. Default routes for the AS can also be described as AS-external-LSA. |
Link state identifier. The link state identifier is an LSA Type specific field containing either a router identifier or an IP address.
Link state router identifier. The identifier of the originating router represented as an IPv4 address in dotted-decimal format.
LSA area identifier. The area identifier represented as an IPv4 address in dotted-decimal format from which the LSA was received.
Reserved. An ignored field.
Field Descriptions for Each IPv6 OSPF Link State Advertisement Entry
Link state advertisement age. This field is the age of the link state advertisement in seconds.
Link state advertisement checksum. This field is the checksum of the complete contents of the advertisement excepting age field.
Link state advertisement sequence. The sequence number field is a signed 32-bit integer.
Link state advertisement type. The type of the link state advertisement.
| 8193 | LST6RL - Router-Link advertisement. Originated for all routers. This link state advertisement describes the collected states of the router's interfaces to an area. They are flooded throughout a single area only. |
| 8194 | LST6NL - Network-Link advertisement. Originated for broadcast and nonbroadcast multiaccess by the link's Designated Router. This link state advertisement contains the list of routers connected to a link. They are flooded throughout a single area only. |
| 8195 | INTERPL - Inter-Area-Prefix-LSA. These LSAs are the IPv6 equivalent of OSPF for IPv4's type 3 Summary-LSAs. Originated by the area border routers, they describe routes to IPv6 address prefixes that belong to other areas. |
| 8196 | INTERRL - Inter-Area-Router-LSAs. These LSAs are the IPv6 equivalent of OSPF for IPv4's type 4 summary-LSAs. Originated by the area border routers, they describe routes to routers in other areas. |
| 16389 | LST6ASL - Autonomous System external link advertisement. Originated by Autonomous System boundary routers and flooded throughout the Autonomous System. Each AS-external-LSA describes a route in another Autonomous System. Default routes for the AS can also be described as AS-external-LSA. |
| 8 | LST6LL - A router originates a separate Link-LSA for each link it is attached to. These LSAs have local-link flooding scope; they are never flooded beyond the link that they are associated with. |
| 8201 | INTRAPL - Intra-Area-Prefix_LSAs. A router uses Intra-Area-Prefix_LSAs to advertise one or more IPv6 address prefixes. |
Link state identifier. The link state identifier is an LSA Type specific field containing either a router identifier or an IP Address.
Link state router identifier. The identifier of the originating router represented as an IPv4 address in dotted-decimal format.
LSA area identifier. The area identifier represented as an IPv4 address in dotted-decimal format from which the LSA was received.
Reserved. An ignored field.
Error Messages
| Message ID | Error Message Text. |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF2634 E | Not authorized to object &1. |
| CPF3C17 E | Error occurred with input data parameter. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF9872 | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V6R1