Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_ip_route_table.h
Go to the documentation of this file.
1 
9 /*****************************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_ip_route_table.h
28 *
29 * @purpose IP Route Table support
30 *
31 * @component OpEN
32 *
33 * @create 05/26/2016
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_IP_ROUTE_TABLE_H_INCLUDED
39 #define OPENAPI_IP_ROUTE_TABLE_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_API_ROUTE_PREF_MIN 0
44 #define OPEN_API_ROUTE_PREF_MAX 255
45 #define OPEN_API_ROUTE_NEXT_HOP_INTF_BUF_MIN ((16 * 60) + 1)
46 #define OPEN_API_ROUTE_NEXT_HOP_ADDR_BUF_MIN ((16 * 20) + 1)
48 typedef enum
49 {
50  OPEN_RTO_RESERVED = 0,
51  OPEN_RTO_LOCAL = 1,
52  OPEN_RTO_KERNEL = 2,
53  OPEN_RTO_STATIC = 3,
54  OPEN_RTO_MPLS = 4,
55  OPEN_RTO_OSPF_INTRA_AREA = 5,
56  OPEN_RTO_OSPF_INTER_AREA = 6,
57  OPEN_RTO_OSPF_TYPE1_EXT = 7,
58  OPEN_RTO_OSPF_TYPE2_EXT = 8,
59  OPEN_RTO_OSPF_NSSA_TYPE1_EXT = 9,
60  OPEN_RTO_OSPF_NSSA_TYPE2_EXT = 10,
61  OPEN_RTO_OSPFV3_INTRA_AREA = 11,
62  OPEN_RTO_OSPFV3_INTER_AREA = 12,
63  OPEN_RTO_OSPFV3_TYPE1_EXT = 13,
64  OPEN_RTO_OSPFV3_TYPE2_EXT = 14,
65  OPEN_RTO_OSPFV3_NSSA_TYPE1_EXT = 15,
66  OPEN_RTO_OSPFV3_NSSA_TYPE2_EXT = 16,
67  OPEN_RTO_RIP = 17,
68  OPEN_RTO_DEFAULT = 18,
69  OPEN_RTO_IBGP = 19,
70  OPEN_RTO_EBGP = 20,
71  OPEN_RTO_LBGP = 21,
72  OPEN_RTO_EXTERNAL = 22,
73  OPEN_RTO_UNNUMBERED = 23,
74  OPEN_RTO_NET_PROTOTYPE = 24,
75  OPEN_RTO_LAST_PROTOCOL = 25
76 } OPEN_RTO_PROTOCOL_INDICES_t;
77 
78 typedef enum
79 {
80  OPEN_RTO6_LOCAL = 1,
81  OPEN_RTO6_KERNEL = 2,
82  OPEN_RTO6_STATIC = 3,
83  OPEN_RTO6_MPLS = 4,
84  OPEN_RTO6_OSPFV3_INTRA_AREA = 5,
85  OPEN_RTO6_OSPFV3_INTER_AREA = 6,
86  OPEN_RTO6_OSPFV3_TYPE1_EXT = 7,
87  OPEN_RTO6_OSPFV3_TYPE2_EXT = 8,
88  OPEN_RTO6_OSPFV3_NSSA_TYPE1_EXT = 9,
89  OPEN_RTO6_OSPFV3_NSSA_TYPE2_EXT = 10,
90  OPEN_RTO6_RIP = 11,
91  OPEN_RTO6_DEFAULT = 12,
92  OPEN_RTO6_IBGP = 13,
93  OPEN_RTO6_EBGP = 14,
94  OPEN_RTO6_LBGP = 15,
95  OPEN_RTO6_EXTERNAL = 16,
96  OPEN_RTO6_6TO4 = 17,
97  OPEN_RTO6_NET_PROTOTYPE = 18
98 } OPEN_RTO6_ROUTE_TYPE_INDICES_t;
99 
100 
101 /*****************************************************************/
124 open_error_t openapiIpRouteEntryGetNext(openapiClientHandle_t *client_handle,
125  uint32_t *routeDest,
126  uint32_t *routeMask,
127  OPEN_RTO_PROTOCOL_INDICES_t *routeProto,
128  uint32_t *routePref);
129 
130 /*****************************************************************/
150 open_error_t openapiIpRouteMetricGet(openapiClientHandle_t *client_handle,
151  uint32_t *routeDest,
152  uint32_t *routeMask,
153  OPEN_RTO_PROTOCOL_INDICES_t *routeProto,
154  uint32_t *routePref,
155  uint32_t *metric);
156 
157 /*****************************************************************/
178 open_error_t openapiIpRouteAgeGet(openapiClientHandle_t *client_handle,
179  uint32_t *routeDest,
180  uint32_t *routeMask,
181  OPEN_RTO_PROTOCOL_INDICES_t *routeProto,
182  uint32_t *routePref,
183  uint32_t *routeAge);
184 
185 /*****************************************************************/
205 open_error_t openapiIpRouteHwFailureGet(openapiClientHandle_t *client_handle,
206  uint32_t *routeDest,
207  uint32_t *routeMask,
208  OPEN_RTO_PROTOCOL_INDICES_t *routeProto,
209  uint32_t *routePref,
210  OPEN_BOOL_t *hwFailure);
211 
212 /*****************************************************************/
235 open_error_t openapiIpRouteNextHopIntfGet(openapiClientHandle_t *client_handle,
236  uint32_t *routeDest,
237  uint32_t *routeMask,
238  OPEN_RTO_PROTOCOL_INDICES_t *routeProto,
239  uint32_t *routePref,
240  open_buffdesc *nextHopIntf);
241 
242 /*****************************************************************/
265 open_error_t openapiIpRouteNextHopAddrGet(openapiClientHandle_t *client_handle,
266  uint32_t *routeDest,
267  uint32_t *routeMask,
268  OPEN_RTO_PROTOCOL_INDICES_t *routeProto,
269  uint32_t *routePref,
270  open_buffdesc *nextHopAddr);
271 #endif /* OPENAPI_IP_ROUTE_TABLE_H_INCLUDED */
272