Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | OPEN_DOT1CB_GLOBAL_STATS_t |
struct | OPEN_DOT1CB_INTF_STATS_t |
Macros | |
#define | OPEN_DOT1CB_IPV4_PREFIX_LEN 32 |
#define | OPEN_DOT1CB_IPV6_PREFIX_LEN 128 |
#define | OPEN_MAX_DOT1CB_INITIATOR_FLOWS 1024 |
maximum flow ID for 802.1CB initiator flows | |
#define | OPEN_MAX_DOT1CB_IPV4 512 |
maximum IPv4 classifiers for 802.1CB flows | |
#define | OPEN_MAX_DOT1CB_IPV6 512 |
maximum IPv6 classifiers for 802.1CB flows | |
#define | OPEN_MAX_DOT1CB_TRANSIT_FLOWS 1024 |
maximum flow ID for 802.1CB transit flows | |
#define | OPEN_MAX_DOT1CB_VLANS 16 |
maximum VLANs enabled for 802.1CB concurrently | |
#define | OPEN_MFDB_MAX_MAC_ENTRIES 1024 |
maximum MFDB classifiers for 802.1CB | |
#define | OPEN_MIN_DOT1CB_INITIATOR_FLOWS 1 |
minimum flow ID for 802.1CB initiator flows | |
#define | OPEN_MIN_DOT1CB_TRANSIT_FLOWS 1 |
minimum flow ID for 802.1CB transit flows | |
Enumerations | |
enum | OPEN_DOT1CB_FLOW_TYPE_t { OPEN_DOT1CB_FLOW_TYPE_NONE = 0, OPEN_DOT1CB_FLOW_TYPE_INITIATOR = 1, OPEN_DOT1CB_FLOW_TYPE_TRANSIT = 2 } |
Functions | |
open_error_t | openapiDot1cbApiDot1cbEnabledVlanNextGet (openapiClientHandle_t *client_handle, uint32_t *vid) |
Get the next 802.1CB enabled VLAN. More... | |
open_error_t | openapiDot1cbApiInitFlowGet (openapiClientHandle_t *client_handle, uint32_t flowId, uint32_t *classifiers, uint32_t *nextTxSequence, uint64_t *txPackets) |
Get the 802.1CB initiator flow and its status/statistics. More... | |
open_error_t | openapiDot1cbApiInitFlowNextGet (openapiClientHandle_t *client_handle, uint32_t *flowId, uint32_t *classifiers, uint32_t *nextTxSequence, uint64_t *txPackets) |
Get the next 802.1CB initiator flow and its status/statistics. More... | |
open_error_t | openapiDot1cbApiNumDot1cbVlansGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the number of 802.1CB enabled VLANs. More... | |
open_error_t | openapiDot1cbApiTransitFlowAcceptanceWindowSizeSet (openapiClientHandle_t *client_handle, uint32_t flowId, uint32_t acceptanceWindow) |
Set the acceptance window size for an 802.1CB transit flow. More... | |
open_error_t | openapiDot1cbApiTransitFlowAgeTimeSet (openapiClientHandle_t *client_handle, uint32_t flowId, uint32_t ageTime) |
Set the age time for an 802.1CB transit flow. More... | |
open_error_t | openapiDot1cbApiTransitFlowConfigGet (openapiClientHandle_t *client_handle, uint32_t flowId, uint32_t *historyWindow, uint32_t *acceptanceWindow, uint32_t *ageTime) |
Get the 802.1CB transit flow configuration. More... | |
open_error_t | openapiDot1cbApiTransitFlowGet (openapiClientHandle_t *client_handle, uint32_t flowId, uint32_t *classifiers, uint32_t *lastRxSequence, uint64_t *matchingPackets, uint64_t *acceptedPackets, uint64_t *duplicatePackets) |
Get the 802.1CB transit flow and its status/statistics. More... | |
open_error_t | openapiDot1cbApiTransitFlowHistoryWindowSizeSet (openapiClientHandle_t *client_handle, uint32_t flowId, uint32_t historyWindow) |
Set the history window size for an 802.1CB transit flow. More... | |
open_error_t | openapiDot1cbApiTransitFlowNextGet (openapiClientHandle_t *client_handle, uint32_t *flowId, uint32_t *classifiers, uint32_t *lastRxSequence, uint64_t *matchingPackets, uint64_t *acceptedPackets, uint64_t *duplicatePackets) |
Get the next 802.1CB transit flow and its status/statistics. More... | |
open_error_t | openapiDot1cbForwardArpNdpModeGet (openapiClientHandle_t *client_handle, uint32_t vlanID, OPEN_CONTROL_t *mode) |
Get the 802.1CB ARP/NDP forwarding mode for a given VLAN. More... | |
open_error_t | openapiDot1cbForwardArpNdpModeSet (openapiClientHandle_t *client_handle, uint32_t vlanID, OPEN_CONTROL_t mode) |
Set the 802.1CB ARP/NDP forwarding mode for a given VLAN. More... | |
open_error_t | openapiDot1cbGlobalStatsGet (openapiClientHandle_t *client_handle, OPEN_DOT1CB_GLOBAL_STATS_t *stat) |
Get the 802.1CB global statistics. More... | |
open_error_t | openapiDot1cbIntfNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum) |
Get the next valid 802.1CB interface. More... | |
open_error_t | openapiDot1cbIntfStatsGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1CB_INTF_STATS_t *stat) |
Get the 802.1CB statistics for the specified interface. More... | |
open_error_t | openapiDot1cbIpv4ClassifierAdd (openapiClientHandle_t *client_handle, open_inet_addr_t *srcAddr, uint32_t srcMaskLen, open_inet_addr_t *dstAddr, uint32_t dstMaskLen, OPEN_DOT1CB_FLOW_TYPE_t flowType, uint32_t flowId) |
Add an IPv4 classifier. More... | |
open_error_t | openapiDot1cbIpv4ClassifierCountGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the number of configured IPv4 classifiers. More... | |
open_error_t | openapiDot1cbIpv4ClassifierDelete (openapiClientHandle_t *client_handle, open_inet_addr_t *srcAddr, uint32_t srcMaskLen, open_inet_addr_t *dstAddr, uint32_t dstMaskLen) |
Delete an IPv4 classifier. More... | |
open_error_t | openapiDot1cbIpv4ClassifierGet (openapiClientHandle_t *client_handle, open_inet_addr_t *srcAddr, uint32_t srcMaskLen, open_inet_addr_t *dstAddr, uint32_t dstMaskLen, OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId) |
Get an IPv4 classifier. More... | |
open_error_t | openapiDot1cbIpv4ClassifierInHardwareGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the status flag indicating whether IPv4 classifiers are installed in the hardware. More... | |
open_error_t | openapiDot1cbIpv4ClassifierNextGet (openapiClientHandle_t *client_handle, open_inet_addr_t *srcAddr, uint32_t *srcMaskLen, open_inet_addr_t *dstAddr, uint32_t *dstMaskLen, OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId) |
Get the next IPv4 classifier. More... | |
open_error_t | openapiDot1cbIpv6ClassifierAdd (openapiClientHandle_t *client_handle, open_in6_addr_t *srcAddr, uint32_t srcMaskLen, open_in6_addr_t *dstAddr, uint32_t dstMaskLen, OPEN_DOT1CB_FLOW_TYPE_t flowType, uint32_t flowId) |
Add an IPv6 classifier. More... | |
open_error_t | openapiDot1cbIpv6ClassifierCountGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the number of configured IPv6 classifiers. More... | |
open_error_t | openapiDot1cbIpv6ClassifierDelete (openapiClientHandle_t *client_handle, open_in6_addr_t *srcAddr, uint32_t srcMaskLen, open_in6_addr_t *dstAddr, uint32_t dstMaskLen) |
Delete an IPv6 classifier. More... | |
open_error_t | openapiDot1cbIpv6ClassifierGet (openapiClientHandle_t *client_handle, open_in6_addr_t *srcAddr, uint32_t srcMaskLen, open_in6_addr_t *dstAddr, uint32_t dstMaskLen, OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId) |
Get an IPv6 classifier. More... | |
open_error_t | openapiDot1cbIpv6ClassifierInHardwareGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the status flag indicating whether IPv6 classifiers are installed in the hardware. More... | |
open_error_t | openapiDot1cbIpv6ClassifierNextGet (openapiClientHandle_t *client_handle, open_in6_addr_t *srcAddr, uint32_t *srcMaskLen, open_in6_addr_t *dstAddr, uint32_t *dstMaskLen, OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId) |
Get the next IPv6 classifier. More... | |
open_error_t | openapiDot1cbModeGet (openapiClientHandle_t *client_handle, uint32_t vlanID, OPEN_CONTROL_t *mode) |
Get the 802.1CB mode for a given VLAN. More... | |
open_error_t | openapiDot1cbModeSet (openapiClientHandle_t *client_handle, uint32_t vlanID, OPEN_CONTROL_t mode) |
Set the 802.1CB mode for a given VLAN. More... | |
open_error_t | openapiDot1cbNumActiveInititatorFlowsGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the number of initiator flows installed in the hardware. More... | |
open_error_t | openapiDot1cbNumActiveTransitFlowsGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the number of transit flows installed in the hardware. More... | |
open_error_t | openapiDot1cbNumMfdbClassifiersGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the number of MFDB entries associated with flows. More... | |
open_error_t | openapiDot1cbRtagModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode) |
Get the 802.1CB RTAG mode for the specified interface. More... | |
open_error_t | openapiDot1cbRtagModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode) |
Set the 802.1CB RTAG mode for the specified interface. More... | |
open_error_t | openapiDot1cbSaModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode) |
Get the SA-MAC/VLAN flow association mode. More... | |
open_error_t | openapiDot1cbSaModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode) |
Set the SA-MAC/VLAN flow association mode. More... | |
open_error_t | openapiDot1cbStatsClear (openapiClientHandle_t *client_handle) |
Clear all the 802.1CB statistics. More... | |
open_error_t | openapiFilterFlowIdGet (openapiClientHandle_t *client_handle, open_buffdesc *buf, uint32_t vlanID, uint32_t *flowId) |
Get the configured flow ID. More... | |
open_error_t | openapiFilterFlowTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *buf, uint32_t vlanID, OPEN_DOT1CB_FLOW_TYPE_t *flowType) |
Get the configured flow type. More... | |
open_error_t | openapiFilterFlowTypeIdSet (openapiClientHandle_t *client_handle, open_buffdesc *buf, uint32_t vlanID, OPEN_DOT1CB_FLOW_TYPE_t flowType, uint32_t flowId) |
Set the flow type and ID of an existing macfilter. More... | |
Enumerator | |
---|---|
OPEN_DOT1CB_FLOW_TYPE_NONE |
none |
OPEN_DOT1CB_FLOW_TYPE_INITIATOR |
initiator |
OPEN_DOT1CB_FLOW_TYPE_TRANSIT |
transit |
Definition at line 56 of file openapi_dot1cb.h.
open_error_t openapiDot1cbApiDot1cbEnabledVlanNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | vid | ||
) |
Get the next 802.1CB enabled VLAN.
[in] | client_handle | client handle from registration API |
[in,out] | vid | VLAN identifier |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiInitFlowGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | flowId, | ||
uint32_t * | classifiers, | ||
uint32_t * | nextTxSequence, | ||
uint64_t * | txPackets | ||
) |
Get the 802.1CB initiator flow and its status/statistics.
[in] | client_handle | client handle from registration API |
[in] | flowId | initiator flow identifier |
[out] | classifiers | number of classifiers using this flow |
[out] | nextTxSequence | next sequence number in the RTAG |
[out] | txPackets | number of packets sent by the switch that match this flow |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiInitFlowNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | flowId, | ||
uint32_t * | classifiers, | ||
uint32_t * | nextTxSequence, | ||
uint64_t * | txPackets | ||
) |
Get the next 802.1CB initiator flow and its status/statistics.
[in] | client_handle | client handle from registration API |
[in,out] | flowId | initiator flow identifier |
[out] | classifiers | number of classifiers using this flow |
[out] | nextTxSequence | next sequence number in the RTAG |
[out] | txPackets | number of packets sent by the switch that match this flow |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiNumDot1cbVlansGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the number of 802.1CB enabled VLANs.
[in] | client_handle | client handle from registration API |
[out] | value | number of VLANs enabled for 802.1CB |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiTransitFlowAcceptanceWindowSizeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | flowId, | ||
uint32_t | acceptanceWindow | ||
) |
Set the acceptance window size for an 802.1CB transit flow.
[in] | client_handle | client handle from registration API |
[in] | flowId | transit flow identifier |
[in] | acceptanceWindow | acceptance window size in bytes |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiTransitFlowAgeTimeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | flowId, | ||
uint32_t | ageTime | ||
) |
Set the age time for an 802.1CB transit flow.
[in] | client_handle | client handle from registration API |
[in] | flowId | transit flow identifier |
[in] | ageTime | age time in 10ms ticks |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiTransitFlowConfigGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | flowId, | ||
uint32_t * | historyWindow, | ||
uint32_t * | acceptanceWindow, | ||
uint32_t * | ageTime | ||
) |
Get the 802.1CB transit flow configuration.
[in] | client_handle | client handle from registration API |
[in] | flowId | transit flow identifier |
[out] | historyWindow | history window size |
[out] | acceptanceWindow | acceptance window size |
[out] | ageTime | age time in 10ms ticks |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiTransitFlowGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | flowId, | ||
uint32_t * | classifiers, | ||
uint32_t * | lastRxSequence, | ||
uint64_t * | matchingPackets, | ||
uint64_t * | acceptedPackets, | ||
uint64_t * | duplicatePackets | ||
) |
Get the 802.1CB transit flow and its status/statistics.
[in] | client_handle | client handle from registration API |
[in] | flowId | transit flow identifier |
[out] | classifiers | number of classifiers using this flow |
[out] | lastRxSequence | last accepted sequence number on this flow |
[out] | matchingPackets | number of packets received by the switch that match this flow |
[out] | acceptedPackets | number of packets received by the switch that match this flow and are not discarded |
[out] | duplicatePackets | number of duplicate packets received by the switch that match this flow and are discarded |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiTransitFlowHistoryWindowSizeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | flowId, | ||
uint32_t | historyWindow | ||
) |
Set the history window size for an 802.1CB transit flow.
[in] | client_handle | client handle from registration API |
[in] | flowId | transit flow identifier |
[in] | historyWindow | history window size in bytes |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbApiTransitFlowNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | flowId, | ||
uint32_t * | classifiers, | ||
uint32_t * | lastRxSequence, | ||
uint64_t * | matchingPackets, | ||
uint64_t * | acceptedPackets, | ||
uint64_t * | duplicatePackets | ||
) |
Get the next 802.1CB transit flow and its status/statistics.
[in] | client_handle | client handle from registration API |
[in,out] | flowId | transit flow identifier |
[out] | classifiers | number of classifiers using this flow |
[out] | lastRxSequence | last accepted sequence number on this flow |
[out] | matchingPackets | number of packets received by the switch that match this flow |
[out] | acceptedPackets | number of packets received by the switch that match this flow and are not discarded |
[out] | duplicatePackets | number of duplicate packets received by the switch that match this flow and are discarded |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbForwardArpNdpModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanID, | ||
OPEN_CONTROL_t * | mode | ||
) |
Get the 802.1CB ARP/NDP forwarding mode for a given VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanID | VLAN identifier |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value OPENAPI_DOT1Q_MAX_VLAN_ID | |
[out] | mode | configured 802.1cb ARP/NDP forwarding mode |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbForwardArpNdpModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanID, | ||
OPEN_CONTROL_t | mode | ||
) |
Set the 802.1CB ARP/NDP forwarding mode for a given VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanID | VLAN identifier |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value OPENAPI_DOT1Q_MAX_VLAN_ID | |
[in] | mode | 802.1cb ARP/NDP forwarding mode to be set |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbGlobalStatsGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_DOT1CB_GLOBAL_STATS_t * | stat | ||
) |
Get the 802.1CB global statistics.
[in] | client_handle | client handle from registration API |
[out] | stat | 802.1CB global statistics |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIntfNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | nextIfNum | ||
) |
Get the next valid 802.1CB interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | interface |
- | Maximum value OPENAPI_DOT1CB_INTF_MAX_COUNT | |
[out] | nextIfNum | pointer to next interface |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIntfStatsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DOT1CB_INTF_STATS_t * | stat | ||
) |
Get the 802.1CB statistics for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | interface |
- | Maximum value OPENAPI_DOT1CB_INTF_MAX_COUNT | |
[out] | stat | 802.1CB interface statistics |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv4ClassifierAdd | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | srcAddr, | ||
uint32_t | srcMaskLen, | ||
open_inet_addr_t * | dstAddr, | ||
uint32_t | dstMaskLen, | ||
OPEN_DOT1CB_FLOW_TYPE_t | flowType, | ||
uint32_t | flowId | ||
) |
Add an IPv4 classifier.
[in] | client_handle | client handle from registration API |
[in] | srcAddr | source IP address |
[in] | srcMaskLen | source IP mask length |
[in] | dstAddr | destination IP address |
[in] | dstMaskLen | destination IP mask length |
[in] | flowType | flow type |
[in] | flowId | flow identifier |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_EXISTS | Already exists. |
OPEN_E_FULL | Maximum count reached or table full. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv4ClassifierCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the number of configured IPv4 classifiers.
[in] | client_handle | client handle from registration API |
[out] | value | number of IPv4 classifiers |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv4ClassifierDelete | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | srcAddr, | ||
uint32_t | srcMaskLen, | ||
open_inet_addr_t * | dstAddr, | ||
uint32_t | dstMaskLen | ||
) |
Delete an IPv4 classifier.
[in] | client_handle | client handle from registration API |
[in] | srcAddr | source IP address |
[in] | srcMaskLen | source IP mask length |
[in] | dstAddr | destination IP address |
[in] | dstMaskLen | destination IP mask length |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_NOT_FOUND | Parameter not found. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv4ClassifierGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | srcAddr, | ||
uint32_t | srcMaskLen, | ||
open_inet_addr_t * | dstAddr, | ||
uint32_t | dstMaskLen, | ||
OPEN_DOT1CB_FLOW_TYPE_t * | flowType, | ||
uint32_t * | flowId | ||
) |
Get an IPv4 classifier.
[in] | client_handle | client handle from registration API |
[in] | srcAddr | source IP address |
[in] | srcMaskLen | source IP mask length |
[in] | dstAddr | destination IP address |
[in] | dstMaskLen | destination IP mask length |
[out] | flowType | flow type |
[out] | flowId | flow identifier |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_NOT_FOUND | Parameter not found. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv4ClassifierInHardwareGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the status flag indicating whether IPv4 classifiers are installed in the hardware.
[in] | client_handle | client handle from registration API |
[out] | value | 1-Installed, 0-Not Installed |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv4ClassifierNextGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | srcAddr, | ||
uint32_t * | srcMaskLen, | ||
open_inet_addr_t * | dstAddr, | ||
uint32_t * | dstMaskLen, | ||
OPEN_DOT1CB_FLOW_TYPE_t * | flowType, | ||
uint32_t * | flowId | ||
) |
Get the next IPv4 classifier.
[in] | client_handle | client handle from registration API |
[in,out] | srcAddr | source IP address |
[in,out] | srcMaskLen | source IP mask length |
[in,out] | dstAddr | destination IP address |
[in,out] | dstMaskLen | destination IP mask length |
[out] | flowType | flow type |
[out] | flowId | flow identifier |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_NOT_FOUND | Parameter not found. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv6ClassifierAdd | ( | openapiClientHandle_t * | client_handle, |
open_in6_addr_t * | srcAddr, | ||
uint32_t | srcMaskLen, | ||
open_in6_addr_t * | dstAddr, | ||
uint32_t | dstMaskLen, | ||
OPEN_DOT1CB_FLOW_TYPE_t | flowType, | ||
uint32_t | flowId | ||
) |
Add an IPv6 classifier.
[in] | client_handle | client handle from registration API |
[in] | srcAddr | source IP address |
[in] | srcMaskLen | source IP mask length |
[in] | dstAddr | destination IP address |
[in] | dstMaskLen | destination IP mask length |
[in] | flowType | flow type |
[in] | flowId | flow identifier |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_EXISTS | Already exists. |
OPEN_E_FULL | Maximum count reached or table full. |
OPEN_E_UNAVAIL | IPv6 feature not supported. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv6ClassifierCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the number of configured IPv6 classifiers.
[in] | client_handle | client handle from registration API |
[out] | value | number of IPv6 classifiers |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_UNAVAIL | IPv6 feature not supported. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv6ClassifierDelete | ( | openapiClientHandle_t * | client_handle, |
open_in6_addr_t * | srcAddr, | ||
uint32_t | srcMaskLen, | ||
open_in6_addr_t * | dstAddr, | ||
uint32_t | dstMaskLen | ||
) |
Delete an IPv6 classifier.
[in] | client_handle | client handle from registration API |
[in] | srcAddr | source IP address |
[in] | srcMaskLen | source IP mask length |
[in] | dstAddr | destination IP address |
[in] | dstMaskLen | destination IP mask length |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_NOT_FOUND | Parameter not found. |
OPEN_E_UNAVAIL | IPv6 feature not supported. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv6ClassifierGet | ( | openapiClientHandle_t * | client_handle, |
open_in6_addr_t * | srcAddr, | ||
uint32_t | srcMaskLen, | ||
open_in6_addr_t * | dstAddr, | ||
uint32_t | dstMaskLen, | ||
OPEN_DOT1CB_FLOW_TYPE_t * | flowType, | ||
uint32_t * | flowId | ||
) |
Get an IPv6 classifier.
[in] | client_handle | client handle from registration API |
[in] | srcAddr | source IP address |
[in] | srcMaskLen | source IP mask length |
[in] | dstAddr | destination IP address |
[in] | dstMaskLen | destination IP mask length |
[out] | flowType | flow type |
[out] | flowId | flow identifier |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_NOT_FOUND | Parameter not found. |
OPEN_E_UNAVAIL | IPv6 feature not supported. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv6ClassifierInHardwareGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the status flag indicating whether IPv6 classifiers are installed in the hardware.
[in] | client_handle | client handle from registration API |
[out] | value | 1-Installed, 0-Not Installed |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_UNAVAIL | IPv6 feature not supported. |
OpEN API Version: 1.20
open_error_t openapiDot1cbIpv6ClassifierNextGet | ( | openapiClientHandle_t * | client_handle, |
open_in6_addr_t * | srcAddr, | ||
uint32_t * | srcMaskLen, | ||
open_in6_addr_t * | dstAddr, | ||
uint32_t * | dstMaskLen, | ||
OPEN_DOT1CB_FLOW_TYPE_t * | flowType, | ||
uint32_t * | flowId | ||
) |
Get the next IPv6 classifier.
[in] | client_handle | client handle from registration API |
[in,out] | srcAddr | source IP address |
[in,out] | srcMaskLen | source IP mask length |
[in,out] | dstAddr | destination IP address |
[in,out] | dstMaskLen | destination IP mask length |
[out] | flowType | flow type |
[out] | flowId | flow identifier |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OPEN_E_NOT_FOUND | Parameter not found. |
OPEN_E_UNAVAIL | IPv6 feature not supported. |
OpEN API Version: 1.20
open_error_t openapiDot1cbModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanID, | ||
OPEN_CONTROL_t * | mode | ||
) |
Get the 802.1CB mode for a given VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanID | VLAN identifier |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value OPENAPI_DOT1Q_MAX_VLAN_ID | |
[out] | mode | configured 802.1cb mode |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanID, | ||
OPEN_CONTROL_t | mode | ||
) |
Set the 802.1CB mode for a given VLAN.
[in] | client_handle | client handle from registration API |
[in] | vlanID | VLAN identifier |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value OPENAPI_DOT1Q_MAX_VLAN_ID | |
[in] | mode | 802.1cb mode to be set |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbNumActiveInititatorFlowsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the number of initiator flows installed in the hardware.
[in] | client_handle | client handle from registration API |
[out] | value | number of initiator flows |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbNumActiveTransitFlowsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the number of transit flows installed in the hardware.
[in] | client_handle | client handle from registration API |
[out] | value | number of transit flows |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbNumMfdbClassifiersGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the number of MFDB entries associated with flows.
[in] | client_handle | client handle from registration API |
[out] | value | number of MFDB entries |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbRtagModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | mode | ||
) |
Get the 802.1CB RTAG mode for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | interface |
[out] | mode | configured RTAG mode |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbRtagModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | mode | ||
) |
Set the 802.1CB RTAG mode for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | interface |
[in] | mode | RTAG mode |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbSaModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | mode | ||
) |
Get the SA-MAC/VLAN flow association mode.
[in] | client_handle | client handle from registration API |
[out] | mode | SA-MAC/VLAN flow association mode |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbSaModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | mode | ||
) |
Set the SA-MAC/VLAN flow association mode.
[in] | client_handle | client handle from registration API |
[in] | mode | 802.1cb mode to be set |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiDot1cbStatsClear | ( | openapiClientHandle_t * | client_handle | ) |
Clear all the 802.1CB statistics.
[in] | client_handle | client handle from registration API |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiFilterFlowIdGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | buf, | ||
uint32_t | vlanID, | ||
uint32_t * | flowId | ||
) |
Get the configured flow ID.
[in] | client_handle | client handle from registration API |
[in] | buf | static MAC address for the filter in one of the following formats: "xx:xx:xx:xx:xx:xx" or "xx-xx-xx-xx-xx-xx" or "xxxx.xxxx.xxxx" |
[in] | vlanID | VLAN ID for the filter |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value OPENAPI_DOT1Q_MAX_VLAN_ID | |
[out] | flowId | configured 802.1cb flow ID |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiFilterFlowTypeGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | buf, | ||
uint32_t | vlanID, | ||
OPEN_DOT1CB_FLOW_TYPE_t * | flowType | ||
) |
Get the configured flow type.
[in] | client_handle | client handle from registration API |
[in] | buf | static MAC address for the filter in one of the following formats: "xx:xx:xx:xx:xx:xx" or "xx-xx-xx-xx-xx-xx" or "xxxx.xxxx.xxxx" |
[in] | vlanID | VLAN ID for the filter |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value OPENAPI_DOT1Q_MAX_VLAN_ID | |
[out] | flowType | configured 802.1cb flow type |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20
open_error_t openapiFilterFlowTypeIdSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | buf, | ||
uint32_t | vlanID, | ||
OPEN_DOT1CB_FLOW_TYPE_t | flowType, | ||
uint32_t | flowId | ||
) |
Set the flow type and ID of an existing macfilter.
[in] | client_handle | client handle from registration API |
[in] | buf | static MAC address for the filter in one of the following formats: "xx:xx:xx:xx:xx:xx" or "xx-xx-xx-xx-xx-xx" or "xxxx.xxxx.xxxx" |
[in] | vlanID | VLAN ID for the filter |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value OPENAPI_DOT1Q_MAX_VLAN_ID | |
[in] | flowType | 802.1cb flow type to be set |
[in] | flowId | 802.1cb flow ID to be set |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.20