Share via

2.2.1.2.166 IPRIP_IF_CONFIG

  • Article

The IPRIP_IF_CONFIG structure contains the per-interface configuration. This structure is used in structures IPRIP_MIB_GET_INPUT_DATA (section 2.2.1.2.161), IPRIP_MIB_GET_OUTPUT_DATA (section 2.2.1.2.162), and in the following methods:


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

IC_State

IC_Metric

IC_UpdateMode

IC_AcceptMode

IC_AnnounceMode

IC_ProtocolFlags

IC_RouteExpirationInterval

IC_RouteRemovalInterval

IC_FullUpdateInterval

IC_AuthenticationType

IC_AuthenticationKey (16 bytes)

...

...

IC_RouteTag

IC_Padding

IC_UnicastPeerMode

IC_AcceptFilterMode

IC_AnnounceFilterMode

IC_UnicastPeerCount

IC_AcceptFilterCount

IC_AnnounceFilterCount

IC_UnicastPeer (variable)

...

IC_AcceptFilter (variable)

...

IC_AnnounceFilter (variable)

...

IC_State (4 bytes): Specifies the IP RIP state on the interface. This field MUST be read-only and MUST be ignored if modified. It MUST be a combination of one or more of the following values.

Value

Meaning

IPRIP_STATE_ENABLED

0x00000001

The IP RIP is enabled.

IPRIP_STATE_BOUND

0x00000002

The socket is bound.

IC_Metric (4 bytes): Specifies the metric of the interface.

IC_UpdateMode (4 bytes): Specifies whether the update mode is periodic or on demand.

Value

Meaning

IPRIP_UPDATE_PERIODIC

0x00000000

The RIP updates are done periodically.

IPRIP_UPDATE_DEMAND

0x00000001

The RIP updates are done only when there is change.

IC_AcceptMode (4 bytes): Specifies the type of routes that are accepted.

Value

Meaning

IPRIP_ACCEPT_DISABLED

0x00000000

Does not accept routes.

IPRIP_ACCEPT_RIP1

0x00000001

Accepts RIPv1 routes.

IPRIP_ACCEPT_RIP1_COMPAT

0x00000002

Accepts RIPv1 compatible routes (RIPv1 was designed to be compatible with future versions of the RIP. If a RIPv1 router receives a message and if the RIP version indicated in the RIP header is not 1, the RIPv1 router does not discard the RIP announcement, but instead processes only the RIPv1 defined fields.)

IPRIP_ACCEPT_RIP2

0x00000003

Accepts RIPv2 routes. See [RFC1723].

IC_AnnounceMode (4 bytes): Specifies the type of routes that are announced.

Value

Meaning

IPRIP_ANNOUNCE_DISABLED

0x00000000

Does not announce routes.

IPRIP_ANNOUNCE_RIP1

0x00000001

Announces RIPv1 routes.

IPRIP_ANNOUNCE_RIP1_COMPAT

0x00000002

Accepts RIPv1 compatible routes. (RIPv1 was designed to be compatible with future versions of the RIP. If a RIPv1 router receives a message and if the RIP version indicated in the RIP header is not 1, the RIPv1 router does not discard the RIP announcement, but instead processes only the RIPv1 defined fields.)

IPRIP_ANNOUNCE_RIP2

0x00000003

Announces RIPv2 routes. See [RFC1723].

IC_ProtocolFlags (4 bytes): Specifies which routes are included or excluded from RIP announcements.

Value

Meaning

IPRIP_FLAG_ACCEPT_HOST_ROUTES

0x00000000

Specifies whether host routes in received RIP announcements are accepted.

IPRIP_FLAG_ANNOUNCE_HOST_ROUTES

0x00000002

Specifies whether host routes are included in RIP announcements.

IPRIP_FLAG_ACCEPT_DEFAULT_ROUTES

0x00000004

Specifies whether host routes are included in RIP announcements.

IPRIP_FLAG_ANNOUNCE_DEFAULT_ROUTES

0x00000008

Specifies whether default routes are included in RIP announcements.

IPRIP_FLAG_SPLIT_HORIZON

0x00000010

Enables split-horizon processing.

Specifies whether routes learned on a network are not announced in RIP announcements sent on that network.

IPRIP_FLAG_POISON_REVERSE

0x00000020

Enables the poison-reverse processing.

Specifies whether routes learned on a network are announced with a metric of 16 (unreachable) in RIP announcements sent on that network.

IPRIP_FLAG_GRACEFUL_SHUTDOWN

0x00000040

Sends cleanup updates when shutting down.

Specifies whether, if the RIP is stopping on this interface, the RIP sends an announcement with all routes that are marked with a metric of 15. This enables neighboring routers to immediately update their routing tables to indicate that the routes available through the router that is stopping are no longer reachable.

IPRIP_FLAG_TRIGGERED_UPDATES

0x00000080

Enables triggered updates processing.

Specifies whether new routes and metric changes trigger an immediate update that includes only the changes. This is called a triggered update.

IPRIP_FLAG_OVERWRITE_STATIC_ROUTES

0x00000100

Overwrites the static routes on the interface.

IPRIP_FLAG_NO_SUBNET_SUMMARY

0x00000200

Specifies that subnet routes are not summarized in the form of the class-based network ID when announced on a network that is not a subnet of the class-based network ID. By default, subnet summarization is disabled.

IC_RouteExpirationInterval (4 bytes): The lifetime (in seconds) of a route that is learned through the RIP before it expires.

IC_RouteRemovalInterval (4 bytes): The amount of time (in seconds) after which a RIP-learned route that has expired is removed from the routing table.

IC_FullUpdateInterval (4 bytes): The number of seconds between full RIP updates.

IC_AuthenticationType (4 bytes): One of the following values.

Value

Meaning

IPRIP_AUTHTYPE_NONE

0x00000001

No authentication is used.

IPRIP_AUTHTYPE_SIMPLE_PASSWORD

0x00000002

Password authentication is used. Plain comparison of text is made.

IPRIP_AUTHTYPE_MD5

0x00000003

This is unused.

IC_AuthenticationKey (16 bytes): The authentication data being sent depending on IC_AuthenticationType. This MUST be a write-only field and MUST be ignored on receive.

IC_RouteTag (2 bytes): A tag number for the routes advertised on this interface. Use this option if to have all packets sent over this interface to include a tag in RIP version 2 announcements. See [RFC1723].

IC_Padding (2 bytes): This is a padding field and MUST be set to 0 and ignored on receive.

IC_UnicastPeerMode (4 bytes): This MUST be one of the following values.

Value

Meaning

IPRIP_PEER_DISABLED

0x00000000

 RIP packets will not be sent to peers.

IPRIP_PEER_ALSO

0x00000001

RIP packets will be sent to peers, as well as being sent via broadcast or multicast.

IPRIP_PEER_ONLY

0x00000002

RIP packets will only be sent to the peers specified in the structure.

IC_AcceptFilterMode (4 bytes): This MUST be one of the following values.

Value

Meaning

IPRIP_FILTER_DISABLED

0x00000000

Updates from all IP addresses are accepted.

IPRIP_FILTER_INCLUDE

0x00000001

Updates are only accepted from the IP addresses specified by the IC_AcceptFilter.

IPRIP_FILTER_EXCLUDE

0x00000002

Ignores updates from the IP addresses specified by the IC_AcceptFilter.

IC_AnnounceFilterMode (4 bytes): This MUST be one of the following values.

Value

Meaning

IPRIP_FILTER_DISABLED

0x00000000

Updates from all IP addresses are accepted.

IPRIP_FILTER_INCLUDE

0x00000001

Updates are only accepted from IP addresses specified by the IC_AnnounceFilter.

IPRIP_FILTER_EXCLUDE

0x00000002

Ignores updates from the IP addresses specified by the IC_AnnounceFilter.

IC_UnicastPeerCount (4 bytes): The number of peer IP addresses specified in IC_UnicastPeer array.

IC_AcceptFilterCount (4 bytes): The number of accept filters specified in IC_AcceptFilter.

IC_AnnounceFilterCount (4 bytes): The number of announce filters specified in IC_AnnounceFilter.

IC_UnicastPeer (variable): This specifies an array of IPv4 address of the peers in network byte order. The array MUST have IC_UnicastPeerCount number of elements in it.

IC_AcceptFilter (variable): This specifies an array of IPRIP_ROUTE_FILTER (section 2.2.1.2.167) entries. The array MUST have IC_AcceptFilterCount number of elements in it. The default filter action to be applied for these filters is specified by IC_AcceptFilterMode. 

IC_AnnounceFilter (variable): This specifies an array of IPRIP_ROUTE_FILTER entries. The array MUST have IC_AnnounceFilterCount number of elements in it. The default filter action to be applied for these filters is specified by IC_AnnounceFilterMode.