Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
Dynamic ARP Table Configuration And Status [OPENAPI_DYNAMIC_ARP_INSPECTION]

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...
 

Detailed Description

Enumeration Type Documentation

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.

Function Documentation

open_error_t openapiArpAclGet ( openapiClientHandle_t client_handle,
open_buffdesc aclName 
)

API to Check if an ARP ACL exists.

Parameters
[in]client_handleclient handle from registration API.
[in]aclNameACL Name
Return values
OPEN_E_NONEACL exists.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILACL 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.

Parameters
[in]client_handleclient handle from registration API.
[in]aclNameACL Name
[out]aclNameNextNext ACL Name
Return values
OPEN_E_NONENext rule returned.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILEnd 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.

Parameters
[in]client_handleclient handle from registration API.
[in]aclNameACL Name
[in]ipAddrIP address
[in]macAddrMAC address
[out]ipAddrNextNext IP address
[out]macAddrNextNext MAC address
Return values
OPEN_E_UNAVAILFunctionality unavailable
Note
This function was deprecated in API version 1.18. Please use openapiArpAclRuleNextGetV2 in new code.

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.

Parameters
[in]client_handleclient handle from registration API.
[in]aclNameACL Name
[in]seqNoRule Sequence number
[out]seqNoNextSequence number of next rule
[out]ipAddrNextIP address in next rule
[out]macAddrNextMAC address in next rule
[out]actionNextAction in next rule
Return values
OPEN_E_NONENext rule returned.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILEnd 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.

Parameters
[in]client_handleClient handle from registration API.
[out]modeDestination MAC validate mode.
Return values
OPEN_E_NONEOperation succeeded.
OPEN_E_FAILUnable to get data value.
OPEN_E_UNAVAILFeature not supported.
OPEN_E_PARAMError 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.

Parameters
[in]client_handleClient handle from registration API.
[in]modeDestination MAC validate mode.
Return values
OPEN_E_NONEOperation succeeded.
OPEN_E_FAILUnable to set data value.
OPEN_E_UNAVAILFeature not supported.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

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.

Parameters
[in]client_handleClient handle from registration API.
[out]modeIP address validate mode.
Return values
OPEN_E_NONEOperation succeeded.
OPEN_E_FAILUnable to get data value.
OPEN_E_UNAVAILFeature not supported.
OPEN_E_PARAMError 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.

Parameters
[in]client_handleClient handle from registration API.
[in]modeIP address validate mode.
Return values
OPEN_E_NONEOperation succeeded.
OPEN_E_FAILUnable to set data value.
OPEN_E_UNAVAILFeature not supported.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

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.

Parameters
[in]client_handleClient handle from registration API.
[out]modeSource MAC validate mode.
Return values
OPEN_E_NONEOperation succeeded.
OPEN_E_FAILUnable to get data value.
OPEN_E_UNAVAILFeature not supported.
OPEN_E_PARAMError 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.

Parameters
[in]client_handleClient handle from registration API.
[in]modeSource MAC validate mode.
Return values
OPEN_E_NONEOperation succeeded.
OPEN_E_FAILUnable to set data value.
OPEN_E_UNAVAILFeature not supported.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18