Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_ospf_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_ospf_config.h
40 *
41 * @purpose Open Shortest Path First Configuration and Status
42 *
43 * @component OPEN
44 *
45 * @create 06/25/2013
46 *
47 * @end
48 *
49 **********************************************************************/
50 #ifndef OPENAPI_OSPF_CONFIG_H_INCLUDED
51 #define OPENAPI_OSPF_CONFIG_H_INCLUDED
52 
53 #include <stdbool.h>
54 #include "openapi_common.h"
55 
56 #define OPEN_OSPF_INTF_SECONDARIES_NONE 0
57 #define OPEN_OSPF_INTF_SECONDARIES_ALL 0xFFFFFFFFUL
59 #define OPEN_OSPF_INTF_METRIC_NOT_CONFIGURED 0
61 
62 
63 typedef enum
64 {
65  OPEN_OSPF_AREA_ID_INTEGER_FORMAT = 0,
66  OPEN_OSPF_AREA_ID_DOTTED_DECIMAL_FORMAT = 1
67 } OPEN_OSPF_AREA_ID_FORMAT_t;
68 
69 typedef enum
70 {
71  OPEN_OSPF_AREA_IMPORT_EXT = 1,
72  OPEN_OSPF_AREA_IMPORT_NO_EXT = 2,
73  OPEN_OSPF_AREA_IMPORT_NSSA = 3
74 } OPEN_OSPF_AREA_EXT_ROUTING_t;
75 
76 typedef enum
77 {
78  OPEN_OSPF_AREA_NO_SUMMARY = 1,
79  OPEN_OSPF_AREA_SEND_SUMMARY = 2
80 } OPEN_OSPF_AREA_SUMMARY_t;
81 
82 typedef enum
83 {
84  OPEN_OSPF_INTF_DEFAULT = 0,
85  OPEN_OSPF_INTF_BROADCAST = 1,
86  OPEN_OSPF_INTF_PTP = 3
87 } OPEN_OSPF_INTF_TYPES_t;
88 
90 typedef enum
91 {
92  OPEN_OSPF_METRIC_EXT_TYPE1 = 1,
93  OPEN_OSPF_METRIC_EXT_TYPE2 = 2
94 } OPEN_OSPF_EXT_METRIC_TYPES_t;
95 
96 typedef enum
97 {
98  OPEN_OSPF_STUB_RTR_CFG_DISABLED = 0,
99  OPEN_OSPF_STUB_RTR_CFG_ALWAYS = 1,
100  OPEN_OSPF_STUB_RTR_CFG_STARTUP = 2
101 } OPEN_OSPF_STUB_ROUTER_CFG_t;
102 
104 typedef enum
105 {
106  OPEN_OSPF_TOS_NORMAL_SERVICE = 0,
107  OPEN_OSPF_TOS_MINIMIZE_COST = 2,
108  OPEN_OSPF_TOS_MAXIMIZE_RELIABILITY = 4,
109  OPEN_OSPF_TOS_MAXIMIZE_THROUGHPUT = 8,
110  OPEN_OSPF_TOS_MINIMIZE_DELAY = 16
111 } OPEN_OSPF_TOS_METRIC_TYPES_t;
112 
114 typedef enum
115 {
116  OPEN_OSPF_TRAP_NONE = 0x0,
117  OPEN_OSPF_TRAP_VIRT_IF_STATE_CHANGE = 0x1,
118  OPEN_OSPF_TRAP_NBR_STATE_CHANGE = 0x2,
119  OPEN_OSPF_TRAP_VIRT_NBR_STATE_CHANGE = 0x4,
120  OPEN_OSPF_TRAP_IF_CONFIG_ERROR = 0x8,
121  OPEN_OSPF_TRAP_VIRT_IF_CONFIG_ERROR = 0x10,
122  OPEN_OSPF_TRAP_IF_AUTH_FAILURE = 0x20,
123  OPEN_OSPF_TRAP_VIRT_IF_AUTH_FAILURE = 0x40,
124  OPEN_OSPF_TRAP_RX_BAD_PACKET = 0x80,
125  OPEN_OSPF_TRAP_VIRT_IF_RX_BAD_PACKET = 0x100,
126  OPEN_OSPF_TRAP_TX_RETRANSMIT = 0x200,
127  OPEN_OSPF_TRAP_VIRT_IF_TX_RETRANSMIT = 0x400,
128  OPEN_OSPF_TRAP_ORIGINATE_LSA = 0x800,
129  OPEN_OSPF_TRAP_MAX_AGE_LSA = 0x1000,
130  OPEN_OSPF_TRAP_LS_DB_OVERFLOW = 0x2000,
131  OPEN_OSPF_TRAP_LS_DB_APPROACHING_OVERFLOW = 0x4000,
132  OPEN_OSPF_TRAP_IF_STATE_CHANGE = 0x8000,
133  OPEN_OSPF_TRAP_IF_RX_PACKET = 0x10000,
134  OPEN_OSPF_TRAP_RTB_ENTRY_INFO = 0x20000
135 } OPEN_OSPF_TRAP_TYPES_t;
136 
137 /*****************************************************************/
157 open_error_t openapiOspfMapAreaSummaryGet(openapiClientHandle_t *client_handle,
158  uint32_t areaId,
159  OPEN_OSPF_AREA_SUMMARY_t *summary);
160 
161 /*****************************************************************/
183 open_error_t openapiOspfMapAreaSummarySet(openapiClientHandle_t *client_handle,
184  uint32_t areaId,
185  OPEN_OSPF_AREA_SUMMARY_t summary);
186 
187 /*****************************************************************/
200 open_error_t openapiOspfMapAutoCostRefBwGet(openapiClientHandle_t *client_handle,
201  uint32_t *autoCost);
202 
203 /*****************************************************************/
220 open_error_t openapiOspfMapAutoCostRefBwSet(openapiClientHandle_t *client_handle,
221  uint32_t autoCost);
222 
223 /*****************************************************************/
245 open_error_t openapiOspfMapImportAsExternGet(openapiClientHandle_t *client_handle,
246  uint32_t areaId,
247  OPEN_OSPF_AREA_EXT_ROUTING_t *import);
248 
249 /*****************************************************************/
275 open_error_t openapiOspfMapImportAsExternSet(openapiClientHandle_t *client_handle,
276  uint32_t areaId,
277  OPEN_OSPF_AREA_EXT_ROUTING_t import);
278 
279 /*****************************************************************/
296 open_error_t openapiOspfMapIntfAdminModeGet(openapiClientHandle_t *client_handle,
297  uint32_t intf,
298  OPEN_CONTROL_t *mode);
299 
300 /*****************************************************************/
321 open_error_t openapiOspfMapIntfAdminModeSet(openapiClientHandle_t *client_handle,
322  uint32_t intf,
323  OPEN_CONTROL_t mode);
324 
325 /*****************************************************************/
341 open_error_t openapiOspfMapIntfAreaIdGet(openapiClientHandle_t *client_handle,
342  uint32_t intf,
343  uint32_t *areaId,
344  OPEN_CONTROL_t *mode);
345 
346 /*****************************************************************/
366 open_error_t openapiOspfMapIntfAreaIdSet(openapiClientHandle_t *client_handle,
367  uint32_t intf,
368  uint32_t areaId,
369  OPEN_CONTROL_t mode);
370 
371 /*****************************************************************/
392 open_error_t openapiOspfMapIntfDeadIntervalGet(openapiClientHandle_t *client_handle,
393  uint32_t intf,
394  uint32_t *seconds);
395 
396 /*****************************************************************/
420 open_error_t openapiOspfMapIntfDeadIntervalSet(openapiClientHandle_t *client_handle,
421  uint32_t intf,
422  uint32_t seconds);
423 
424 /*****************************************************************/
444 open_error_t openapiOspfMapIntfHelloIntervalGet(openapiClientHandle_t *client_handle,
445  uint32_t intf,
446  uint32_t *seconds);
447 
448 /*****************************************************************/
471 open_error_t openapiOspfMapIntfHelloIntervalSet(openapiClientHandle_t *client_handle,
472  uint32_t intf,
473  uint32_t seconds);
474 
475 /*****************************************************************/
491 open_error_t openapiOspfMapIntfMetricValueGet(openapiClientHandle_t *client_handle,
492  uint32_t intf,
493  OPEN_OSPF_TOS_METRIC_TYPES_t tos,
494  uint32_t *metric);
495 
496 /*****************************************************************/
520 open_error_t openapiOspfMapIntfMetricValueSet(openapiClientHandle_t *client_handle,
521  uint32_t intf,
522  uint32_t ipAddr,
523  OPEN_OSPF_TOS_METRIC_TYPES_t tos,
524  uint32_t metric);
525 
526 /*****************************************************************/
543 open_error_t openapiOspfMapIntfPassiveModeGet(openapiClientHandle_t *client_handle,
544  uint32_t intf,
545  bool *mode);
546 
547 /*****************************************************************/
565 open_error_t openapiOspfMapIntfPassiveModeSet(openapiClientHandle_t *client_handle,
566  uint32_t intf,
567  bool mode);
568 
569 /*****************************************************************/
586 open_error_t openapiOspfMapIntfSecondariesFlagGet(openapiClientHandle_t *client_handle,
587  uint32_t intf,
588  uint32_t *secondaries);
589 
590 /*****************************************************************/
608 open_error_t openapiOspfMapIntfSecondariesFlagSet(openapiClientHandle_t *client_handle,
609  uint32_t intf,
610  uint32_t secondaries);
611 
612 /*****************************************************************/
627 open_error_t openapiOspfMapIntfTypeGet(openapiClientHandle_t *client_handle,
628  uint32_t intf,
629  OPEN_OSPF_INTF_TYPES_t *type);
630 
631 /*****************************************************************/
647 open_error_t openapiOspfMapIntfTypeSet(openapiClientHandle_t *client_handle,
648  uint32_t intf,
649  OPEN_OSPF_INTF_TYPES_t type);
650 
651 /*****************************************************************/
668 open_error_t openapiOspfMapLogAdjChngGet(openapiClientHandle_t *client_handle,
669  OPEN_CONTROL_t *log,
670  bool *detail);
671 
672 /*****************************************************************/
690 open_error_t openapiOspfMapLogAdjChngSet(openapiClientHandle_t *client_handle,
691  OPEN_CONTROL_t log,
692  bool detail);
693 
694 /*****************************************************************/
707 open_error_t openapiOspfMapMaxPathsGet(openapiClientHandle_t *client_handle,
708  uint32_t *maxPaths);
709 
710 /*****************************************************************/
731 open_error_t openapiOspfMapMaxPathsSet(openapiClientHandle_t *client_handle,
732  uint32_t maxPaths);
733 
734 /*****************************************************************/
751 open_error_t openapiOspfMapNetworkAreaEntryDelete(openapiClientHandle_t *client_handle,
752  uint32_t ipAddr,
753  uint32_t wildcardMask,
754  uint32_t areaId);
755 
756 /*****************************************************************/
772 open_error_t openapiOspfMapNetworkAreaEntryGet(openapiClientHandle_t *client_handle,
773  uint32_t ipAddr,
774  uint32_t wildcardMask,
775  uint32_t areaId,
776  bool *found);
777 
778 /*****************************************************************/
800 open_error_t openapiOspfMapNetworkAreaEntrySet(openapiClientHandle_t *client_handle,
801  uint32_t ipAddr,
802  uint32_t wildcardMask,
803  uint32_t areaId,
804  OPEN_OSPF_AREA_ID_FORMAT_t areaIdFmt);
805 
806 /*****************************************************************/
826 open_error_t openapiOspfMapNSSAImportSummariesGet(openapiClientHandle_t *client_handle,
827  uint32_t areaId,
828  OPEN_OSPF_AREA_SUMMARY_t *summary);
829 
830 /*****************************************************************/
852 open_error_t openapiOspfMapNSSAImportSummariesSet(openapiClientHandle_t *client_handle,
853  uint32_t areaId,
854  OPEN_OSPF_AREA_SUMMARY_t summary);
855 
856 /*****************************************************************/
898 open_error_t openapiOspfMapRedistributionSet(openapiClientHandle_t *client_handle,
899  bool redistribute,
900  open_buffdesc *sourceProto,
901  uint32_t distList,
902  uint32_t metric,
903  OPEN_OSPF_EXT_METRIC_TYPES_t type,
904  int32_t tag,
905  bool subnets);
906 
907 /*****************************************************************/
921 open_error_t openapiOspfMapRouterIdGet(openapiClientHandle_t *client_handle,
922  uint32_t *routerId);
923 
924 /*****************************************************************/
941 open_error_t openapiOspfMapRouterIdSet(openapiClientHandle_t *client_handle,
942  uint32_t routerId);
943 
944 /*****************************************************************/
963 open_error_t openapiOspfMapRfc1583CompatibilityGet(openapiClientHandle_t *client_handle,
964  OPEN_CONTROL_t *mode);
965 
966 /*****************************************************************/
987 open_error_t openapiOspfMapRfc1583CompatibilitySet(openapiClientHandle_t *client_handle,
988  OPEN_CONTROL_t mode);
989 
990 /*****************************************************************/
1004 open_error_t openapiOspfMapSpfDelayTimeGet(openapiClientHandle_t *client_handle,
1005  uint32_t *time);
1006 
1007 /*****************************************************************/
1025 open_error_t openapiOspfMapSpfDelayTimeSet(openapiClientHandle_t *client_handle,
1026  uint32_t time);
1027 
1028 /*****************************************************************/
1042 open_error_t openapiOspfMapSpfHoldTimeGet(openapiClientHandle_t *client_handle,
1043  uint32_t *time);
1044 
1045 /*****************************************************************/
1063 open_error_t openapiOspfMapSpfHoldTimeSet(openapiClientHandle_t *client_handle,
1064  uint32_t time);
1065 
1066 /*****************************************************************/
1094 open_error_t openapiOspfMapStubRtrModeGet(openapiClientHandle_t *client_handle,
1095  OPEN_OSPF_STUB_ROUTER_CFG_t *mode,
1096  uint32_t *duration,
1097  bool *override,
1098  uint32_t *metric);
1099 
1100 /*****************************************************************/
1121 open_error_t openapiOspfMapStubRtrModeSet(openapiClientHandle_t *client_handle,
1122  OPEN_OSPF_STUB_ROUTER_CFG_t mode,
1123  uint32_t duration);
1124 
1125 /*****************************************************************/
1145 open_error_t openapiOspfMapStubRtrSumLsaMetricOverride(openapiClientHandle_t *client_handle,
1146  bool override,
1147  uint32_t metric);
1148 
1149 /*****************************************************************/
1166 open_error_t openapiOspfTrapModeGet(openapiClientHandle_t *client_handle,
1167  OPEN_OSPF_TRAP_TYPES_t trapType,
1168  bool *mode);
1169 
1170 /*****************************************************************/
1189 open_error_t openapiOspfTrapModeSet(openapiClientHandle_t *client_handle,
1190  OPEN_OSPF_TRAP_TYPES_t trapType,
1191  bool mode);
1192 
1193 #endif /* OPENAPI_OSPF_CONFIG_H_INCLUDED */
1194