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.
open_error_t	openapiDhcpSnoopingDbFileNameGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, open_buffdesc *fileName)
	Get the remote DHCP snooping database file name.
open_error_t	openapiDhcpSnoopingDbFileNameMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *len)
	Get the remote DHCP snooping database file name max length.
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.
open_error_t	openapiDhcpSnoopingDbWriteDelayGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t *delay)
	Get the DHCP snooping database write delay.
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.
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.
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.
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.
open_error_t	openapiDhcpSnoopingVerifySourceMacGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, OPEN_CONTROL_t *sourceMacVerify)
	Gets whether DHCP snooping verifies source MAC addresses.

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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[out]	adminMode	DHCP snooping admin mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	IPv6 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[out]	fileName	Remote DHCP snooping DB file name
	-	Minimum allowed value of buffer length is iobtainable by calling openapiDhcpSnoopingFileNameMaxLengthGet()

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On 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_handle	Client handle from registration API
[out]	len	Maximum length of filename including NULL.

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[out]	addr	Remote DHCP snooping DB IP Address

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[out]	Write	delay in seconds.

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[out]	vlanStart	Low end of VLAN range
[in,out]	vlanEnd	High end of VLAN range

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_NOT_FOUND	No further VLANs beyond vlanEnd
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	IPv6 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[in]	ifNum	Internal interface number
[out]	logged	OPEN_TRUE if invalid packets logged for interface, else OPEN_FALSE

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	IPv6 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[in]	ifNum	Internal interface number
[out]	trusted	OPEN_TRUE if trusted, else OPEN_FALSE

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	IPv6 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[in]	ifNum	Internal interface number
[out]	enabled	OPEN_ENABLE if DHCP snooping is enabled on port, else OPEN_DISABLE

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	IPv6 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_handle	Client handle from registration API
[in]	family	OPEN_AF_INET or OPEN_AF_INET6
[out]	sourceMacVerify	If OPEN_ENABLE, source MAC addresses verified, otherwise OPEN_DISABLE

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	IPv6 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