2.2.1.2.35 MIB_IPFORWARDROW

  • Article

The MIB_IPFORWARDROW structure contains information that describes an IPv4 network route. This structure is used in the following methods:

  • MIB_OPAQUE_INFO (section 2.2.1.2.52)

  • MIB_IPDESTROW (section 2.2.1.2.20) 

  • MIB_IPFORWARDTABLE (section 2.2.1.2.36) 

     typedef struct _MIB_IPFORWARDROW 
 {
   DWORD dwForwardDest;
   DWORD dwForwardMask;
   DWORD dwForwardPolicy;
   DWORD dwForwardNextHop;
   DWORD dwForwardIfIndex;
   union {
     DWORD dwForwardType;
     MIB_IPFORWARD_TYPE ForwardType;
   };
   union {
     DWORD dwForwardProto;
     MIB_IPFORWARD_PROTO ForwardProto;
   };
   DWORD dwForwardAge;
   DWORD dwForwardNextHopAS;
   DWORD dwForwardMetric1;
   DWORD dwForwardMetric2;
   DWORD dwForwardMetric3;
   DWORD dwForwardMetric4;
   DWORD dwForwardMetric5;
 } MIB_IPFORWARDROW,
  *PMIB_IPFORWARDROW;

dwForwardDest: The destination IPv4 address of the route. An entry with an IPv4 address of 0.0.0.0 is considered a default route. This member MUST NOT be set to a multicast (class D) IPv4 address.

dwForwardMask: The IPv4 subnet mask to be logically ANDed with the destination IPv4 address before being compared to the value in the dwForwardDest member; see [RFC950].

dwForwardPolicy: The set of conditions that would cause the selection of a multipath route (the set of next hops for a given destination). This member is typically in IP TOS format. The encoding of this member is specified in [RFC1354].

dwForwardNextHop: For remote routes, the IPv4 address of the next system in the route. Otherwise, this member SHOULD be an IPv4 address of 0x00000000.

dwForwardIfIndex: The index of the local interface through which the next hop of this route is reachable. This MUST be an interface index of one of the interfaces on RRAS.

dwForwardType: The route type as specified in [RFC1354]. The enum MIB_IPFORWARD_TYPE (section 2.2.1.1.8) describes the possible values for this member. In addition, dwForwardType can also be IP_PRIORITY_MAX_METRIC (0x000000FF) or IP_PRIORITY_DEFAULT_METRIC (0x0000007F).

ForwardType: The route type as specified in [RFC1354].<34>

dwForwardProto: The protocol or routing mechanism that generated the route. It can take one of the values specified in [RFC1354]. The enum MIB_IPFORWARD_PROTO (section 2.2.1.1.9) describes the possible values for this member. 

ForwardProto: The protocol or routing mechanism that generated the route.<35>

dwForwardAge: The number of seconds since the route was added or modified in the network routing table. The dwForwardAge member is also used if the RRAS server is running for routes of type PROTO_IP_NETMGMT as defined on the Protocol Identifiers reference page. When dwForwardAge is set to INFINITE (-1) when running the RRAS server, the route will not be removed based on a time-out value.

dwForwardNextHopAS: The autonomous system number of the next hop. When this member is unknown or not relevant to the protocol or routing mechanism specified in dwForwardProto, this value SHOULD be set to 0. This value is documented in [RFC1354].

dwForwardMetric1: The primary routing metric value for this route. The semantics of this metric are determined by the routing protocol specified in the dwForwardProto member. If this metric is not used, its value SHOULD be set to MIB_IPROUTE_METRIC_UNUSED (-1). This value is documented in [RFC1354].

dwForwardMetric2: An alternate routing metric value for this route. The semantics of this metric are determined by the routing protocol specified in the dwForwardProto member. If this metric is not used, its value SHOULD be set to -1. This value is documented in [RFC1354].

dwForwardMetric3: An alternate routing metric value for this route. The semantics of this metric are determined by the routing protocol specified in the dwForwardProto member. If this metric is not used, its value SHOULD be set to -1. This value is documented in [RFC1354].

dwForwardMetric4: An alternate routing metric value for this route. The semantics of this metric are determined by the routing protocol specified in the dwForwardProto member. If this metric is not used, its value SHOULD be set to -1. This value is documented in [RFC1354].

dwForwardMetric5: An alternate routing metric value for this route. The semantics of this metric are determined by the routing protocol specified in the dwForwardProto member. If this metric is not used, its value SHOULD be set to -1. This value is documented in [RFC1354].