Routing ARP Table Configuration And Status [OPENAPI_ROUTING_ARPTABLE]

Data Structures
struct	OPEN_ARP_ENTRY_t

Enumerations
enum	OPEN_ARP_TYPE_t {   OPEN_ARP_LOCAL = 0x01, OPEN_ARP_GATEWAY = 0x02, OPEN_ARP_RESOLVED = 0x04, OPEN_ARP_NET_DIR_BCAST = 0x08,   OPEN_ARP_DISCARD_WHEN_SOURCE = 0x10, OPEN_ARP_STATIC = 0x20, OPEN_ARP_UNNUMBERED = 0x40, OPEN_ARP_KERNEL = 0x80 }

Functions
open_error_t	openapiArpAgeTimeGet (openapiClientHandle_t *client_handle, uint32_t *val)
	API to get the ARP age time in seconds.
open_error_t	openapiArpCacheSizeGet (openapiClientHandle_t *client_handle, uint32_t *val)
	API to get the ARP cache size.
open_error_t	openapiArpDynamicRenewModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *val)
	API to get if ARP dynamic renew mode is enabled or not.
open_error_t	openapiArpEntryInfoGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t intf, open_inet_addr_t ipAddr, OPEN_ARP_ENTRY_t *entry)
	Get the ARP data for a given vrfName, ipAddr, and interface.
open_error_t	openapiArpEntryVrfNextGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *intf, open_inet_addr_t *ipAddr)
	Get the next VRF ARP entry.
open_error_t	openapiArpNumRetriesGet (openapiClientHandle_t *client_handle, uint32_t *val)
	API to get the ARP number of retries.
open_error_t	openapiArpResponseTimeGet (openapiClientHandle_t *client_handle, uint32_t *val)
	API to get the ARP response time in seconds.
open_error_t	openapiArpStaticEntryCountInfoGet (openapiClientHandle_t *client_handle, uint32_t *configured, uint32_t *active, uint32_t *max)
	API to get the ARP static entry count info.
open_error_t	openapiArpTotalEntryCountInfoGet (openapiClientHandle_t *client_handle, uint32_t *current, uint32_t *peak)
	API to get the ARP total current entry count info.

Detailed Description

Enumeration Type Documentation

enum OPEN_ARP_TYPE_t

Enumerator:

OPEN_ARP_LOCAL	IP address is one of switch's MAC addresses.
OPEN_ARP_GATEWAY	Destination is a router.
OPEN_ARP_RESOLVED	Resolved ARP entry, dest MAC address known.
OPEN_ARP_NET_DIR_BCAST	Net directed broadcast addr.
OPEN_ARP_DISCARD_WHEN_SOURCE	Discard when seen as source.
OPEN_ARP_STATIC	Static ARP entry.
OPEN_ARP_UNNUMBERED	Unnumbered intf ARP entry.
OPEN_ARP_KERNEL	Kernel ARP entry.

Definition at line 60 of file openapi_routing_arptable.h.

Function Documentation

open_error_t openapiArpAgeTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

API to get the ARP age time in seconds.

Parameters

[in]	client_handle	client handle from registration API.
[out]	val	ARP age time in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

open_error_t openapiArpCacheSizeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

API to get the ARP cache size.

Parameters

[in]	client_handle	client handle from registration API.
[out]	val	ARP cache size.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

open_error_t openapiArpDynamicRenewModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	val
	)

API to get if ARP dynamic renew mode is enabled or not.

Parameters

[in]	client_handle	client handle from registration API.
[out]	val	If OPEN_ENABLE, enabled. Otherwise, OPEN_DISABLE.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

open_error_t openapiArpEntryInfoGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	intf,
		open_inet_addr_t	ipAddr,
		OPEN_ARP_ENTRY_t *	entry
	)

Get the ARP data for a given vrfName, ipAddr, and interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vrfName	A valid VRF name.
[in]	intf	A valid interface.
[in]	ipAddr	A valid IP address.
[out]	entry	ARP table entry.

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Failure of some kind.
OPEN_E_NOT_FOUND	The arguments don't specify a valid ARP entry.
OPEN_E_PARAM	If an input parameter is invalid.

OpEN API Version: 1.14

open_error_t openapiArpEntryVrfNextGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	intf,
		open_inet_addr_t *	ipAddr
	)

Get the next VRF ARP entry.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vrfName	VRF name (or OPEN_DEFAULT_VRF_NAME if the default VRF is desired).
[in,out]	intf	Router Interface. Set to 0 to get the first entry.
[in,out]	ipAddr	IP address. Set the addr.ipv4 field to 0 to get first entry.

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Failure of some kind.
OPEN_E_NOT_FOUND	No more entries
OPEN_E_PARAM	If an input parameter is invalid.

Note

Setting vrfName to OPEN_DEFAULT_VRF_NAME will return data for the default VRF and results in the function behaving the same as openapiArpEntryNextGet() Both intf and ipAddr must be set to zero to get the first entry.

OpEN API Version: 1.14

open_error_t openapiArpNumRetriesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

API to get the ARP number of retries.

Parameters

[in]	client_handle	client handle from registration API.
[out]	val	ARP number of retries.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

open_error_t openapiArpResponseTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

API to get the ARP response time in seconds.

Parameters

[in]	client_handle	client handle from registration API.
[out]	val	ARP response time in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

open_error_t openapiArpStaticEntryCountInfoGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	configured,
		uint32_t *	active,
		uint32_t *	max
	)

API to get the ARP static entry count info.

Parameters

[in]	client_handle	client handle from registration API.
[out]	configured	configured static entry count.
[out]	active	active static entry count.
[out]	max	static entry count maximum.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

open_error_t openapiArpTotalEntryCountInfoGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	current,
		uint32_t *	peak
	)

API to get the ARP total current entry count info.

Parameters

[in]	client_handle	client handle from registration API.
[out]	current	total current entry count.
[out]	peak	total entry count peak.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14