Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
Open Shortest Path First Configuration And Status [OPENAPI_OSPF_CONFIG]

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

Detailed Description

Enumeration Type Documentation

Enumerator
OPEN_OSPF_AREA_IMPORT_EXT 

Import and propagate T5 LSAs.

OPEN_OSPF_AREA_IMPORT_NO_EXT 

Do not import and propagate ext LSAs- make stub area.

OPEN_OSPF_AREA_IMPORT_NSSA 

Import and propagate T7 LSAs.

Definition at line 69 of file openapi_ospf_config.h.

Areas are identified by a 32-bit Area ID.

The Area ID may be expressed either as a decimal number or in dotted decimal

Enumerator
OPEN_OSPF_AREA_ID_INTEGER_FORMAT 

Integer format.

OPEN_OSPF_AREA_ID_DOTTED_DECIMAL_FORMAT 

Dotted decimal format.

Definition at line 63 of file openapi_ospf_config.h.

Enumerator
OPEN_OSPF_AREA_NO_SUMMARY 

Do not originate and propagate summary LSAs.

OPEN_OSPF_AREA_SEND_SUMMARY 

Originate and propagate summary LSAs.

Definition at line 76 of file openapi_ospf_config.h.

The cost, or external metric in the route.

Enumerator
OPEN_OSPF_METRIC_EXT_TYPE1 

External Type 1.

OPEN_OSPF_METRIC_EXT_TYPE2 

External Type 2.

Definition at line 90 of file openapi_ospf_config.h.

Enumerator
OPEN_OSPF_INTF_DEFAULT 

Default interface.

OPEN_OSPF_INTF_BROADCAST 

Broadcast.

OPEN_OSPF_INTF_PTP 

Point to point.

Definition at line 82 of file openapi_ospf_config.h.

Enumerator
OPEN_OSPF_STUB_RTR_CFG_DISABLED 

Not configured as a stub router.

OPEN_OSPF_STUB_RTR_CFG_ALWAYS 

Configured as a stub router.

OPEN_OSPF_STUB_RTR_CFG_STARTUP 

Is a stub router for a limited time after reboot.

Definition at line 96 of file openapi_ospf_config.h.

Type of Service.

Enumerator
OPEN_OSPF_TOS_NORMAL_SERVICE 

normal service

OPEN_OSPF_TOS_MINIMIZE_COST 

minimize cost

OPEN_OSPF_TOS_MAXIMIZE_RELIABILITY 

maximize reliability

OPEN_OSPF_TOS_MAXIMIZE_THROUGHPUT 

maximize throughput

OPEN_OSPF_TOS_MINIMIZE_DELAY 

minimize delay

Definition at line 104 of file openapi_ospf_config.h.

OSPFv2 MIB trap bit masks.

Enumerator
OPEN_OSPF_TRAP_NONE 

no traps

OPEN_OSPF_TRAP_VIRT_IF_STATE_CHANGE 

virtual interface, state change

OPEN_OSPF_TRAP_NBR_STATE_CHANGE 

non-virtual interface, OSPF neighbor state change

OPEN_OSPF_TRAP_VIRT_NBR_STATE_CHANGE 

virtual interface, OSPF neighbor state change

OPEN_OSPF_TRAP_IF_CONFIG_ERROR 

non-virtual interface, parameter conflict

OPEN_OSPF_TRAP_VIRT_IF_CONFIG_ERROR 

virtual interface, parameter conflict

OPEN_OSPF_TRAP_IF_AUTH_FAILURE 

non-virtual interface, auth mismatch

OPEN_OSPF_TRAP_VIRT_IF_AUTH_FAILURE 

virtual interface, auth mismatch

OPEN_OSPF_TRAP_RX_BAD_PACKET 

non-virtual interface, can't be parsed

OPEN_OSPF_TRAP_VIRT_IF_RX_BAD_PACKET 

virtual interface, can't be parsed

OPEN_OSPF_TRAP_TX_RETRANSMIT 

virtual interface, retransmitted

OPEN_OSPF_TRAP_VIRT_IF_TX_RETRANSMIT 

non-virtual interface, retransmitted

OPEN_OSPF_TRAP_ORIGINATE_LSA 

new link-state has originated

OPEN_OSPF_TRAP_MAX_AGE_LSA 

link-state database has aged

OPEN_OSPF_TRAP_LS_DB_OVERFLOW 

LSDB exceeded limits.

OPEN_OSPF_TRAP_LS_DB_APPROACHING_OVERFLOW 

LSDB exceeded 90% of limits.

OPEN_OSPF_TRAP_IF_STATE_CHANGE 

non-virtual interface, state change

OPEN_OSPF_TRAP_IF_RX_PACKET 

non-virtual interface, can't be parsed

OPEN_OSPF_TRAP_RTB_ENTRY_INFO 

table entry

Definition at line 114 of file openapi_ospf_config.h.

Function Documentation

open_error_t openapiOspfMapAreaSummaryGet ( openapiClientHandle_t client_handle,
uint32_t  areaId,
OPEN_OSPF_AREA_SUMMARY_t summary 
)

Get the area summary.

Parameters
[in]client_handleclient handle from registration API
[in]areaIdStub or NSSA Id, can be decimal or IP address
[out]summarysummary (see notes)
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
If summary is OPEN_OSPF_AREA_SEND_SUMMARY; The router will both summarize and propagate summary LSAs.
If summary is OPEN_OSPF_AREA_NO_SUMMARY; The router will neither originate nor propagate summary LSAs into the stub area. It will rely entirely on its default route.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapAreaSummarySet ( openapiClientHandle_t client_handle,
uint32_t  areaId,
OPEN_OSPF_AREA_SUMMARY_t  summary 
)

Set the area summary.

Parameters
[in]client_handleclient handle from registration API
[in]areaIdStub or NSSA Id, can be decimal or IP address
[in]summarysummary (see notes)
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif area is the backbone
Note
If summary is OPEN_OSPF_AREA_SEND_SUMMARY; The router will both summarize and propagate summary LSAs.
If summary is OPEN_OSPF_AREA_NO_SUMMARY; The router will neither originate nor propagate summary LSAs into the stub area. It will rely entirely on its default route.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapAutoCostRefBwGet ( openapiClientHandle_t client_handle,
uint32_t *  autoCost 
)

Get the autocost reference bandwidth for OSPF links.

Parameters
[in]client_handleclient handle from registration API
[out]autoCostautoCost reference bandwidth allowed
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapAutoCostRefBwSet ( openapiClientHandle_t client_handle,
uint32_t  autoCost 
)

Set the autocost reference bandwidth for OSPF links.

Parameters
[in]client_handleclient handle from registration API
[in]autoCostautoCost reference bandwidth allowed
-Minimum value OPENAPI_OSPF_MIN_REF_BW
-Maximum value OPENAPI_OSPF_MAX_REF_BW
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]areaIdStub or NSSA Id, can be decimal or IP address
[out]importimport/propagate T5, T7, or no import/stub
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
if import is OPEN_OSPF_AREA_IMPORT_EXT Import and propagate T5 LSAs
if import is OPEN_OSPF_AREA_IMPORT_NO_EXT Do not import and propagate ext LSAs- make stub area
if import is OPEN_OSPF_AREA_IMPORT_NSSA Import and propagate T7 LSAs

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]areaIdStub or NSSA Id, can be decimal or IP address
[in]importimport/propagate T5, T7, or no import/stub
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif attempt to make backbone a stub or NSSA
OPEN_E_EXISTSif area id is a virtual link
Note
if import is OPEN_OSPF_AREA_IMPORT_EXT Import and propagate T5 LSAs
if import is OPEN_OSPF_AREA_IMPORT_NO_EXT Do not import and propagate ext LSAs- make stub area
if import is OPEN_OSPF_AREA_IMPORT_NSSA Import and propagate T7 LSAs
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfAdminModeGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
OPEN_CONTROL_t mode 
)

Get the OSPF admin mode for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[out]modeOPEN_ENABLE or OPEN_DISABLE
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing

OpEN API Version: 1.2

open_error_t openapiOspfMapIntfAdminModeSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
OPEN_CONTROL_t  mode 
)

Set the OSPF admin mode for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]modeOPEN_ENABLE or OPEN_DISABLE
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing
Note
Called when OSPF is explicitly enabled on an interface, such as when "ip ospf area" command is given. Not called for interfaces matching a "network area" command.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

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.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[out]areaIdStub or NSSA Id, can be decimal or IP address
[out]modeadmin mode for the specified interface
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]areaIdStub or NSSA Id, can be decimal or IP address
[in]modeadmin mode for the specified interface
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
After successfully setting the area id, this OpEN_API sets the OSPF admin mode. Typically, OSPF should be disabled on the target interface when the area id is not defined.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfDeadIntervalGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t *  seconds 
)

Gets the Ospf Dead Interval for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[out]secondssee notes
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing
Note
The number of seconds that a router's Hello packets have not been seen before it's neighbors declare the router down. This should be some multiple of the Hello interval. This value must be the same for all routers attached to a common network.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfDeadIntervalSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t  seconds 
)

Sets the Ospf Dead Interval for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]secondssee notes
-Minimum value OPENAPI_OSPF_INTF_DEAD_MIN
-Maximum value OPENAPI_OSPF_INTF_DEAD_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing
Note
The number of seconds that a router's Hello packets have not been seen before it's neighbors declare the router down. This should be some multiple of the Hello interval. This value must be the same for all routers attached to a common network.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfHelloIntervalGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t *  seconds 
)

Get the Ospf Hello Interval for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[out]secondssee notes
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing
Note
The length of time, in seconds between the Hello packets that the router sends on the interface. This value must be the same for all router attached to a common network.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfHelloIntervalSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t  seconds 
)

Sets the Ospf Hello Interval for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]secondssee notes
-Minimum value OPENAPI_OSPF_INTF_SECONDS_MIN
-Maximum value OPENAPI_OSPF_INTF_SECONDS_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing
Note
The length of time, in seconds between the Hello packets that the router sends on the interface. This value must be the same for all router attached to a common network.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]tosTOS metric
[out]metricmetric value
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]ipAddrip address
[in]tostype of service metric
[in]metricmetric value
-Minimum value OPENAPI_OSPF_INTF_COST_MIN
-Maximum value OPENAPI_OSPF_INTF_COST_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for non-default TOS values.
Note
If metric is OPEN_OSPF_INTF_METRIC_NOT_CONFIGURED, the metric will be computed from port speed otherwise only the value configured by user will be used.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfPassiveModeGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
bool *  mode 
)

gets the passive mode of the interface

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[out]modepassive mode of interface
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfPassiveModeSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
bool  mode 
)

Sets the passive mode of the interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]modepassive mode of interface
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif interface does not exist or if interface has not been enabled for routing
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfSecondariesFlagGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t *  secondaries 
)

Get the SecondariesFlag for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[out]secondariessee notes
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
if secondaries OPEN_OSPF_INTF_SECONDARIES_ALL, all are advertised
if secondaries OPEN_OSPF_INTF_SECONDARIES_NONE, none are advertised

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfSecondariesFlagSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t  secondaries 
)

Set the SecondariesFlag for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]intfInternal Interface Number
[in]secondariessee notes
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
if secondaries OPEN_OSPF_INTF_SECONDARIES_ALL, all are advertised
if secondaries OPEN_OSPF_INTF_SECONDARIES_NONE, none are advertised
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfTypeGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
OPEN_OSPF_INTF_TYPES_t type 
)

Get the OSPF interface type.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[out]typeconfigure network type
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapIntfTypeSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
OPEN_OSPF_INTF_TYPES_t  type 
)

Set the OSPF interface type.

Parameters
[in]client_handleclient handle from registration API
[in]intfinternal interface number
[in]typeallowable network types
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapLogAdjChngGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t log,
bool *  detail 
)

Get logging information of neighbor state changes.

Parameters
[in]client_handleclient handle from registration API
[out]loglogging of adjacency changes
[out]detaildetailed logging
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
if log is OPEN_ENABLE, then enable logging of adjacency changes
if log is OPEN_DISABLE, then disable logging of adjacency changes

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapLogAdjChngSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  log,
bool  detail 
)

Configure logging of neighbor state changes.

Parameters
[in]client_handleclient handle from registration API
[in]loglogging of adjacency changes
[in]detaildetailed logging
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
if log is OPEN_ENABLE, then enable logging of adjacency changes
if log is OPEN_DISABLE, then disable logging of adjacency changes
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapMaxPathsGet ( openapiClientHandle_t client_handle,
uint32_t *  maxPaths 
)

Get the maximum number of paths that OSPF can report.

Parameters
[in]client_handleclient handle from registration API
[out]maxPathsthe maximum number of paths allowed
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapMaxPathsSet ( openapiClientHandle_t client_handle,
uint32_t  maxPaths 
)

Set the maximum number of paths that OSPF can report.

Parameters
[in]client_handleclient handle from registration API
[in]maxPathssee notes
-Minimum value 1
-Maximum value openapiOspfEqualCostRoutesMax()
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
The maxPaths value is the maximum number of paths supported for the given platform. The maximum paths is essential the maximum number of ECMP next hops supported for the active template. This value can be obtained by using openapiOspfEqualCostRoutesMax().
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapNetworkAreaEntryDelete ( openapiClientHandle_t client_handle,
uint32_t  ipAddr,
uint32_t  wildcardMask,
uint32_t  areaId 
)

Delete a network area entry.

Parameters
[in]client_handleclient handle from registration API
[in]ipAddrip address
[in]wildcardMaskwild card mask
[in]areaIdStub or NSSA Id, can be decimal or IP address
Return values
OPEN_E_NONEDelete successful.
OPEN_E_FAILDelete failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ipAddrip address
[in]wildcardMaskwild card mask
[in]areaIdStub or NSSA Id, can be decimal or IP address
[out]foundnetwork object exists or not
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

This command defines the interfaces covered by the network ipAddr on which OSPF runs and also defines the area ID for those interfaces.

Parameters
[in]client_handleclient handle from registration API
[in]ipAddrip address
[in]wildcardMaskwild card mask
[in]areaIdStub or NSSA Id
[in]areaIdFmtareaId format: integer/dotted-decimal
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
areaIdFmt can be either OPEN_OSPF_AREA_ID_INTEGER_FORMAT or OPEN_OSPF_AREA_ID_DOTTED_DECIMAL_FORMAT
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]areaIdStub or NSSA Id, can be decimal or IP address
[out]summaryimport summary (see notes)
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
If summary is OPEN_OSPF_AREA_SEND_SUMMARY; OSPF's summary routes are imported into the NSSA as Type-3 summary-LSAs.
If summary is OPEN_OSPF_AREA_NO_SUMMARY; Summary routes are not imported into the NSSA.

OpEN API Version: 1.2

OPEN_RC_t ospfMapNSSAImportSummariesGet (OPEN_uint32 areaId, OPEN_uint32 *impSum)

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.

Parameters
[in]client_handleclient handle from registration API
[in]areaIdStub or NSSA Id, can be decimal or IP address
[in]summaryimport summary (see notes)
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILif area is the backbone
Note
If summary is OPEN_OSPF_AREA_SEND_SUMMARY; OSPF's summary routes are imported into the NSSA as Type-3 summary-LSAs.
If summary is OPEN_OSPF_AREA_NO_SUMMARY; Summary routes are not imported into the NSSA.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

OPEN_RC_t ospfMapNSSAImportSummariesSet (OPEN_uint32 areaId, OPEN_uint32 impSum)

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.

Parameters
[in]client_handleclient handle from registration API
[in]redistributeWhether OSPF redistributes from sourceProto
[in]sourceProtoOther protocol from which OSPF will redistribute.
-Maximum length openapiRouteProtoNameLenMax()
[in]distListSee notes
-Minimum value OPENAPI_OSPF_DIST_LIST_MIN
-Maximum value OPENAPI_OSPF_DIST_LIST_MAX
[in]metricSee notes
-Minimum value OPENAPI_OSPF_REDIST_METRIC_MIN
-Maximum value OPENAPI_OSPF_REDIST_METRIC_MAX
[in]typeMetric type OSPF advertises for routes from sourceProto
[in]tagSee notes
-Minimum value 0
-Maximum value unsigned integer (4294967295)
[in]subnetsIf true, OSPF will redistribute subnetted routes from this protocol.
Return values
OPEN_E_NONEset successful.
OPEN_E_FAILset failed.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FULLif route-map couldn't be created
OPEN_E_NOT_FOUNDif the route-map name doesn't match (no form)
OPEN_E_UNAVAILeither the sourceProto does not identify a protocol from which OSPF may redistribute, or redistribute metric is out of range.
Note
distList - access list number identifying the distribute list used to filter routes OSPF redistributes from other protocols. OPENAPI_OSPF_DIST_LIST_NA indicates no distribute list is configured.
metric - routes OSPF redistributes from this protocol will be advertised with this metric. A value of OPENAPI_OSPF_REDIST_METRIC_NA indicates that no metric is configured.
tag - routes OSPF redistributes from this protocol will be advertised with this tag.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapRfc1583CompatibilityGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t mode 
)

Get OSPF mode for RFC 1583 compatibility.

Parameters
[in]client_handleclient handle from registration API
[out]modesee notes
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
If mode is OPEN_ENABLE, preference rules remain those as defined by RFC 1583.
If mode is OPEN_DISABLE, preference rules are as stated in Section 16.4.1 of the OSPFv2 standard. When disabled, greater protection is provided against routing loops.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapRfc1583CompatibilitySet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  mode 
)

Configure if OSPF is compatible with RFC 1583.

Parameters
[in]client_handleclient handle from registration API
[in]modesee notes
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
If mode is OPEN_ENABLE, preference rules remain those as defined by RFC 1583.
If mode is OPEN_DISABLE, preference rules are as stated in Section 16.4.1 of the OSPFv2 standard. When disabled, greater protection is provided against routing loops.
Calling this API will change the running configuration of the switch.
Source can also be a loopback interface.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapRouterIdGet ( openapiClientHandle_t client_handle,
uint32_t *  routerId 
)

Get the OSPF router ID.

Parameters
[in]client_handleclient handle from registration API
[out]routerIdrouter id
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapRouterIdSet ( openapiClientHandle_t client_handle,
uint32_t  routerId 
)

Set the OSPF router ID.

Parameters
[in]client_handleclient handle from registration API
[in]routerIdrouter id, can be decimal or IP address
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
To set a non-zero router Id, either OSPF must be disabled or the router Id must be 0.
Calling this API will change the running configuration of the switch

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[out]timeSPF Delay Time
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]timeSPF Delay Time
-Minimum value OPENAPI_OSPF_SPF_DELAY_TIME_MIN
-Maximum value OPENAPI_OSPF_SPF_DELAY_TIME_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapSpfHoldTimeGet ( openapiClientHandle_t client_handle,
uint32_t *  time 
)

Gets the minimum time (in seconds) between two consecutive SPF calculations.

Parameters
[in]client_handleclient handle from registration API
[out]timeSPF Hold Time
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapSpfHoldTimeSet ( openapiClientHandle_t client_handle,
uint32_t  time 
)

Sets the minimum time (in seconds) between two consecutive SPF calculations.

Parameters
[in]client_handleclient handle from registration API
[in]timeSPF Hold Time
-Minimum value OPENAPI_OSPF_SPF_HOLD_TIME_MIN
-Maximum value OPENAPI_OSPF_SPF_HOLD_TIME_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[out]modethe configured stub router mode
[out]durationIf the configured stub router mode is stub router at startup, the duration is the startup time in seconds. May be NULL if caller doesn't care about startup time.
[out]overrideoverride the metric in summary LSAs when in stub router mode.
[out]metricMetric to set in summary LSAs in stub router mode, if overriding summary metric
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
if mode is OPEN_OSPF_STUB_RTR_CFG_DISABLED not configured as a stub router.
if mode is OPEN_OSPF_STUB_RTR_CFG_ALWAYS configured as a stub router.
if mode is OPEN_OSPF_STUB_RTR_CFG_STARTUP is a stub router for a limited time after reboot.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]modethe configured stub router mode
[in]durationIf the configured stub router mode is stub router at startup, the duration is the startup time in seconds. May be NULL if caller doesn't care about startup time.
-Minimum value OPENAPI_OSPF_STUB_ROUTER_DURATION_MIN
-Maximum value OPENAPI_OSPF_STUB_ROUTER_DURATION_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfMapStubRtrSumLsaMetricOverride ( openapiClientHandle_t client_handle,
bool  override,
uint32_t  metric 
)

Set the configured stub router advertisement mode.

Parameters
[in]client_handleclient handle from registration API
[in]overrideoverride the metric in summary LSAs when in stub router mode.
[in]metricMetric to set in summary LSAs in stub router mode, if overriding summary metric
-Minimum value OPENAPI_OSPF_STUB_ROUTER_SUMLSA_MET_MIN
-Maximum value OPENAPI_OSPF_STUB_ROUTER_SUMLSA_MET_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.
open_error_t openapiOspfTrapModeGet ( openapiClientHandle_t client_handle,
OPEN_OSPF_TRAP_TYPES_t  trapType,
bool *  mode 
)

Get the specified trap type mode.

Parameters
[in]client_handleclient handle from registration API
[in]trapTypeospf trap type (see notes)
[out]modetrap type (on or off)
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
Any combination of trapType is valid.

OpEN API Version: 1.2

Examples:
ospf_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]trapTypeospf trap type (see notes)
[in]modeTurn trap type (on or off)
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Any combination of trapType is valid.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.2

Examples:
ospf_example.c.