DHCP Snooping API [OPENAPI_DHCP_SNOOPING]

Enumerations
enum	OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t { OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_DROP = 0, OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_KEEP = 1, OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_UPDATE = 2 }
	DHCP L2 relay option 82 actions. More...

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...
open_error_t	openapiDsL2RelayAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Gets the DHCP L2 Relay Admin mode. More...
open_error_t	openapiDsL2RelayAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Sets the DHCP L2 Relay Admin mode. More...
open_error_t	openapiDsL2RelayCircuitIdGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, OPEN_CONTROL_t *circuitIdMode)
	Gets the DHCP L2 Relay circuit-id mode for a vlan. More...
open_error_t	openapiDsL2RelayCircuitIdSet (openapiClientHandle_t *client_handle, uint32_t vlanNum, OPEN_CONTROL_t circuitIdMode)
	Sets the DHCP L2 Relay circuit-Id mode for a vlan. More...
open_error_t	openapiDsL2RelayIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *intfMode)
	Gets the DHCP L2 Relay interface mode. More...
open_error_t	openapiDsL2RelayIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t intfMode)
	Sets the DHCP L2 Relay interface mode. More...
open_error_t	openapiDsL2RelayIntfStatsClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Clears the DHCP L2 Relay interface specific statistics. More...
open_error_t	openapiDsL2RelayIntfStatsGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *untrustedSrvMsgsWithOpt82, uint32_t *untrustedCliMsgsWithOpt82, uint32_t *trustedSrvMsgsWithoutOpt82, uint32_t *trustedCliMsgsWithoutOpt82)
	Gets the DHCP L2 Relay interface specific statistics. More...
open_error_t	openapiDsL2RelayIntfTrustGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *trustMode)
	Get API for whether DHCP L2 relay considers a port trusted. More...
open_error_t	openapiDsL2RelayIntfTrustNoOption82ActionGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t *action)
	Fetch configured no-option-82 action on L2 relay trusted interfaces. More...
open_error_t	openapiDsL2RelayIntfTrustNoOption82ActionSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t action)
	Configure action for packets received without option-82 on L2 relay trusted interfaces. More...
open_error_t	openapiDsL2RelayIntfTrustSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t trustMode)
	Set API to configure a port in desired trust mode for DHCP l2 relay. More...
open_error_t	openapiDsL2RelayRemoteIdGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *remoteId)
	Gets the DHCP L2 Relay remote-id string for a vlan. More...
open_error_t	openapiDsL2RelayRemoteIdSet (openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *remoteId)
	Sets the DHCP L2 Relay remote-Id string for a vlan. More...
open_error_t	openapiDsL2RelaySubscriptionCircuitIdModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *subscriptionName, OPEN_CONTROL_t *l2RelayCIdMode)
	Gets the DHCP L2 Relay Circuit-id mode for a given subscription on an interface. More...
open_error_t	openapiDsL2RelaySubscriptionCircuitIdModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *subscriptionName, OPEN_CONTROL_t l2RelayCIdMode)
	Sets the DHCP L2 Relay Circuit-id mode for a given subscription on an interface. More...
open_error_t	openapiDsL2RelaySubscriptionModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *subscriptionName, OPEN_CONTROL_t *l2RelaySubMode)
	Gets the DHCP L2 Relay mode for a given subscription on an interface. More...
open_error_t	openapiDsL2RelaySubscriptionModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *subscriptionName, OPEN_CONTROL_t l2RelaySubMode)
	Sets the DHCP L2 Relay mode for a given subscription on an interface. More...
open_error_t	openapiDsL2RelaySubscriptionRemoteIdGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *subscriptionName, open_buffdesc *remoteId)
	Gets the DHCP L2 Relay Remote-id string for a given subscription on an interface. More...
open_error_t	openapiDsL2RelaySubscriptionRemoteIdSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *subscriptionName, open_buffdesc *remoteId)
	Sets the DHCP L2 Relay Remote-id string for a given subscription on an interface. More...
open_error_t	openapiDsL2RelayVlanModeGet (openapiClientHandle_t *client_handle, uint32_t vlanNum, OPEN_CONTROL_t *l2RelayMode)
	Gets the DHCP L2 Relay mode for a VLAN. More...
open_error_t	openapiDsL2RelayVlanModeSet (openapiClientHandle_t *client_handle, uint32_t vlanNum, OPEN_CONTROL_t l2RelayMode)
	Sets the DHCP L2 Relay mode for a vlan. More...
open_error_t	openapiDsL2RelayVlanRangeCircuitIdSet (openapiClientHandle_t *client_handle, uint32_t vlanStart, uint32_t vlanEnd, OPEN_CONTROL_t circuitIdMode)
	Sets the DHCP L2 Relay circuit-Id mode for a vlan range. More...
open_error_t	openapiDsL2RelayVlanRangeModeSet (openapiClientHandle_t *client_handle, uint32_t vlanStart, uint32_t vlanEnd, OPEN_CONTROL_t l2RelayMode)
	Sets the DHCP L2 Relay mode for a vlan range. More...
open_error_t	openapiDsL2RelayVlanRangeRemoteIdSet (openapiClientHandle_t *client_handle, uint32_t vlanStart, uint32_t vlanEnd, open_buffdesc *remoteId)
	Sets the DHCP L2 Relay remote-Id string for a vlan range. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t

DHCP L2 relay option 82 actions.

Enumerator
OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_DROP	Drop action.
OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_KEEP	This action is not supported.
OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_UPDATE	Update action.

Definition at line 46 of file openapi_dhcp_snooping.h.

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]	delay	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

open_error_t openapiDsL2RelayAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Gets the DHCP L2 Relay Admin mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	adminMode	DHCP L2 relay admin mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.25

open_error_t openapiDsL2RelayAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Sets the DHCP L2 Relay Admin mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	adminMode	DHCP L2 relay admin mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayCircuitIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanNum,
		OPEN_CONTROL_t *	circuitIdMode
	)

Gets the DHCP L2 Relay circuit-id mode for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanNum	VLAN number
[out]	circuitIdMode	DHCP L2 Relay Circuit-Id mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.25

open_error_t openapiDsL2RelayCircuitIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanNum,
		OPEN_CONTROL_t	circuitIdMode
	)

Sets the DHCP L2 Relay circuit-Id mode for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanNum	VLAN number
[in]	circuitIdMode	DHCP L2 Relay Circuit-Id mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayIntfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	intfMode
	)

Gets the DHCP L2 Relay interface mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Internal interface number
[out]	intfMode	DHCP L2 Relay interface mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.25

open_error_t openapiDsL2RelayIntfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	intfMode
	)

Sets the DHCP L2 Relay interface mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Internal interface number
[in]	intfMode	DHCP L2 Relay interface mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayIntfStatsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Clears the DHCP L2 Relay interface specific statistics.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayIntfStatsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	untrustedSrvMsgsWithOpt82,
		uint32_t *	untrustedCliMsgsWithOpt82,
		uint32_t *	trustedSrvMsgsWithoutOpt82,
		uint32_t *	trustedCliMsgsWithoutOpt82
	)

Gets the DHCP L2 Relay interface specific statistics.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[out]	untrustedSrvMsgsWithOpt82	L2 Relay un trusted server statistics.
[out]	untrustedCliMsgsWithOpt82	L2 Relay un trusted client statistics.
[out]	trustedSrvMsgsWithoutOpt82	L2 Relay trusted server statistics.
[out]	trustedCliMsgsWithoutOpt82	L2 Relay trusted client statistics.

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

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

Get API for whether DHCP L2 relay considers a port trusted.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Internal interface number
[out]	trustMode	OPEN_TRUE if port is trusted

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.25

open_error_t openapiDsL2RelayIntfTrustNoOption82ActionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t *	action
	)

Fetch configured no-option-82 action on L2 relay trusted interfaces.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[out]	action	drop/keep/update

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayIntfTrustNoOption82ActionSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t	action
	)

Configure action for packets received without option-82 on L2 relay trusted interfaces.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[in]	action	drop/keep/update

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

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

Set API to configure a port in desired trust mode for DHCP l2 relay.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Internal interface number
[in]	trustMode	OPEN_TRUE if port is trusted

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayRemoteIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanNum,
		open_buffdesc *	remoteId
	)

Gets the DHCP L2 Relay remote-id string for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanNum	VLAN number
[out]	remoteId	DHCP L2 Relay remote Id string

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayRemoteIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanNum,
		open_buffdesc *	remoteId
	)

Sets the DHCP L2 Relay remote-Id string for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanNum	VLAN number
[in]	remoteId	DHCP L2 Relay remote Id string

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelaySubscriptionCircuitIdModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	subscriptionName,
		OPEN_CONTROL_t *	l2RelayCIdMode
	)

Gets the DHCP L2 Relay Circuit-id mode for a given subscription on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[in]	subscriptionName	subscription name
[out]	l2RelayCIdMode	DHCP L2 Relay circuit-id mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.25

open_error_t openapiDsL2RelaySubscriptionCircuitIdModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	subscriptionName,
		OPEN_CONTROL_t	l2RelayCIdMode
	)

Sets the DHCP L2 Relay Circuit-id mode for a given subscription on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[in]	subscriptionName	subscription name
[in]	l2RelayCIdMode	DHCP L2 Relay circuit-id mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelaySubscriptionModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	subscriptionName,
		OPEN_CONTROL_t *	l2RelaySubMode
	)

Gets the DHCP L2 Relay mode for a given subscription on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[in]	subscriptionName	subscription name
[out]	l2RelaySubMode	DHCP L2 Relay mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.25

open_error_t openapiDsL2RelaySubscriptionModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	subscriptionName,
		OPEN_CONTROL_t	l2RelaySubMode
	)

Sets the DHCP L2 Relay mode for a given subscription on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[in]	subscriptionName	subscription name
[in]	l2RelaySubMode	DHCP L2 Relay mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelaySubscriptionRemoteIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	subscriptionName,
		open_buffdesc *	remoteId
	)

Gets the DHCP L2 Relay Remote-id string for a given subscription on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[in]	subscriptionName	subscription name
[out]	remoteId	DHCP L2 Relay remote-id string

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelaySubscriptionRemoteIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	subscriptionName,
		open_buffdesc *	remoteId
	)

Sets the DHCP L2 Relay Remote-id string for a given subscription on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	internal interface number
[in]	subscriptionName	subscription name
[in]	remoteId	DHCP L2 Relay remote-id string

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayVlanModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanNum,
		OPEN_CONTROL_t *	l2RelayMode
	)

Gets the DHCP L2 Relay mode for a VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanNum	VLAN number
[out]	l2RelayMode	DHCP L2 Relay mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.25

open_error_t openapiDsL2RelayVlanModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanNum,
		OPEN_CONTROL_t	l2RelayMode
	)

Sets the DHCP L2 Relay mode for a vlan.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanNum	VLAN number
[in]	l2RelayMode	DHCP L2 Relay mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayVlanRangeCircuitIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanStart,
		uint32_t	vlanEnd,
		OPEN_CONTROL_t	circuitIdMode
	)

Sets the DHCP L2 Relay circuit-Id mode for a vlan range.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanStart	Starting Vlan number
[in]	vlanEnd	Ending Vlan number
[in]	circuitIdMode	DHCP L2 Relay Circuit-Id mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayVlanRangeModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanStart,
		uint32_t	vlanEnd,
		OPEN_CONTROL_t	l2RelayMode
	)

Sets the DHCP L2 Relay mode for a vlan range.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanStart	Starting Vlan number
[in]	vlanEnd	Ending Vlan number
[in]	l2RelayMode	DHCP L2 Relay mode

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

open_error_t openapiDsL2RelayVlanRangeRemoteIdSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanStart,
		uint32_t	vlanEnd,
		open_buffdesc *	remoteId
	)

Sets the DHCP L2 Relay remote-Id string for a vlan range.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanStart	Starting Vlan number
[in]	vlanEnd	Ending Vlan number
[in]	remoteId	DHCP L2 Relay remote Id string

Return values

OPEN_E_NONE	On success
OPEN_E_PARAM	Invalid parameter
OPEN_E_FAIL	On failure
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25