Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_ARP_ACL_NAME_LEN_MAX 31 |
largest allowable ACL name | |
#define | OPEN_ARP_ACL_NAME_LEN_MIN 1 |
smallest allowable ACL name | |
Enumerations | |
enum | OPEN_ARP_ACL_RULE_ACTION_t { OPEN_ARP_ACL_RULE_ACTION_PERMIT = 1, OPEN_ARP_ACL_RULE_ACTION_DENY = 2 } |
OpEN uses this enumeration to define ARP ACL Rule Actions. More... | |
Functions | |
open_error_t | openapiArpAclGet (openapiClientHandle_t *client_handle, open_buffdesc *aclName) |
API to Check if an ARP ACL exists. More... | |
open_error_t | openapiArpAclNextGet (openapiClientHandle_t *client_handle, open_buffdesc *aclName, open_buffdesc *aclNameNext) |
API to get the next ARP ACL entry. More... | |
open_error_t | openapiArpAclRuleNextGet (openapiClientHandle_t *client_handle, open_buffdesc *aclName, open_inet_addr_t ipAddr, open_buffdesc *macAddr, open_inet_addr_t *ipAddrNext, open_buffdesc *macAddrNext) |
API not supported. More... | |
open_error_t | openapiArpAclRuleNextGetV2 (openapiClientHandle_t *client_handle, open_buffdesc *aclName, uint32_t seqNo, uint32_t *seqNoNext, open_inet_addr_t *ipAddrNext, open_buffdesc *macAddrNext, OPEN_ARP_ACL_RULE_ACTION_t *actionNext) |
API to get the next ARP ACL Rule in the given ACL. More... | |
open_error_t | openapiDaiDestMacValidateModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode) |
Get the global dynamic ARP inspection destination MAC validate mode. More... | |
open_error_t | openapiDaiDestMacValidateModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode) |
Set the global dynamic ARP inspection destination MAC validate mode. More... | |
open_error_t | openapiDaiIpAddrValidateModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode) |
Get the global dynamic ARP inspection IP address validate mode. More... | |
open_error_t | openapiDaiIpAddrValidateModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode) |
Set the global dynamic ARP inspection IP address validate mode. More... | |
open_error_t | openapiDaiSourceMacValidateModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode) |
Get the global dynamic ARP inspection source MAC validate mode. More... | |
open_error_t | openapiDaiSourceMacValidateModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode) |
Set the global dynamic ARP inspection source MAC validate mode. More... | |
OpEN uses this enumeration to define ARP ACL Rule Actions.
Enumerator | |
---|---|
OPEN_ARP_ACL_RULE_ACTION_PERMIT |
PERMIT action. |
OPEN_ARP_ACL_RULE_ACTION_DENY |
DENY action. |
Definition at line 63 of file openapi_dynamic_arp_inspection.h.
open_error_t openapiArpAclGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | aclName | ||
) |
API to Check if an ARP ACL exists.
[in] | client_handle | client handle from registration API. |
[in] | aclName | ACL Name |
OPEN_E_NONE | ACL exists. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | ACL does not exist. |
OpEN API Version: 1.14
open_error_t openapiArpAclNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | aclName, | ||
open_buffdesc * | aclNameNext | ||
) |
API to get the next ARP ACL entry.
[in] | client_handle | client handle from registration API. |
[in] | aclName | ACL Name |
[out] | aclNameNext | Next ACL Name |
OPEN_E_NONE | Next rule returned. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | End of entries, or some other error occurred. |
OpEN API Version: 1.14
open_error_t openapiArpAclRuleNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | aclName, | ||
open_inet_addr_t | ipAddr, | ||
open_buffdesc * | macAddr, | ||
open_inet_addr_t * | ipAddrNext, | ||
open_buffdesc * | macAddrNext | ||
) |
API not supported.
[in] | client_handle | client handle from registration API. |
[in] | aclName | ACL Name |
[in] | ipAddr | IP address |
[in] | macAddr | MAC address |
[out] | ipAddrNext | Next IP address |
[out] | macAddrNext | Next MAC address |
OPEN_E_UNAVAIL | Functionality unavailable |
Deprecated OpEN API Version: 1.14 OpEN API Version: 1.18
open_error_t openapiArpAclRuleNextGetV2 | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | aclName, | ||
uint32_t | seqNo, | ||
uint32_t * | seqNoNext, | ||
open_inet_addr_t * | ipAddrNext, | ||
open_buffdesc * | macAddrNext, | ||
OPEN_ARP_ACL_RULE_ACTION_t * | actionNext | ||
) |
API to get the next ARP ACL Rule in the given ACL.
[in] | client_handle | client handle from registration API. |
[in] | aclName | ACL Name |
[in] | seqNo | Rule Sequence number |
[out] | seqNoNext | Sequence number of next rule |
[out] | ipAddrNext | IP address in next rule |
[out] | macAddrNext | MAC address in next rule |
[out] | actionNext | Action in next rule |
OPEN_E_NONE | Next rule returned. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | End of entries, or some other error occurred. |
OpEN API Version: 1.18
open_error_t openapiDaiDestMacValidateModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | mode | ||
) |
Get the global dynamic ARP inspection destination MAC validate mode.
[in] | client_handle | Client handle from registration API. |
[out] | mode | Destination MAC validate mode. |
OPEN_E_NONE | Operation succeeded. |
OPEN_E_FAIL | Unable to get data value. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiDaiDestMacValidateModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | mode | ||
) |
Set the global dynamic ARP inspection destination MAC validate mode.
[in] | client_handle | Client handle from registration API. |
[in] | mode | Destination MAC validate mode. |
OPEN_E_NONE | Operation succeeded. |
OPEN_E_FAIL | Unable to set data value. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiDaiIpAddrValidateModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | mode | ||
) |
Get the global dynamic ARP inspection IP address validate mode.
[in] | client_handle | Client handle from registration API. |
[out] | mode | IP address validate mode. |
OPEN_E_NONE | Operation succeeded. |
OPEN_E_FAIL | Unable to get data value. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiDaiIpAddrValidateModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | mode | ||
) |
Set the global dynamic ARP inspection IP address validate mode.
[in] | client_handle | Client handle from registration API. |
[in] | mode | IP address validate mode. |
OPEN_E_NONE | Operation succeeded. |
OPEN_E_FAIL | Unable to set data value. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiDaiSourceMacValidateModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | mode | ||
) |
Get the global dynamic ARP inspection source MAC validate mode.
[in] | client_handle | Client handle from registration API. |
[out] | mode | Source MAC validate mode. |
OPEN_E_NONE | Operation succeeded. |
OPEN_E_FAIL | Unable to get data value. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18
open_error_t openapiDaiSourceMacValidateModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | mode | ||
) |
Set the global dynamic ARP inspection source MAC validate mode.
[in] | client_handle | Client handle from registration API. |
[in] | mode | Source MAC validate mode. |
OPEN_E_NONE | Operation succeeded. |
OPEN_E_FAIL | Unable to set data value. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.18