Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
Macros | Enumerations | Functions
openapi_ospf_config.h File Reference
#include <stdbool.h>
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_OSPF_INTF_METRIC_NOT_CONFIGURED   0
 Metric computed from port speed.
 
#define OPEN_OSPF_INTF_SECONDARIES_ALL   0xFFFFFFFFUL
 all secondaries are advertised
 
#define OPEN_OSPF_INTF_SECONDARIES_NONE   0
 secondaries are not advertised
 

Enumerations

enum  OPEN_OSPF_AREA_EXT_ROUTING_t { OPEN_OSPF_AREA_IMPORT_EXT = 1, OPEN_OSPF_AREA_IMPORT_NO_EXT = 2, OPEN_OSPF_AREA_IMPORT_NSSA = 3 }
 
enum  OPEN_OSPF_AREA_ID_FORMAT_t { OPEN_OSPF_AREA_ID_INTEGER_FORMAT = 0, OPEN_OSPF_AREA_ID_DOTTED_DECIMAL_FORMAT = 1 }
 Areas are identified by a 32-bit Area ID. More...
 
enum  OPEN_OSPF_AREA_SUMMARY_t { OPEN_OSPF_AREA_NO_SUMMARY = 1, OPEN_OSPF_AREA_SEND_SUMMARY = 2 }
 
enum  OPEN_OSPF_EXT_METRIC_TYPES_t { OPEN_OSPF_METRIC_EXT_TYPE1 = 1, OPEN_OSPF_METRIC_EXT_TYPE2 = 2 }
 The cost, or external metric in the route. More...
 
enum  OPEN_OSPF_INTF_TYPES_t { OPEN_OSPF_INTF_DEFAULT = 0, OPEN_OSPF_INTF_BROADCAST = 1, OPEN_OSPF_INTF_PTP = 3 }
 
enum  OPEN_OSPF_STUB_ROUTER_CFG_t { OPEN_OSPF_STUB_RTR_CFG_DISABLED = 0, OPEN_OSPF_STUB_RTR_CFG_ALWAYS = 1, OPEN_OSPF_STUB_RTR_CFG_STARTUP = 2 }
 
enum  OPEN_OSPF_TOS_METRIC_TYPES_t {
  OPEN_OSPF_TOS_NORMAL_SERVICE = 0, OPEN_OSPF_TOS_MINIMIZE_COST = 2, OPEN_OSPF_TOS_MAXIMIZE_RELIABILITY = 4, OPEN_OSPF_TOS_MAXIMIZE_THROUGHPUT = 8,
  OPEN_OSPF_TOS_MINIMIZE_DELAY = 16
}
 Type of Service. More...
 
enum  OPEN_OSPF_TRAP_TYPES_t {
  OPEN_OSPF_TRAP_NONE = 0x0, OPEN_OSPF_TRAP_VIRT_IF_STATE_CHANGE = 0x1, OPEN_OSPF_TRAP_NBR_STATE_CHANGE = 0x2, OPEN_OSPF_TRAP_VIRT_NBR_STATE_CHANGE = 0x4,
  OPEN_OSPF_TRAP_IF_CONFIG_ERROR = 0x8, OPEN_OSPF_TRAP_VIRT_IF_CONFIG_ERROR = 0x10, OPEN_OSPF_TRAP_IF_AUTH_FAILURE = 0x20, OPEN_OSPF_TRAP_VIRT_IF_AUTH_FAILURE = 0x40,
  OPEN_OSPF_TRAP_RX_BAD_PACKET = 0x80, OPEN_OSPF_TRAP_VIRT_IF_RX_BAD_PACKET = 0x100, OPEN_OSPF_TRAP_TX_RETRANSMIT = 0x200, OPEN_OSPF_TRAP_VIRT_IF_TX_RETRANSMIT = 0x400,
  OPEN_OSPF_TRAP_ORIGINATE_LSA = 0x800, OPEN_OSPF_TRAP_MAX_AGE_LSA = 0x1000, OPEN_OSPF_TRAP_LS_DB_OVERFLOW = 0x2000, OPEN_OSPF_TRAP_LS_DB_APPROACHING_OVERFLOW = 0x4000,
  OPEN_OSPF_TRAP_IF_STATE_CHANGE = 0x8000, OPEN_OSPF_TRAP_IF_RX_PACKET = 0x10000, OPEN_OSPF_TRAP_RTB_ENTRY_INFO = 0x20000
}
 OSPFv2 MIB trap bit masks. More...
 

Functions

open_error_t openapiOspfMapAreaSummaryGet (openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_SUMMARY_t *summary)
 Get the area summary.
 
open_error_t openapiOspfMapAreaSummarySet (openapiClientHandle_t *client_handle, uint32_t areaId, OPEN_OSPF_AREA_SUMMARY_t summary)
 Set the area summary.
 
open_error_t openapiOspfMapAutoCostRefBwGet (openapiClientHandle_t *client_handle, uint32_t *autoCost)
 Get the autocost reference bandwidth for OSPF links.
 
open_error_t openapiOspfMapAutoCostRefBwSet (openapiClientHandle_t *client_handle, uint32_t autoCost)
 Set the autocost reference bandwidth for OSPF links.
 
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 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 openapiOspfMapIntfAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t *mode)
 Get the OSPF admin mode for the specified interface.
 
open_error_t openapiOspfMapIntfAdminModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t mode)
 Set the OSPF admin mode for the specified interface.
 
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.
 
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_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 openapiOspfMapIntfDeadIntervalSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t seconds)
 Sets the Ospf Dead Interval for the specified interface.
 
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 openapiOspfMapIntfHelloIntervalSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t seconds)
 Sets the Ospf Hello Interval for the specified interface.
 
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_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 openapiOspfMapIntfPassiveModeGet (openapiClientHandle_t *client_handle, uint32_t intf, bool *mode)
 gets the passive mode of the interface
 
open_error_t openapiOspfMapIntfPassiveModeSet (openapiClientHandle_t *client_handle, uint32_t intf, bool mode)
 Sets the passive mode of the interface.
 
open_error_t openapiOspfMapIntfSecondariesFlagGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *secondaries)
 Get the SecondariesFlag for the specified interface.
 
open_error_t openapiOspfMapIntfSecondariesFlagSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t secondaries)
 Set the SecondariesFlag for the specified interface.
 
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 openapiOspfMapIntfTypeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_OSPF_INTF_TYPES_t type)
 Set the OSPF interface type.
 
open_error_t openapiOspfMapLogAdjChngGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *log, bool *detail)
 Get logging information of neighbor state changes.
 
open_error_t openapiOspfMapLogAdjChngSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t log, bool detail)
 Configure logging of neighbor state changes.
 
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 openapiOspfMapNetworkAreaEntryDelete (openapiClientHandle_t *client_handle, uint32_t ipAddr, uint32_t wildcardMask, uint32_t areaId)
 Delete a network area entry.
 
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.
 
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.
 
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.
 
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 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.
 
open_error_t openapiOspfMapRfc1583CompatibilityGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
 Get OSPF mode for RFC 1583 compatibility.
 
open_error_t openapiOspfMapRfc1583CompatibilitySet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
 Configure if OSPF is compatible with RFC 1583.
 
open_error_t openapiOspfMapRouterIdGet (openapiClientHandle_t *client_handle, uint32_t *routerId)
 Get the OSPF router ID.
 
open_error_t openapiOspfMapRouterIdSet (openapiClientHandle_t *client_handle, uint32_t routerId)
 Set the OSPF router ID.
 
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 calculation.
 
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 calculation.
 
open_error_t openapiOspfMapSpfHoldTimeGet (openapiClientHandle_t *client_handle, uint32_t *time)
 Gets the minimum time (in seconds) between two consecutive SPF calculations.
 
open_error_t openapiOspfMapSpfHoldTimeSet (openapiClientHandle_t *client_handle, uint32_t time)
 Sets the minimum time (in seconds) between two consecutive SPF calculations.
 
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.
 
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_error_t openapiOspfMapStubRtrSumLsaMetricOverride (openapiClientHandle_t *client_handle, bool override, uint32_t metric)
 Set the configured stub router advertisement mode.
 
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 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.