Dynamic ARP Table Configuration And Status [OPENAPI_DYNAMIC_ARP_INSPECTION]

Data Structures
struct	DAI_VLAN_STATS_S
	Dynamic ARP Inspection vlan statistics. More...

Macros
#define	OPEN_ARP_ACL_NAME_LEN_MAX   32
	largest allowable ACL name
#define	OPEN_ARP_ACL_NAME_LEN_MIN   1
	smallest allowable ACL name
#define	OPEN_DAI_BURST_INTERVAL_MAX   15
#define	OPEN_DAI_BURST_INTERVAL_MIN   1
#define	OPEN_DAI_RATE_LIMIT_MAX   300
#define	OPEN_DAI_RATE_LIMIT_MIN   0

Typedefs
typedef struct DAI_VLAN_STATS_S	OPEN_DAI_VLAN_STATS_t
	Dynamic ARP Inspection vlan statistics.

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	openapiArpAclCreate (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
	API to create ARP ACL (extensible version). More...
open_error_t	openapiArpAclDelete (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
	API to delete ARP ACL (extensible version). More...
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	openapiArpAclRuleAdd (openapiClientHandle_t *client_handle, open_buffdesc *bufd, uint32_t seqNo, uint32_t ipAddr, open_buffdesc *macAddr, OPEN_ARP_ACL_RULE_ACTION_t action)
	API to add rule to ARP ACL. More...
open_error_t	openapiArpAclRuleDelete (openapiClientHandle_t *client_handle, open_buffdesc *bufd, uint32_t seqNo)
	API to remove rule from ARP ACL. 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	openapiDaiIntfBurstIntervalGet (openapiClientHandle_t *client_handle, uint32_t ifNum, int32_t *burstInterval)
	Get burst interval value of incoming ARP packets on untrusted interfaces. More...
open_error_t	openapiDaiIntfBurstIntervalSet (openapiClientHandle_t *client_handle, uint32_t ifNum, int32_t burstInterval)
	Set burst interval value of incoming ARP packets on untrusted interfaces. More...
open_error_t	openapiDaiIntfRateLimitGet (openapiClientHandle_t *client_handle, uint32_t ifNum, int32_t *rate)
	Get rate limit value of incoming ARP packets on untrusted interfaces. More...
open_error_t	openapiDaiIntfRateLimitSet (openapiClientHandle_t *client_handle, uint32_t ifNum, int32_t rate)
	Set rate limit value of incoming ARP packets on untrusted interfaces. More...
open_error_t	openapiDaiIntfTrustGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *trustMode)
	Get API for whether DAI considers a port trusted. More...
open_error_t	openapiDaiIntfTrustSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t trustMode)
	Set API for whether DAI considers a port trusted. 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_error_t	openapiDaiVlanArpAclGet (openapiClientHandle_t *client_handle, uint32_t vlanId, open_buffdesc *aclName)
	Get the ARP ACL Name for a vlan (Extended Version). More...
open_error_t	openapiDaiVlanARPAclRangeSet (openapiClientHandle_t *client_handle, open_buffdesc *aclName, uint32_t vlanStart, uint32_t vlanEnd, uint32_t val, uint32_t staticFlag)
	Apply the ARP ACL to a range of VLANs. More...
open_error_t	openapiDaiVlanArpAclSet (openapiClientHandle_t *client_handle, uint32_t vlanId, open_buffdesc *aclName)
	Set/reset the ARP ACL Name for a vlan. More...
open_error_t	openapiDaiVlanArpAclStaticFlagGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *staticFlag)
	Get the ARP ACL static flag for a vlan. More...
open_error_t	openapiDaiVlanArpAclStaticFlagSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t staticFlag)
	Set the ARP ACL static flag for a vlan. More...
open_error_t	openapiDaiVlanEnableGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *val)
	Get API for whether Dynamic ARP Inspection is enabled or disabled on a VLAN. More...
open_error_t	openapiDaiVlanEnableSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t val)
	Set API to enable or disable Dynamic ARP Inspection on a VLAN. More...
open_error_t	openapiDaiVlanLoggingEnableGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *val)
	Get API for whether DAI logging is enabled or disabled on a VLAN. More...
open_error_t	openapiDaiVlanLoggingEnableSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t val)
	Set API to enable or disable DAI logging for a VLAN. More...
open_error_t	openapiDaiVlanNextGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *nextVlan)
	Get the next vlan id eligible for DAI configuration, given the current vlan id. More...
open_error_t	openapiDaiVlanStatsClear (openapiClientHandle_t *client_handle)
	Clear DAI statistics on all vlans. More...
open_error_t	openapiDaiVlanStatsGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_DAI_VLAN_STATS_t *vlanStats)
	Get DAI statistics on a VLAN. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_ARP_ACL_RULE_ACTION_t

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 openapiArpAclCreate	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	bufd
	)

API to create ARP ACL (extensible version).

Parameters

[in]	client_handle	client handle from registration API
[in]	bufd	buffer descriptor containing ACL Name

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiArpAclDelete	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	bufd
	)

API to delete ARP ACL (extensible version).

Parameters

[in]	client_handle	client handle from registration API
[in]	bufd	buffer descriptor containing ACL Name

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiArpAclGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	aclName
	)

API to Check if an ARP ACL exists.

Parameters

[in]	client_handle	client handle from registration API.
[in]	aclName	ACL Name

Return values

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.

Parameters

[in]	client_handle	client handle from registration API.
[in]	aclName	ACL Name
[out]	aclNameNext	Next ACL Name

Return values

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 openapiArpAclRuleAdd	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	bufd,
		uint32_t	seqNo,
		uint32_t	ipAddr,
		open_buffdesc *	macAddr,
		OPEN_ARP_ACL_RULE_ACTION_t	action
	)

API to add rule to ARP ACL.

Parameters

[in]	client_handle	client handle from registration API
[in]	bufd	buffer descriptor containing ACL Name
[in]	seqNo	Rule Sequence Number
[in]	ipAddr	Sender's IP address
[in]	macAddr	Sender's MAC address
[in]	action	PERMIT or DENY action to be performed

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiArpAclRuleDelete	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	bufd,
		uint32_t	seqNo
	)

API to remove rule from ARP ACL.

Parameters

[in]	client_handle	client handle from registration API
[in]	bufd	buffer descriptor containing ACL Name
[in]	seqNo	Rule Sequence Number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

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

Return values

OPEN_E_UNAVAIL

Functionality 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_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

Return values

OPEN_E_NONE	Next rule returned.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	End of entries, or some other error occurred.

Note

MAC address string will be in xx:xx:xx:xx:xx:xx format

macAddrNext buffer should have 18 bytes memory.

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_handle	Client handle from registration API.
[out]	mode	Destination MAC validate mode.

Return values

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	mode	Destination MAC validate mode.

Return values

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.

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

open_error_t openapiDaiIntfBurstIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		int32_t *	burstInterval
	)

Get burst interval value of incoming ARP packets on untrusted interfaces.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface
[out]	burstInterval	Consecutive interval in seconds, over which the interface is monitored for a high rate of ARP packets

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiIntfBurstIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		int32_t	burstInterval
	)

Set burst interval value of incoming ARP packets on untrusted interfaces.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface
[in]	burstInterval	Consecutive interval in seconds, over which the interface is monitored for a high rate of ARP packets

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

open_error_t openapiDaiIntfRateLimitGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		int32_t *	rate
	)

Get rate limit value of incoming ARP packets on untrusted interfaces.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface
[out]	rate	Upper limit for number of incoming packets processed per second

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiIntfRateLimitSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		int32_t	rate
	)

Set rate limit value of incoming ARP packets on untrusted interfaces.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface
[in]	rate	Upper limit for number of incoming packets processed per second

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

open_error_t openapiDaiIntfTrustGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	trustMode
	)

Get API for whether DAI considers a port trusted.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface
[out]	trustMode	Port trust mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiIntfTrustSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	trustMode
	)

Set API for whether DAI considers a port trusted.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface
[in]	trustMode	Port trust mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

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_handle	Client handle from registration API.
[out]	mode	IP address validate mode.

Return values

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	mode	IP address validate mode.

Return values

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.

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_handle	Client handle from registration API.
[out]	mode	Source MAC validate mode.

Return values

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	mode	Source MAC validate mode.

Return values

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.

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

open_error_t openapiDaiVlanArpAclGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		open_buffdesc *	aclName
	)

Get the ARP ACL Name for a vlan (Extended Version).

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[out]	aclName	ARP ACL name for this VLAN

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanARPAclRangeSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	aclName,
		uint32_t	vlanStart,
		uint32_t	vlanEnd,
		uint32_t	val,
		uint32_t	staticFlag
	)

Apply the ARP ACL to a range of VLANs.

Parameters

[in]	client_handle	client handle from registration API
[in]	aclName	ACL name
[in]	vlanStart	Low end of VLAN range
[in]	vlanEnd	High end of VLAN range
[in]	val	L7_ENABLE if ARP ACL is enabled on all VLANs in the range
[in]	staticFlag	If static is enabled, packets that do not match any permit statements of ARP ACL are dropped without consulting the DHCP snooping bindings.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanArpAclSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		open_buffdesc *	aclName
	)

Set/reset the ARP ACL Name for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[in]	aclName	ARP ACL name for this VLAN

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

If the aclName is NULL or empty this API clears the ARP ACL name for a VLAN

OpEN API Version: 1.26

open_error_t openapiDaiVlanArpAclStaticFlagGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	staticFlag
	)

Get the ARP ACL static flag for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[out]	staticFlag	static flag for the VLAN

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanArpAclStaticFlagSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t	staticFlag
	)

Set the ARP ACL static flag for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[in]	staticFlag	static flag for the VLAN

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanEnableGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	val
	)

Get API for whether Dynamic ARP Inspection is enabled or disabled on a VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[out]	val	L7_ENABLE if DAI is enabled on the VLAN

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanEnableSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t	val
	)

Set API to enable or disable Dynamic ARP Inspection on a VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[in]	val	L7_ENABLE or L7_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanLoggingEnableGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	val
	)

Get API for whether DAI logging is enabled or disabled on a VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[out]	val	L7_ENABLE if DAI logging is enabled on the VLAN

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanLoggingEnableSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t	val
	)

Set API to enable or disable DAI logging for a VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[in]	val	L7_ENABLE or L7_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	nextVlan
	)

Get the next vlan id eligible for DAI configuration, given the current vlan id.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[out]	nextVlan	next VLAN Id

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanStatsClear

(

openapiClientHandle_t *

client_handle

)

Clear DAI statistics on all vlans.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

open_error_t openapiDaiVlanStatsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		OPEN_DAI_VLAN_STATS_t *	vlanStats
	)

Get DAI statistics on a VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN Id
[out]	vlanStats	Statistics for a given VLAN

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26