Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
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 typedef enum
64 {
68 
69 typedef enum
70 {
75 
76 typedef enum
77 {
81 
82 typedef enum
83 {
88 
90 typedef enum
91 {
95 
96 typedef enum
97 {
102 
104 typedef enum
105 {
112 
114 typedef enum
115 {
136 
137 /*****************************************************************/
158  uint32_t areaId,
159  OPEN_OSPF_AREA_SUMMARY_t *summary);
160 
161 /*****************************************************************/
184  uint32_t areaId,
185  OPEN_OSPF_AREA_SUMMARY_t summary);
186 
187 /*****************************************************************/
201  uint32_t *autoCost);
202 
203 /*****************************************************************/
221  uint32_t autoCost);
222 
223 /*****************************************************************/
246  uint32_t areaId,
248 
249 /*****************************************************************/
276  uint32_t areaId,
278 
279 /*****************************************************************/
297  uint32_t intf,
298  OPEN_CONTROL_t *mode);
299 
300 /*****************************************************************/
322  uint32_t intf,
323  OPEN_CONTROL_t mode);
324 
325 /*****************************************************************/
342  uint32_t intf,
343  uint32_t *areaId,
344  OPEN_CONTROL_t *mode);
345 
346 /*****************************************************************/
367  uint32_t intf,
368  uint32_t areaId,
369  OPEN_CONTROL_t mode);
370 
371 /*****************************************************************/
393  uint32_t intf,
394  uint32_t *seconds);
395 
396 /*****************************************************************/
421  uint32_t intf,
422  uint32_t seconds);
423 
424 /*****************************************************************/
445  uint32_t intf,
446  uint32_t *seconds);
447 
448 /*****************************************************************/
472  uint32_t intf,
473  uint32_t seconds);
474 
475 /*****************************************************************/
492  uint32_t intf,
494  uint32_t *metric);
495 
496 /*****************************************************************/
521  uint32_t intf,
522  uint32_t ipAddr,
524  uint32_t metric);
525 
526 /*****************************************************************/
544  uint32_t intf,
545  bool *mode);
546 
547 /*****************************************************************/
566  uint32_t intf,
567  bool mode);
568 
569 /*****************************************************************/
587  uint32_t intf,
588  uint32_t *secondaries);
589 
590 /*****************************************************************/
609  uint32_t intf,
610  uint32_t secondaries);
611 
612 /*****************************************************************/
628  uint32_t intf,
629  OPEN_OSPF_INTF_TYPES_t *type);
630 
631 /*****************************************************************/
648  uint32_t intf,
650 
651 /*****************************************************************/
669  OPEN_CONTROL_t *log,
670  bool *detail);
671 
672 /*****************************************************************/
691  OPEN_CONTROL_t log,
692  bool detail);
693 
694 /*****************************************************************/
708  uint32_t *maxPaths);
709 
710 /*****************************************************************/
732  uint32_t maxPaths);
733 
734 /*****************************************************************/
752  uint32_t ipAddr,
753  uint32_t wildcardMask,
754  uint32_t areaId);
755 
756 /*****************************************************************/
773  uint32_t ipAddr,
774  uint32_t wildcardMask,
775  uint32_t areaId,
776  bool *found);
777 
778 /*****************************************************************/
801  uint32_t ipAddr,
802  uint32_t wildcardMask,
803  uint32_t areaId,
804  OPEN_OSPF_AREA_ID_FORMAT_t areaIdFmt);
805 
806 /*****************************************************************/
827  uint32_t areaId,
828  OPEN_OSPF_AREA_SUMMARY_t *summary);
829 
830 /*****************************************************************/
853  uint32_t areaId,
854  OPEN_OSPF_AREA_SUMMARY_t summary);
855 
856 /*****************************************************************/
899  bool redistribute,
900  open_buffdesc *sourceProto,
901  uint32_t distList,
902  uint32_t metric,
904  int32_t tag,
905  bool subnets);
906 
907 /*****************************************************************/
922  uint32_t *routerId);
923 
924 /*****************************************************************/
942  uint32_t routerId);
943 
944 /*****************************************************************/
964  OPEN_CONTROL_t *mode);
965 
966 /*****************************************************************/
988  OPEN_CONTROL_t mode);
989 
990 /*****************************************************************/
1005  uint32_t *time);
1006 
1007 /*****************************************************************/
1026  uint32_t time);
1027 
1028 /*****************************************************************/
1043  uint32_t *time);
1044 
1045 /*****************************************************************/
1064  uint32_t time);
1065 
1066 /*****************************************************************/
1096  uint32_t *duration,
1097  bool *override,
1098  uint32_t *metric);
1099 
1100 /*****************************************************************/
1123  uint32_t duration);
1124 
1125 /*****************************************************************/
1146  bool override,
1147  uint32_t metric);
1148 
1149 /*****************************************************************/
1167  OPEN_OSPF_TRAP_TYPES_t trapType,
1168  bool *mode);
1169 
1170 /*****************************************************************/
1190  OPEN_OSPF_TRAP_TYPES_t trapType,
1191  bool mode);
1192 
1193 #endif /* OPENAPI_OSPF_CONFIG_H_INCLUDED */
1194 
link-state database has aged
Import and propagate T5 LSAs.
open_error_t openapiOspfMapRedistributionSet(openapiClientHandle_t *client_handle, bool redistribute, open_buffdesc *sourceProto, uint32_t distList, uint32_t metric, OPEN_OSPF_EXT_METRIC_TYPES_t type, int32_t tag, bool subnets)
Set configuration parameters for OSPF's redistribution of routes from other sources.
Import and propagate T7 LSAs.
non-virtual interface, can't be parsed
virtual interface, OSPF neighbor state change
open_error_t openapiOspfMapIntfSecondariesFlagSet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t secondaries)
Set the SecondariesFlag for the specified interface.
open_error_t openapiOspfMapIntfAdminModeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t *mode)
Get the OSPF admin mode for the specified interface.
non-virtual interface, auth mismatch
open_error_t openapiOspfMapIntfHelloIntervalSet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t seconds)
Sets the Ospf Hello Interval for the specified interface.
open_error_t openapiOspfMapAutoCostRefBwGet(openapiClientHandle_t *client_handle, uint32_t *autoCost)
Get the autocost reference bandwidth for OSPF links.
Configured as a stub router.
open_error_t openapiOspfMapRouterIdGet(openapiClientHandle_t *client_handle, uint32_t *routerId)
Get the OSPF router ID.
open_error_t openapiOspfMapIntfHelloIntervalGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *seconds)
Get the Ospf Hello Interval for the specified interface.
open_error_t openapiOspfMapIntfSecondariesFlagGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *secondaries)
Get the SecondariesFlag for the specified interface.
non-virtual interface, OSPF neighbor state change
open_error_t openapiOspfMapIntfMetricValueGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_OSPF_TOS_METRIC_TYPES_t tos, uint32_t *metric)
Get the interface metric value.
OPEN_OSPF_TOS_METRIC_TYPES_t
Type of Service.
open_error_t openapiOspfMapIntfTypeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_OSPF_INTF_TYPES_t *type)
Get the OSPF interface type.
open_error_t openapiOspfMapStubRtrSumLsaMetricOverride(openapiClientHandle_t *client_handle, bool override, uint32_t metric)
Set the configured stub router advertisement mode.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiOspfMapIntfAdminModeSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t mode)
Set the OSPF admin mode for the specified interface.
new link-state has originated
open_error_t openapiOspfMapStubRtrModeGet(openapiClientHandle_t *client_handle, OPEN_OSPF_STUB_ROUTER_CFG_t *mode, uint32_t *duration, bool *override, uint32_t *metric)
Get the configured stub router advertisement mode.
non-virtual interface, parameter conflict
open_error_t openapiOspfMapIntfAreaIdSet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t areaId, OPEN_CONTROL_t mode)
Sets the OSPF area id for the specified interface.
OPEN_OSPF_AREA_SUMMARY_t
open_error_t openapiOspfMapLogAdjChngGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *log, bool *detail)
Get logging information of neighbor state changes.
open_error_t openapiOspfMapAreaSummaryGet(openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_SUMMARY_t *summary)
Get the area summary.
open_error_t openapiOspfMapImportAsExternGet(openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_EXT_ROUTING_t *import)
Get the area's support for importing AS external link-state advertisements.
open_error_t openapiOspfMapIntfDeadIntervalSet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t seconds)
Sets the Ospf Dead Interval for the specified interface.
OPEN_OSPF_INTF_TYPES_t
open_error_t openapiOspfMapSpfHoldTimeSet(openapiClientHandle_t *client_handle, uint32_t time)
Sets the minimum time (in seconds) between two consecutive SPF calculations.
Is a stub router for a limited time after reboot.
open_error_t openapiOspfMapSpfHoldTimeGet(openapiClientHandle_t *client_handle, uint32_t *time)
Gets the minimum time (in seconds) between two consecutive SPF calculations.
OPEN_OSPF_STUB_ROUTER_CFG_t
open_error_t openapiOspfMapIntfMetricValueSet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t ipAddr, OPEN_OSPF_TOS_METRIC_TYPES_t tos, uint32_t metric)
Set the interface metric value.
open_error_t openapiOspfMapMaxPathsGet(openapiClientHandle_t *client_handle, uint32_t *maxPaths)
Get the maximum number of paths that OSPF can report.
open_error_t openapiOspfMapMaxPathsSet(openapiClientHandle_t *client_handle, uint32_t maxPaths)
Set the maximum number of paths that OSPF can report.
open_error_t openapiOspfMapIntfPassiveModeSet(openapiClientHandle_t *client_handle, uint32_t intf, bool mode)
Sets the passive mode of the interface.
open_error_t openapiOspfMapRfc1583CompatibilityGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Get OSPF mode for RFC 1583 compatibility.
open_error_t openapiOspfTrapModeSet(openapiClientHandle_t *client_handle, OPEN_OSPF_TRAP_TYPES_t trapType, bool mode)
Allows a user to enable or disable traps based on the specified mode.
open_error_t openapiOspfMapIntfTypeSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_OSPF_INTF_TYPES_t type)
Set the OSPF interface type.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
virtual interface, auth mismatch
open_error_t openapiOspfMapAutoCostRefBwSet(openapiClientHandle_t *client_handle, uint32_t autoCost)
Set the autocost reference bandwidth for OSPF links.
open_error_t openapiOspfMapRouterIdSet(openapiClientHandle_t *client_handle, uint32_t routerId)
Set the OSPF router ID.
open_error_t openapiOspfMapLogAdjChngSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t log, bool detail)
Configure logging of neighbor state changes.
open_error_t openapiOspfMapStubRtrModeSet(openapiClientHandle_t *client_handle, OPEN_OSPF_STUB_ROUTER_CFG_t mode, uint32_t duration)
Set the configured stub router advertisement mode.
OPEN_OSPF_AREA_EXT_ROUTING_t
open_error_t openapiOspfMapIntfPassiveModeGet(openapiClientHandle_t *client_handle, uint32_t intf, bool *mode)
gets the passive mode of the interface
open_error_t openapiOspfTrapModeGet(openapiClientHandle_t *client_handle, OPEN_OSPF_TRAP_TYPES_t trapType, bool *mode)
Get the specified trap type mode.
open_error_t openapiOspfMapNSSAImportSummariesSet(openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_SUMMARY_t summary)
Set the import summary configuration for the specified NSSA.
open_error_t openapiOspfMapNetworkAreaEntryDelete(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t wildcardMask, uint32_t areaId)
Delete a network area entry.
virtual interface, retransmitted
Point to point.
virtual interface, parameter conflict
Default interface.
Do not import and propagate ext LSAs- make stub area.
open_error_t openapiOspfMapNetworkAreaEntrySet(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t wildcardMask, uint32_t areaId, OPEN_OSPF_AREA_ID_FORMAT_t areaIdFmt)
Create/Update a network area entry.
Do not originate and propagate summary LSAs.
OPEN_OSPF_AREA_ID_FORMAT_t
Areas are identified by a 32-bit Area ID.
virtual interface, can't be parsed
OPEN_OSPF_TRAP_TYPES_t
OSPFv2 MIB trap bit masks.
open_error_t openapiOspfMapNetworkAreaEntryGet(openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t wildcardMask, uint32_t areaId, bool *found)
Find a specific network area object.
non-virtual interface, can't be parsed
OPEN_OSPF_EXT_METRIC_TYPES_t
The cost, or external metric in the route.
open_error_t openapiOspfMapSpfDelayTimeSet(openapiClientHandle_t *client_handle, uint32_t time)
Sets the delay time between when OSPF receives a topology change and when it starts an SPF calculatio...
open_error_t openapiOspfMapIntfDeadIntervalGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *seconds)
Gets the Ospf Dead Interval for the specified interface.
open_error_t openapiOspfMapAreaSummarySet(openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_SUMMARY_t summary)
Set the area summary.
Originate and propagate summary LSAs.
non-virtual interface, state change
open_error_t openapiOspfMapNSSAImportSummariesGet(openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_SUMMARY_t *summary)
Get the import summary configuration for the specified NSSA.
virtual interface, state change
Not configured as a stub router.
open_error_t openapiOspfMapImportAsExternSet(openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_EXT_ROUTING_t import)
Set the area's support for importing AS external link-state advertisements.
open_error_t openapiOspfMapSpfDelayTimeGet(openapiClientHandle_t *client_handle, uint32_t *time)
Gets the delay time between when OSPF receives a topology change and when it starts an SPF calculatio...
open_error_t openapiOspfMapRfc1583CompatibilitySet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Configure if OSPF is compatible with RFC 1583.
non-virtual interface, retransmitted
open_error_t openapiOspfMapIntfAreaIdGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *areaId, OPEN_CONTROL_t *mode)
Gets the OSPF area id for the specified interface.