Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Functions
DHCP Snooping API [OPENAPI_DHCP_SNOOPING]

Functions

open_error_t openapiDhcpSnoopingAdminModeGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, OPEN_CONTROL_t *adminMode)
 Gets the DHCP Snooping Admin mode. More...
 
open_error_t openapiDhcpSnoopingDbFileNameGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, open_buffdesc *fileName)
 Get the remote DHCP snooping database file name. More...
 
open_error_t openapiDhcpSnoopingDbFileNameMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *len)
 Get the remote DHCP snooping database file name max length. More...
 
open_error_t openapiDhcpSnoopingDbIpAddressGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, open_inet_addr_t *addr)
 Get the remote DHCP snooping database IPv4 Address. More...
 
open_error_t openapiDhcpSnoopingDbWriteDelayGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t *delay)
 Get the DHCP snooping database write delay. More...
 
open_error_t openapiDhcpSnoopingEnabledVlanRangeNextGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t *vlanStart, uint32_t *vlanEnd)
 Given a VLAN ID, return the endpoints of the next range of VLANs enabled for DHCP snooping. More...
 
open_error_t openapiDhcpSnoopingIntfLoggedGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t ifNum, OPEN_BOOL_t *logged)
 Determines whether DHCP snooping logs invalid packets on an interface. More...
 
open_error_t openapiDhcpSnoopingIntfTrustedGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t ifNum, OPEN_BOOL_t *trusted)
 Determines whether DHCP snooping considers an interface as trusted. More...
 
open_error_t openapiDhcpSnoopingPortEnabledGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t ifNum, OPEN_CONTROL_t *enabled)
 Determines whether DHCP snooping is enabled on a port. More...
 
open_error_t openapiDhcpSnoopingVerifySourceMacGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, OPEN_CONTROL_t *sourceMacVerify)
 Gets whether DHCP snooping verifies source MAC addresses. More...
 

Detailed Description

Function Documentation

open_error_t openapiDhcpSnoopingAdminModeGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
OPEN_CONTROL_t adminMode 
)

Gets the DHCP Snooping Admin mode.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[out]adminModeDHCP snooping admin mode
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure
OPEN_E_UNAVAILIPv6 requested but support is unavailable
Note
Use this function to determine if DHCP snooping is enabled.

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingDbFileNameGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
open_buffdesc fileName 
)

Get the remote DHCP snooping database file name.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[out]fileNameRemote DHCP snooping DB file name
-Minimum allowed value of buffer length is iobtainable by calling openapiDhcpSnoopingFileNameMaxLengthGet()
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingDbFileNameMaxLengthGet ( openapiClientHandle_t client_handle,
uint32_t *  len 
)

Get the remote DHCP snooping database file name max length.

Parameters
[in]client_handleClient handle from registration API
[out]lenMaximum length of filename including NULL.
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingDbIpAddressGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
open_inet_addr_t addr 
)

Get the remote DHCP snooping database IPv4 Address.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[out]addrRemote DHCP snooping DB IP Address
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingDbWriteDelayGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
uint32_t *  delay 
)

Get the DHCP snooping database write delay.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[out]Writedelay in seconds.
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingEnabledVlanRangeNextGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
uint32_t *  vlanStart,
uint32_t *  vlanEnd 
)

Given a VLAN ID, return the endpoints of the next range of VLANs enabled for DHCP snooping.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[out]vlanStartLow end of VLAN range
[in,out]vlanEndHigh end of VLAN range
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_NOT_FOUNDNo further VLANs beyond vlanEnd
OPEN_E_FAILOn failure
OPEN_E_UNAVAILIPv6 requested but support is unavailable
Note
Search for next range starts at vlanEnd + 1. To begin a search, set vlanEnd to 0. To search the next following range, vlanEnd should be set to the vlanEnd returned by the previous call. See example code for more details.

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingIntfLoggedGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
uint32_t  ifNum,
OPEN_BOOL_t logged 
)

Determines whether DHCP snooping logs invalid packets on an interface.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[in]ifNumInternal interface number
[out]loggedOPEN_TRUE if invalid packets logged for interface, else OPEN_FALSE
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure
OPEN_E_UNAVAILIPv6 requested but support is unavailable

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingIntfTrustedGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
uint32_t  ifNum,
OPEN_BOOL_t trusted 
)

Determines whether DHCP snooping considers an interface as trusted.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[in]ifNumInternal interface number
[out]trustedOPEN_TRUE if trusted, else OPEN_FALSE
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure
OPEN_E_UNAVAILIPv6 requested but support is unavailable

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingPortEnabledGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
uint32_t  ifNum,
OPEN_CONTROL_t enabled 
)

Determines whether DHCP snooping is enabled on a port.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[in]ifNumInternal interface number
[out]enabledOPEN_ENABLE if DHCP snooping is enabled on port, else OPEN_DISABLE
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure
OPEN_E_UNAVAILIPv6 requested but support is unavailable
Note
DHCP snooping is considered enabled on a port if DHCP snooping is enabled on one or more VLANs the port participates in.

OpEN API Version: 1.18

open_error_t openapiDhcpSnoopingVerifySourceMacGet ( openapiClientHandle_t client_handle,
OPEN_AF_t  family,
OPEN_CONTROL_t sourceMacVerify 
)

Gets whether DHCP snooping verifies source MAC addresses.

Parameters
[in]client_handleClient handle from registration API
[in]familyOPEN_AF_INET or OPEN_AF_INET6
[out]sourceMacVerifyIf OPEN_ENABLE, source MAC addresses verified, otherwise OPEN_DISABLE
Return values
OPEN_E_NONEOn success
OPEN_E_PARAMInvalid parameter
OPEN_E_FAILOn failure
OPEN_E_UNAVAILIPv6 requested but support is unavailable
Note
When MAC verify is enabled (and port security is enabled on the interface), DHCP snooping tells the hardware to drop any incoming frames on the interface if the source MAC is not the MAC address for a DHCP client who has been leased an IP address.

OpEN API Version: 1.18