Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_routing_config.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 * Licensed under the Apache License, Version 2.0 (the "License");
26 * you may not use this file except in compliance with the License.
27 * You may obtain a copy of the License at
28 *
29 * http://www.apache.org/licenses/LICENSE-2.0
30 *
31 * Unless required by applicable law or agreed to in writing, software
32 * distributed under the License is distributed on an "AS IS" BASIS,
33 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
34 * See the License for the specific language governing permissions and
35 * limitations under the License.
36 *
37 **********************************************************************
38 *
39 * @filename openapi_routing_config.h
40 *
41 * @purpose Routing Configuration and Status
42 *
43 * @component OPEN
44 *
45 * @create 11/28/2012
46 *
47 * @end
48 *
49 **********************************************************************/
50 #ifndef OPENAPI_ROUTING_CONFIG_H_INCLUDED
51 #define OPENAPI_ROUTING_CONFIG_H_INCLUDED
52 
53 #include <stdio.h>
54 #include <stddef.h>
55 #include <sys/un.h>
56 
57 #include "openapi_common.h"
58 #include "openapi_mpls.h"
59 
61 typedef enum
62 {
63  OPEN_IP_ADDR_TYPE_STATIC_PRIMARY = 0,
64  OPEN_IP_ADDR_TYPE_STATIC_SECONDARY = 1,
65  OPEN_IP_ADDR_TYPE_DHCP = 2
66 } OPEN_INTF_IP_ADDR_TYPE_t;
67 
68 
69 #define OPEN_VRF_MIN_NAME_LEN 0
70 #define OPEN_VRF_MAX_NAME_LEN 64
71 #define OPEN_DEFAULT_VRF_NAME ""
73 /*****************************************************************/
101 open_error_t openapiRtrIntfIpAddrAdd(openapiClientHandle_t *client_handle,
102  OPEN_AF_t af, uint32_t intf,
103  OPEN_INTF_IP_ADDR_TYPE_t addrType,
104  open_inet_pfx_t *ipAddr,
105  OPEN_CONTROL_t extArg);
106 
107 /*****************************************************************/
134 open_error_t openapiRtrIntfIpAddrDel(openapiClientHandle_t *client_handle,
135  OPEN_AF_t af,uint32_t intf,
136  OPEN_INTF_IP_ADDR_TYPE_t addrType,
137  open_inet_pfx_t *ipAddr,
138  OPEN_CONTROL_t extArg);
139 
140 /*****************************************************************/
156 open_error_t openapiRtrAdminModeSet(openapiClientHandle_t *client_handle,
157  OPEN_AF_t af, OPEN_CONTROL_t routingMode);
158 
159 /*****************************************************************/
178 open_error_t openapiArpEntryAdd(openapiClientHandle_t *client_handle,
179  open_inet_addr_t ipAddr,
180  open_buffdesc *mac_addr);
181 
182 /*****************************************************************/
198 open_error_t openapiArpEntryDel(openapiClientHandle_t *client_handle,
199  open_inet_addr_t ipAddr);
200 
201 /*****************************************************************/
225 open_error_t openapiArpEntryNextGet(openapiClientHandle_t *client_handle,
226  uint32_t *intf, open_inet_addr_t *ipAddr,
227  open_buffdesc *mac_addr);
228 
229 
230 /*****************************************************************/
245 open_error_t openapiIpRedirectsModeSet(openapiClientHandle_t *client_handle,
246  OPEN_CONTROL_t redirectsMode);
247 
248 /*****************************************************************/
263 open_error_t openapiIpICMPEchoReplyModeSet(openapiClientHandle_t *client_handle,
264  OPEN_CONTROL_t echoReplyMode);
265 
266 /*****************************************************************/
281 open_error_t openapiIpHelperModeSet(openapiClientHandle_t *client_handle,
282  OPEN_CONTROL_t ipHelperMode);
283 
284 /*****************************************************************/
302 open_error_t openapiIpHelperAddressAdd(openapiClientHandle_t *client_handle,
303  open_inet_addr_t ipAddr, uint32_t udpPort);
304 
305 
306 /*****************************************************************/
322 open_error_t openapiIpHelperAddressDel(openapiClientHandle_t *client_handle,
323  open_inet_addr_t ipAddr, uint32_t udpPort);
324 
325 
326 /*****************************************************************/
343 open_error_t openapiRtrIntfIpHelperAddressAdd(openapiClientHandle_t *client_handle,
344  uint32_t intf, open_inet_addr_t ipAddr,
345  uint32_t udpPort);
346 
347 
348 /*****************************************************************/
365 open_error_t openapiRtrIntfIpHelperAddressDel(openapiClientHandle_t *client_handle,
366  uint32_t intf, open_inet_addr_t ipAddr,
367  uint32_t udpPort);
368 
369 /*****************************************************************/
385 open_error_t openapiRtrIntfIpHelperDiscardAdd(openapiClientHandle_t *client_handle,
386  uint32_t intf, uint32_t udpPort);
387 
388 
389 /*****************************************************************/
405 open_error_t openapiRtrIntfIpHelperDiscardDel(openapiClientHandle_t *client_handle,
406  uint32_t intf, uint32_t udpPort);
407 
408 
409 /*****************************************************************/
427 open_error_t openapiRtrIntfMTUSet(openapiClientHandle_t *client_handle,
428  OPEN_AF_t af, uint32_t intf, uint32_t MTU);
429 
430 /*****************************************************************/
446 open_error_t openapiRtrIntfIpNetDirBroadcastModeSet(openapiClientHandle_t *client_handle,
447  uint32_t intf, OPEN_CONTROL_t ipNetBroadcastMode);
448 
449 /*****************************************************************/
465 open_error_t openapiRtrIntfIpProxyArpModeSet(openapiClientHandle_t *client_handle,
466  uint32_t intf, OPEN_CONTROL_t ipProxyArpMode);
467 
468 
469 /*****************************************************************/
485 open_error_t openapiRtrIntfIpRedirectsModeSet(openapiClientHandle_t *client_handle,
486  uint32_t intf, OPEN_CONTROL_t redirectsMode);
487 
488 
489 /*****************************************************************/
506 open_error_t openapiRtrIntfIpDestUnreachableModeSet(openapiClientHandle_t *client_handle,
507  uint32_t intf, OPEN_CONTROL_t unreachableMode);
508 
509 
510 /*****************************************************************/
526 open_error_t openapiRtrIntfRtrAdminModeSet(openapiClientHandle_t *client_handle, uint32_t intf,
527  OPEN_CONTROL_t routingMode);
528 
529 /*****************************************************************/
553 open_error_t openapiIpRouteAdd(openapiClientHandle_t *client_handle,
554  OPEN_AF_t af, open_inet_pfx_t *ipAddr,
555  open_inet_addr_t *nextHop, uint32_t rtPref,
556  uint32_t intf, OPEN_MPLS_LABELS_t *mpls);
557 
558 /*****************************************************************/
579 open_error_t openapiIpRouteDel(openapiClientHandle_t *client_handle,
580  OPEN_AF_t af, open_inet_pfx_t *ipAddr,
581  open_inet_addr_t *nextHop, uint32_t intf,
582  OPEN_MPLS_LABELS_t *mpls);
583 
584 /*****************************************************************/
602 open_error_t openapiRtrVlanIntfCreate(openapiClientHandle_t *client_handle,
603  uint32_t vlanId);
604 
605 /*****************************************************************/
621 open_error_t openapiRtrVlanIntfDelete(openapiClientHandle_t *client_handle,
622  uint32_t vlanId);
623 
624 /*****************************************************************/
639 open_error_t openapiRtrVlanIntfIfNumGet(openapiClientHandle_t *client_handle,
640  uint32_t vlanId, uint32_t *intf);
641 
642 #endif /* OPENAPI_ROUTING_CONFIG_H_INCLUDED */
643