Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Enumerations | Functions
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. More...
 
open_error_t openapiArpCacheSizeGet (openapiClientHandle_t *client_handle, uint32_t *val)
 API to get the ARP cache size. More...
 
open_error_t openapiArpDynamicRenewModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *val)
 API to get if ARP dynamic renew mode is enabled or not. More...
 
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. More...
 
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. More...
 
open_error_t openapiArpNumRetriesGet (openapiClientHandle_t *client_handle, uint32_t *val)
 API to get the ARP number of retries. More...
 
open_error_t openapiArpResponseTimeGet (openapiClientHandle_t *client_handle, uint32_t *val)
 API to get the ARP response time in seconds. More...
 
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. More...
 
open_error_t openapiArpTotalEntryCountInfoGet (openapiClientHandle_t *client_handle, uint32_t *current, uint32_t *peak)
 API to get the ARP total current entry count info. More...
 

Detailed Description

Enumeration Type Documentation

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_handleclient handle from registration API.
[out]valARP age time in seconds
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome 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_handleclient handle from registration API.
[out]valARP cache size.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome 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_handleclient handle from registration API.
[out]valIf OPEN_ENABLE, enabled. Otherwise, OPEN_DISABLE.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome 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_handleclient handle from registration API.
[in]vrfNameA valid VRF name.
[in]intfA valid interface.
[in]ipAddrA valid IP address.
[out]entryARP table entry.
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILFailure of some kind.
OPEN_E_NOT_FOUNDThe arguments don't specify a valid ARP entry.
OPEN_E_PARAMIf 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_handleclient handle from registration API.
[in]vrfNameVRF name (or OPEN_DEFAULT_VRF_NAME if the default VRF is desired).
[in,out]intfRouter Interface. Set to 0 to get the first entry.
[in,out]ipAddrIP address. Set the addr.ipv4 field to 0 to get first entry.
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILFailure of some kind.
OPEN_E_NOT_FOUNDNo more entries
OPEN_E_PARAMIf 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_handleclient handle from registration API.
[out]valARP number of retries.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome 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_handleclient handle from registration API.
[out]valARP response time in seconds
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome 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_handleclient handle from registration API.
[out]configuredconfigured static entry count.
[out]activeactive static entry count.
[out]maxstatic entry count maximum.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome 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_handleclient handle from registration API.
[out]currenttotal current entry count.
[out]peaktotal entry count peak.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome failure occurred.

OpEN API Version: 1.14