Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_ip_route_table.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_API_ROUTE_NEXT_HOP_ADDR_BUF_MIN   ((16 * 20) + 1)
 Minimum size of the buffer for the nex hop IP addresses list.
 
#define OPEN_API_ROUTE_NEXT_HOP_INTF_BUF_MIN   ((16 * 60) + 1)
 Minimum size of the buffer for the nex hop interfaces list.
 
#define OPEN_API_ROUTE_PREF_MAX   255
 Maximum value of the route preference.
 
#define OPEN_API_ROUTE_PREF_MIN   0
 Maximum value of the route preference.
 

Enumerations

enum  OPEN_RTO6_ROUTE_TYPE_INDICES_t {
  OPEN_RTO6_LOCAL = 1, OPEN_RTO6_KERNEL = 2, OPEN_RTO6_STATIC = 3, OPEN_RTO6_MPLS = 4,
  OPEN_RTO6_OSPFV3_INTRA_AREA = 5, OPEN_RTO6_OSPFV3_INTER_AREA = 6, OPEN_RTO6_OSPFV3_TYPE1_EXT = 7, OPEN_RTO6_OSPFV3_TYPE2_EXT = 8,
  OPEN_RTO6_OSPFV3_NSSA_TYPE1_EXT = 9, OPEN_RTO6_OSPFV3_NSSA_TYPE2_EXT = 10, OPEN_RTO6_RIP = 11, OPEN_RTO6_DEFAULT = 12,
  OPEN_RTO6_IBGP = 13, OPEN_RTO6_EBGP = 14, OPEN_RTO6_LBGP = 15, OPEN_RTO6_EXTERNAL = 16,
  OPEN_RTO6_6TO4 = 17, OPEN_RTO6_NET_PROTOTYPE = 18
}
 
enum  OPEN_RTO_PROTOCOL_INDICES_t {
  OPEN_RTO_RESERVED = 0, OPEN_RTO_LOCAL = 1, OPEN_RTO_KERNEL = 2, OPEN_RTO_STATIC = 3,
  OPEN_RTO_MPLS = 4, OPEN_RTO_OSPF_INTRA_AREA = 5, OPEN_RTO_OSPF_INTER_AREA = 6, OPEN_RTO_OSPF_TYPE1_EXT = 7,
  OPEN_RTO_OSPF_TYPE2_EXT = 8, OPEN_RTO_OSPF_NSSA_TYPE1_EXT = 9, OPEN_RTO_OSPF_NSSA_TYPE2_EXT = 10, OPEN_RTO_OSPFV3_INTRA_AREA = 11,
  OPEN_RTO_OSPFV3_INTER_AREA = 12, OPEN_RTO_OSPFV3_TYPE1_EXT = 13, OPEN_RTO_OSPFV3_TYPE2_EXT = 14, OPEN_RTO_OSPFV3_NSSA_TYPE1_EXT = 15,
  OPEN_RTO_OSPFV3_NSSA_TYPE2_EXT = 16, OPEN_RTO_RIP = 17, OPEN_RTO_DEFAULT = 18, OPEN_RTO_IBGP = 19,
  OPEN_RTO_EBGP = 20, OPEN_RTO_LBGP = 21, OPEN_RTO_EXTERNAL = 22, OPEN_RTO_UNNUMBERED = 23,
  OPEN_RTO_NET_PROTOTYPE = 24, OPEN_RTO_LAST_PROTOCOL = 25
}
 

Functions

open_error_t openapiIpRouteAgeGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, uint32_t *routeAge)
 Gets the number of seconds since this route was last updated or otherwise determined to be correct. More...
 
open_error_t openapiIpRouteEntryGetNext (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref)
 Gets the next route entry for the specified route destination. More...
 
open_error_t openapiIpRouteHwFailureGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, OPEN_BOOL_t *hwFailure)
 Gets the hardware failure flag for this route. More...
 
open_error_t openapiIpRouteMetricGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, uint32_t *metric)
 Gets the primary routing metric for this route. More...
 
open_error_t openapiIpRouteNextHopAddrGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, open_buffdesc *nextHopAddr)
 Gets the comma separated list of the IP addresses of the next hop of this route. More...
 
open_error_t openapiIpRouteNextHopIntfGet (openapiClientHandle_t *client_handle, uint32_t *routeDest, uint32_t *routeMask, OPEN_RTO_PROTOCOL_INDICES_t *routeProto, uint32_t *routePref, open_buffdesc *nextHopIntf)
 Gets the comma separated list of the local interfaces through which the next hop of this route should be reached. More...