Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Enumerations | |
enum | OPEN_FDB_ADDR_FLAG_t { OPEN_FDB_ADDR_FLAG_STATIC = 0, OPEN_FDB_ADDR_FLAG_LEARNED = 1, OPEN_FDB_ADDR_FLAG_MANAGEMENT = 2, OPEN_FDB_ADDR_FLAG_GMRP_LEARNED = 3, OPEN_FDB_ADDR_FLAG_SELF = 4, OPEN_FDB_ADDR_FLAG_DOT1X_STATIC = 5, OPEN_FDB_ADDR_FLAG_DOT1AG_STATIC = 6, OPEN_FDB_ADDR_FLAG_L3_MANAGEMENT = 7, OPEN_FDB_ADDR_FLAG_LEARNED_UNCONFIRMED = 8, OPEN_FDB_ADDR_FLAG_FIP_SNOOP_LEARNED = 9, OPEN_FDB_ADDR_FLAG_CAPTIVE_PORTAL_STATIC = 10, OPEN_FDB_ADDR_FLAG_ETH_CFM_STATIC = 11, OPEN_FDB_ADDR_FLAG_Y1731_STATIC = 12 } |
enum | OPEN_VL_TYPE_t { OPEN_IVL_TYPE = 1, OPEN_SVL_TYPE = 2 } |
Supported VLAN Learning types. More... | |
Functions | |
open_error_t | openapiActiveAddrEntriesGet (openapiClientHandle_t *client_handle, uint32_t *entriesNum) |
Get the current number of entries in forwarding database. More... | |
open_error_t | openapiFdbAddrAgingTimeoutGet (openapiClientHandle_t *client_handle, uint32_t fdbId, uint32_t *timeOut) |
Get the aging timeout value for a forwarding database. More... | |
open_error_t | openapiFdbAddrAgingTimeoutSet (openapiClientHandle_t *client_handle, uint32_t fdbId, uint32_t timeOut) |
Set the aging timeout value for a forwarding database. More... | |
open_error_t | openapiFdbBadAddsGet (openapiClientHandle_t *client_handle, uint32_t *badAdds) |
Get the number of failed forwarding database insert attempts due to failure to allocate space. More... | |
open_error_t | openapiFdbDynamicEntriesGet (openapiClientHandle_t *client_handle, uint32_t *entries) |
Get count of dynamic entries in the L2 forwarding database. More... | |
open_error_t | openapiFdbEntryDelete (openapiClientHandle_t *client_handle, open_buffdesc *mac, uint32_t vlanId, uint32_t intIfNum) |
Delete a entry from the forwarding database. More... | |
open_error_t | openapiFdbEntryNextGet (openapiClientHandle_t *client_handle, open_buffdesc *mac, uint32_t *vlanId, uint32_t *fdbIfNum, OPEN_FDB_ADDR_FLAG_t *entryType) |
Get the next entry from the forwarding database. More... | |
open_error_t | openapiFdbFlush (openapiClientHandle_t *client_handle) |
Flush all learned entries from the L2 forwarding database. More... | |
open_error_t | openapiFdbFlushByMac (openapiClientHandle_t *client_handle, open_buffdesc *mac) |
Flush all entries in forwarding database learned on the specified MAC. More... | |
open_error_t | openapiFdbFlushByPort (openapiClientHandle_t *client_handle, uint32_t intIfNum) |
Flush all entries in forwarding database learned on this interface. More... | |
open_error_t | openapiFdbFlushByVlan (openapiClientHandle_t *client_handle, uint32_t vlanId) |
Flush all entries in forwarding database learned on the specified VLAN. More... | |
open_error_t | openapiFdbIdGet (openapiClientHandle_t *client_handle, uint32_t fdbId) |
Verify that a forwarding database entry with the specified ID exists. More... | |
open_error_t | openapiFdbIdNextGet (openapiClientHandle_t *client_handle, uint32_t startFrom, uint32_t *fdbId) |
Get the next forwarding database ID starting from a certain index. More... | |
open_error_t | openapiFdbInternalEntriesGet (openapiClientHandle_t *client_handle, uint32_t *entries) |
Get count of internally added entries in the L2 forwarding database. More... | |
open_error_t | openapiFdbIntfDynamicEntriesGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *entries) |
Get the count of dynamic entries in the L2 forwarding database for a specific interface. More... | |
open_error_t | openapiFdbIntfInternalEntriesGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *entries) |
Get the count of internal entries in the L2 forwarding database for a specific interface. More... | |
open_error_t | openapiFdbMacMaxHwLimitGet (openapiClientHandle_t *client_handle, uint32_t *maxMacHwLimit) |
Get the max limit of MAC entries determined by hardware. More... | |
open_error_t | openapiFdbMaxCountGet (openapiClientHandle_t *client_handle, uint32_t *entriesNum) |
Get the forwarding database entries counter greatest value. More... | |
open_error_t | openapiFdbMaxTableEntriesGet (openapiClientHandle_t *client_handle, uint32_t *maxEntries) |
Get the maximum number of entries that the forwarding database table can hold. More... | |
open_error_t | openapiFdbTypeOfVLGet (openapiClientHandle_t *client_handle, OPEN_VL_TYPE_t *type) |
Get the type of supported VLAN learning. More... | |
open_error_t | openapiFdbVlanDynamicEntriesGet (openapiClientHandle_t *client_handle, uint16_t vlanId, uint32_t *entries) |
Get the count of dynamic entries in the L2 forwarding database for a specific VLAN. More... | |
open_error_t | openapiFdbVlanInternalEntriesGet (openapiClientHandle_t *client_handle, uint16_t vlanId, uint32_t *entries) |
Get the count of internal entries in the L2 forwarding database for a specific VLAN. More... | |
open_error_t | openapiIsRestrFilterMacGet (openapiClientHandle_t *client_handle, open_buffdesc *macaddr) |
Determine if the specified MAC address is a member of the restricted set. More... | |
open_error_t | openapiMaxCountReset (openapiClientHandle_t *client_handle) |
Reset the greatest number of entries in the forwarding database. More... | |
enum OPEN_FDB_ADDR_FLAG_t |
Definition at line 51 of file openapi_fdb.h.
enum OPEN_VL_TYPE_t |
Supported VLAN Learning types.
Enumerator | |
---|---|
OPEN_IVL_TYPE |
Independent VLAN Learning. |
OPEN_SVL_TYPE |
Shared VLAN Learning. |
Definition at line 45 of file openapi_fdb.h.
open_error_t openapiActiveAddrEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | entriesNum | ||
) |
Get the current number of entries in forwarding database.
[in] | client_handle | client handle from registration API |
[out] | entriesNum | current number of entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbAddrAgingTimeoutGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fdbId, | ||
uint32_t * | timeOut | ||
) |
Get the aging timeout value for a forwarding database.
[in] | client_handle | client handle from registration API |
[in] | fdbId | FDB ID |
[out] | timeOut | aging timeout value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbAddrAgingTimeoutSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fdbId, | ||
uint32_t | timeOut | ||
) |
Set the aging timeout value for a forwarding database.
[in] | client_handle | client handle from registration API |
[in] | fdbId | FDB ID |
[in] | timeOut | aging timeout value in seconds. |
- | Minimum value OPENAPI_FDB_MIN_TIMEOUT_ID | |
- | Maximum value OPENAPI_FDB_MAX_TIMEOUT_ID |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbBadAddsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | badAdds | ||
) |
Get the number of failed forwarding database insert attempts due to failure to allocate space.
[in] | client_handle | client handle from registration API |
[out] | badAdds | pointer to the number of failed FDB inserts to be returned |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbDynamicEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | entries | ||
) |
Get count of dynamic entries in the L2 forwarding database.
[in] | client_handle | client handle from registration API |
[out] | entries | number of dynamic entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbEntryDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | mac, | ||
uint32_t | vlanId, | ||
uint32_t | intIfNum | ||
) |
Delete a entry from the forwarding database.
[in] | client_handle | client handle from registration API |
[in] | mac | MAC address of the entry |
[in] | vlanId | VLAN ID of the entry |
[in] | intIfNum | internal interface number of the entry |
OPEN_E_NONE | FDB entry is deleted. |
OPEN_E_FAIL | FDB entry is not deleted. |
OPEN_E_INTERNAL | Other internal error. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbEntryNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | mac, | ||
uint32_t * | vlanId, | ||
uint32_t * | fdbIfNum, | ||
OPEN_FDB_ADDR_FLAG_t * | entryType | ||
) |
Get the next entry from the forwarding database.
[in] | client_handle | client handle from registration API |
[in,out] | mac | MAC address of the entry |
[in] | vlanId | VLAN ID of the entry |
[in,out] | fdbIfNum | internal interface number of the entry |
[in,out] | entryType | entry type |
OPEN_E_NONE | Get successful. |
OPEN_E_NOT_FOUND | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbFlush | ( | openapiClientHandle_t * | client_handle | ) |
Flush all learned entries from the L2 forwarding database.
[in] | client_handle | client handle from registration API |
OPEN_E_NONE | All FDB entries are flushed. |
OPEN_E_FAIL | Failed to flush FDB entries. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbFlushByMac | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | mac | ||
) |
Flush all entries in forwarding database learned on the specified MAC.
[in] | client_handle | client handle from registration API |
[in] | mac | MAC address |
OPEN_E_NONE | All FDB entries are flushed. |
OPEN_E_FAIL | Failed to flush FDB entries. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbFlushByPort | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum | ||
) |
Flush all entries in forwarding database learned on this interface.
[in] | client_handle | client handle from registration API |
[in] | intIfNum | internal interface number of the entry |
OPEN_E_NONE | All FDB entries are flushed. |
OPEN_E_FAIL | Failed to flush FDB entries. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbFlushByVlan | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanId | ||
) |
Flush all entries in forwarding database learned on the specified VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN number |
OPEN_E_NONE | All FDB entries are flushed. |
OPEN_E_FAIL | Failed to flush FDB entries. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbIdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fdbId | ||
) |
Verify that a forwarding database entry with the specified ID exists.
[in] | client_handle | client handle from registration API |
[in] | fdbId | FDB ID to be checked |
OPEN_E_NONE | FDB exists. |
OPEN_E_NOT_FOUND | FDB not exists. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbIdNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | startFrom, | ||
uint32_t * | fdbId | ||
) |
Get the next forwarding database ID starting from a certain index.
[in] | client_handle | client handle from registration API |
[in] | startFrom | index to start search from |
[out] | fdbId | pointer to the return value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbInternalEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | entries | ||
) |
Get count of internally added entries in the L2 forwarding database.
[in] | client_handle | client handle from registration API |
[out] | entries | number of internally added entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbIntfDynamicEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t * | entries | ||
) |
Get the count of dynamic entries in the L2 forwarding database for a specific interface.
[in] | client_handle | client handle from registration API |
[in] | intIfNum | internal interface number |
[out] | entries | number of entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbIntfInternalEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t * | entries | ||
) |
Get the count of internal entries in the L2 forwarding database for a specific interface.
[in] | client_handle | client handle from registration API |
[in] | intIfNum | internal interface number |
[out] | entries | number of entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbMacMaxHwLimitGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxMacHwLimit | ||
) |
Get the max limit of MAC entries determined by hardware.
[in] | client_handle | client handle from registration API |
[out] | maxMacHwLimit | Max MAC limit set in hardware |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbMaxCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | entriesNum | ||
) |
Get the forwarding database entries counter greatest value.
[in] | client_handle | client handle from registration API |
[out] | entriesNum | greatest number of entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbMaxTableEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxEntries | ||
) |
Get the maximum number of entries that the forwarding database table can hold.
[in] | client_handle | client handle from registration API |
[out] | maxEntries | number of total entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbTypeOfVLGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_VL_TYPE_t * | type | ||
) |
Get the type of supported VLAN learning.
[in] | client_handle | client handle from registration API |
[out] | type | pointer to the type |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbVlanDynamicEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint16_t | vlanId, | ||
uint32_t * | entries | ||
) |
Get the count of dynamic entries in the L2 forwarding database for a specific VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN identifier |
[out] | entries | number of entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiFdbVlanInternalEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint16_t | vlanId, | ||
uint32_t * | entries | ||
) |
Get the count of internal entries in the L2 forwarding database for a specific VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN identifier |
[out] | entries | number of entries |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiIsRestrFilterMacGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | macaddr | ||
) |
Determine if the specified MAC address is a member of the restricted set.
[in] | client_handle | client handle from registration API |
[in] | macaddr | MAC Address of the filter |
OPEN_E_NONE | MAC is not restricted. |
OPEN_E_DISABLED | MAC is restricted. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiMaxCountReset | ( | openapiClientHandle_t * | client_handle | ) |
Reset the greatest number of entries in the forwarding database.
[in] | client_handle | client handle from registration API |
OPEN_E_NONE | Reset successful. |
OPEN_E_FAIL | Reset failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7