Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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 | |
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... | |
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.
Definition at line 96 of file openapi_ospf_config.h.
Type of Service.
Definition at line 104 of file openapi_ospf_config.h.
OSPFv2 MIB trap bit masks.
Definition at line 114 of file openapi_ospf_config.h.
open_error_t openapiOspfMapAreaSummaryGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | areaId, | ||
OPEN_OSPF_AREA_SUMMARY_t * | summary | ||
) |
Get the area summary.
[in] | client_handle | client handle from registration API |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[out] | summary | summary (see notes) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapAreaSummarySet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | areaId, | ||
OPEN_OSPF_AREA_SUMMARY_t | summary | ||
) |
Set the area summary.
[in] | client_handle | client handle from registration API |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[in] | summary | summary (see notes) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if area is the backbone |
OpEN API Version: 1.2
open_error_t openapiOspfMapAutoCostRefBwGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | autoCost | ||
) |
Get the autocost reference bandwidth for OSPF links.
[in] | client_handle | client handle from registration API |
[out] | autoCost | autoCost reference bandwidth allowed |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapAutoCostRefBwSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | autoCost | ||
) |
Set the autocost reference bandwidth for OSPF links.
[in] | client_handle | client handle from registration API |
[in] | autoCost | autoCost reference bandwidth allowed |
- | Minimum value OPENAPI_OSPF_MIN_REF_BW | |
- | Maximum value OPENAPI_OSPF_MAX_REF_BW |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[out] | import | import/propagate T5, T7, or no import/stub |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[in] | import | import/propagate T5, T7, or no import/stub |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if attempt to make backbone a stub or NSSA |
OPEN_E_EXISTS | if area id is a virtual link |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_CONTROL_t * | mode | ||
) |
Get the OSPF admin mode for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[out] | mode | OPEN_ENABLE or OPEN_DISABLE |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if 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.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | mode | OPEN_ENABLE or OPEN_DISABLE |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if interface does not exist or if interface has not been enabled for routing |
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.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[out] | areaId | Stub or NSSA Id, can be decimal or IP address |
[out] | mode | admin mode for the specified interface |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[in] | mode | admin mode for the specified interface |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfDeadIntervalGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | seconds | ||
) |
Gets the Ospf Dead Interval for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[out] | seconds | see notes |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if interface does not exist or if interface has not been enabled for routing |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfDeadIntervalSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | seconds | ||
) |
Sets the Ospf Dead Interval for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | seconds | see notes |
- | Minimum value OPENAPI_OSPF_INTF_DEAD_MIN | |
- | Maximum value OPENAPI_OSPF_INTF_DEAD_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if interface does not exist or if interface has not been enabled for routing |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfHelloIntervalGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | seconds | ||
) |
Get the Ospf Hello Interval for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[out] | seconds | see notes |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if interface does not exist or if interface has not been enabled for routing |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfHelloIntervalSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | seconds | ||
) |
Sets the Ospf Hello Interval for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | seconds | see notes |
- | Minimum value OPENAPI_OSPF_INTF_SECONDS_MIN | |
- | Maximum value OPENAPI_OSPF_INTF_SECONDS_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if interface does not exist or if interface has not been enabled for routing |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | tos | TOS metric |
[out] | metric | metric value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | ipAddr | ip address |
[in] | tos | type of service metric |
[in] | metric | metric value |
- | Minimum value OPENAPI_OSPF_INTF_COST_MIN | |
- | Maximum value OPENAPI_OSPF_INTF_COST_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for non-default TOS values. |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfPassiveModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
bool * | mode | ||
) |
gets the passive mode of the interface
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[out] | mode | passive mode of interface |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if interface does not exist or if interface has not been enabled for routing |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfPassiveModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
bool | mode | ||
) |
Sets the passive mode of the interface.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | mode | passive mode of interface |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if interface does not exist or if interface has not been enabled for routing |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfSecondariesFlagGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | secondaries | ||
) |
Get the SecondariesFlag for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[out] | secondaries | see notes |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfSecondariesFlagSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | secondaries | ||
) |
Set the SecondariesFlag for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | intf | Internal Interface Number |
[in] | secondaries | see notes |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_OSPF_INTF_TYPES_t * | type | ||
) |
Get the OSPF interface type.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[out] | type | configure network type |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapIntfTypeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_OSPF_INTF_TYPES_t | type | ||
) |
Set the OSPF interface type.
[in] | client_handle | client handle from registration API |
[in] | intf | internal interface number |
[in] | type | allowable network types |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapLogAdjChngGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | log, | ||
bool * | detail | ||
) |
Get logging information of neighbor state changes.
[in] | client_handle | client handle from registration API |
[out] | log | logging of adjacency changes |
[out] | detail | detailed logging |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapLogAdjChngSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | log, | ||
bool | detail | ||
) |
Configure logging of neighbor state changes.
[in] | client_handle | client handle from registration API |
[in] | log | logging of adjacency changes |
[in] | detail | detailed logging |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapMaxPathsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxPaths | ||
) |
Get the maximum number of paths that OSPF can report.
[in] | client_handle | client handle from registration API |
[out] | maxPaths | the maximum number of paths allowed |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapMaxPathsSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | maxPaths | ||
) |
Set the maximum number of paths that OSPF can report.
[in] | client_handle | client handle from registration API |
[in] | maxPaths | see notes |
- | Minimum value 1 | |
- | Maximum value openapiOspfEqualCostRoutesMax() |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapNetworkAreaEntryDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ipAddr, | ||
uint32_t | wildcardMask, | ||
uint32_t | areaId | ||
) |
Delete a network area entry.
[in] | client_handle | client handle from registration API |
[in] | ipAddr | ip address |
[in] | wildcardMask | wild card mask |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
OPEN_E_NONE | Delete successful. |
OPEN_E_FAIL | Delete failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | ipAddr | ip address |
[in] | wildcardMask | wild card mask |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[out] | found | network object exists or not |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | ipAddr | ip address |
[in] | wildcardMask | wild card mask |
[in] | areaId | Stub or NSSA Id |
[in] | areaIdFmt | areaId format: integer/dotted-decimal |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[out] | summary | import summary (see notes) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
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.
[in] | client_handle | client handle from registration API |
[in] | areaId | Stub or NSSA Id, can be decimal or IP address |
[in] | summary | import summary (see notes) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | if area is the backbone |
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.
[in] | client_handle | client handle from registration API |
[in] | redistribute | Whether OSPF redistributes from sourceProto |
[in] | sourceProto | Other protocol from which OSPF will redistribute. |
- | Maximum length openapiRouteProtoNameLenMax() | |
[in] | distList | See notes |
- | Minimum value OPENAPI_OSPF_DIST_LIST_MIN | |
- | Maximum value OPENAPI_OSPF_DIST_LIST_MAX | |
[in] | metric | See notes |
- | Minimum value OPENAPI_OSPF_REDIST_METRIC_MIN | |
- | Maximum value OPENAPI_OSPF_REDIST_METRIC_MAX | |
[in] | type | Metric type OSPF advertises for routes from sourceProto |
[in] | tag | See notes |
- | Minimum value 0 | |
- | Maximum value unsigned integer (4294967295) | |
[in] | subnets | If true, OSPF will redistribute subnetted routes from this protocol. |
OPEN_E_NONE | set successful. |
OPEN_E_FAIL | set failed. |
OPEN_E_PARAM | error in parameter passed. |
OPEN_E_FULL | if route-map couldn't be created |
OPEN_E_NOT_FOUND | if the route-map name doesn't match (no form) |
OPEN_E_UNAVAIL | either the sourceProto does not identify a protocol from which OSPF may redistribute, or redistribute metric is out of range. |
OpEN API Version: 1.2
open_error_t openapiOspfMapRfc1583CompatibilityGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | mode | ||
) |
Get OSPF mode for RFC 1583 compatibility.
[in] | client_handle | client handle from registration API |
[out] | mode | see notes |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapRfc1583CompatibilitySet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | mode | ||
) |
Configure if OSPF is compatible with RFC 1583.
[in] | client_handle | client handle from registration API |
[in] | mode | see notes |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapRouterIdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | routerId | ||
) |
Get the OSPF router ID.
[in] | client_handle | client handle from registration API |
[out] | routerId | router id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapRouterIdSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | routerId | ||
) |
Set the OSPF router ID.
[in] | client_handle | client handle from registration API |
[in] | routerId | router id, can be decimal or IP address |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[out] | time | SPF Delay Time |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | time | SPF Delay Time |
- | Minimum value OPENAPI_OSPF_SPF_DELAY_TIME_MIN | |
- | Maximum value OPENAPI_OSPF_SPF_DELAY_TIME_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapSpfHoldTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | time | ||
) |
Gets the minimum time (in seconds) between two consecutive SPF calculations.
[in] | client_handle | client handle from registration API |
[out] | time | SPF Hold Time |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapSpfHoldTimeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | time | ||
) |
Sets the minimum time (in seconds) between two consecutive SPF calculations.
[in] | client_handle | client handle from registration API |
[in] | time | SPF Hold Time |
- | Minimum value OPENAPI_OSPF_SPF_HOLD_TIME_MIN | |
- | Maximum value OPENAPI_OSPF_SPF_HOLD_TIME_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[out] | mode | the configured stub router mode |
[out] | duration | If 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] | override | override the metric in summary LSAs when in stub router mode. |
[out] | metric | Metric to set in summary LSAs in stub router mode, if overriding summary metric |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | mode | the configured stub router mode |
[in] | duration | If 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 |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfMapStubRtrSumLsaMetricOverride | ( | openapiClientHandle_t * | client_handle, |
bool | override, | ||
uint32_t | metric | ||
) |
Set the configured stub router advertisement mode.
[in] | client_handle | client handle from registration API |
[in] | override | override the metric in summary LSAs when in stub router mode. |
[in] | metric | Metric 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 |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiOspfTrapModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_OSPF_TRAP_TYPES_t | trapType, | ||
bool * | mode | ||
) |
Get the specified trap type mode.
[in] | client_handle | client handle from registration API |
[in] | trapType | ospf trap type (see notes) |
[out] | mode | trap type (on or off) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | trapType | ospf trap type (see notes) |
[in] | mode | Turn trap type (on or off) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2