Denial Of Service OpEN API [OPENAPI_DOS]

Functions
open_error_t	openapiDoSAutoModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets Auto denial of service protection mode. More...
open_error_t	openapiDoSAutoModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets Auto denial of service protection. More...
open_error_t	openapiDoSFirstFragModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets first fragment denial of service protection mode. More...
open_error_t	openapiDoSFirstFragModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets first fragment denial of service protection. More...
open_error_t	openapiDoSFirstFragSizeGet (openapiClientHandle_t *client_handle, uint32_t *pMinTCPHdrSize)
	Gets denial of service protection Minimum TCP Header Size. More...
open_error_t	openapiDoSFirstFragSizeSet (openapiClientHandle_t *client_handle, uint32_t minTCPHdrSize)
	Sets minimum TCP header size denial of service protection. More...
open_error_t	openapiDoSGlobalPingFloodingModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode, uint32_t *pParam)
	Gets ping flooding denial of service protection mode. More...
open_error_t	openapiDoSGlobalPingFloodingModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode, uint32_t param)
	Sets ping flooding denial of service protection. More...
open_error_t	openapiDoSGlobalSmurfAttackModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets Smurf denial of service protection mode. More...
open_error_t	openapiDoSGlobalSmurfAttackModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets preventing Smurf denial of service protection. More...
open_error_t	openapiDoSGlobalSynAckFloodingModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode, uint32_t *pParam)
	Gets preventing SynAck Flooding denial of service protection mode. More...
open_error_t	openapiDoSGlobalSynAckFloodingModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode, uint32_t param)
	Sets preventing SynAck Flooding denial of service protection. More...
open_error_t	openapiDoSICMPFragModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets ICMP Fragment denial of service protection mode. More...
open_error_t	openapiDoSICMPFragModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets ICMP Fragment denial of service protection. More...
open_error_t	openapiDoSICMPModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets ICMP denial of service protection mode. More...
open_error_t	openapiDoSICMPModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets ICMP denial of service protection. More...
open_error_t	openapiDoSICMPSizeGet (openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize)
	Gets denial of service protection maximum ICMP size. More...
open_error_t	openapiDoSICMPSizeSet (openapiClientHandle_t *client_handle, uint32_t maxICMPSize)
	Sets maximum ICMP size denial of service protection. More...
open_error_t	openapiDoSICMPv4SizeGet (openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize)
	Gets denial of service protection Maximum ICMPv4 payload size. More...
open_error_t	openapiDoSICMPv6ModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets ICMPv6 denial of service protection mode. More...
open_error_t	openapiDoSICMPv6ModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets ICMPv6 denial of service protection. More...
open_error_t	openapiDoSICMPv6SizeGet (openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize)
	Gets denial of service protection Maximum ICMPv6 payload size. More...
open_error_t	openapiDoSICMPv6SizeSet (openapiClientHandle_t *client_handle, uint32_t maxICMPv6Size)
	Sets maximum ICMPv6 size denial of service protection. More...
open_error_t	openapiDoSIntfPingFloodingModeGet (openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode, uint32_t *pParam)
	Gets ping flooding denial of service protection mode on an interface. More...
open_error_t	openapiDoSIntfPingFloodingModeSet (openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t mode, uint32_t param)
	Sets ping flooding denial of service protection on an interface. More...
open_error_t	openapiDoSIntfSmurfAttackModeGet (openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode)
	Gets Smurf denial of service protection mode on an interface. More...
open_error_t	openapiDoSIntfSmurfAttackModeSet (openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t mode)
	Sets preventing Smurf denial of service protection on an interface. More...
open_error_t	openapiDoSIntfSynAckFloodingModeGet (openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode, uint32_t *pParam)
	Gets SynAck Flooding denial of service protection mode on an interface. More...
open_error_t	openapiDoSL4PortModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets L4 Port denial of service protection mode. More...
open_error_t	openapiDoSL4PortModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets L4 Port denial of service protection. More...
open_error_t	openapiDoSPortDdisableModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets port D-disable state for denial of service protection. More...
open_error_t	openapiDoSPortDdisableModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets port D-disable for denial of service protection. More...
open_error_t	openapiDoSSIPDIPModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets source IP address=destination IP address (SIP=DIP) denial of service protection mode. More...
open_error_t	openapiDoSSIPDIPModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets source IP address=destination IP address (SIP=DIP) denial of service protection. More...
open_error_t	openapiDoSSMACDMACModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection mode. More...
open_error_t	openapiDoSSMACDMACModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection. More...
open_error_t	openapiDoSTCPFinUrgPshModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP FIN,URG and PSH denial of service protection mode. More...
open_error_t	openapiDoSTCPFinUrgPshModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP FIN,URG and PSH denial of service protection. More...
open_error_t	openapiDoSTCPFlagModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP flag denial of service protection mode. More...
open_error_t	openapiDoSTCPFlagModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP flag denial of service protection. More...
open_error_t	openapiDoSTCPFlagSeqModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP flag and sequence denial of service protection mode. More...
open_error_t	openapiDoSTCPFlagSeqModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP flag and sequence denial of service protection. More...
open_error_t	openapiDoSTCPFragModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP Fragment denial of service protection mode. More...
open_error_t	openapiDoSTCPFragModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP fragment denial of service protection. More...
open_error_t	openapiDoSTCPOffsetModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP Offset denial of service protection mode. More...
open_error_t	openapiDoSTCPOffsetModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP offset denial of service protection. More...
open_error_t	openapiDoSTCPPartialModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP Partial denial of service protection mode. More...
open_error_t	openapiDoSTCPPortModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP port denial of service protection mode. More...
open_error_t	openapiDoSTCPPortModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP port denial of service protection. More...
open_error_t	openapiDoSTCPSynFinModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP SYN and FIN denial of service protection mode. More...
open_error_t	openapiDoSTCPSynFinModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP SYN and FIN denial of service protection. More...
open_error_t	openapiDoSTCPSynModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets TCP SYN denial of service protection mode. More...
open_error_t	openapiDoSTCPSynModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets TCP SYN denial of service protection. More...
open_error_t	openapiDoSUDPPortModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets UDP port denial of service protection mode. More...
open_error_t	openapiDoSUDPPortModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets UDP port denial of service protection. More...
open_error_t	openapiDoSVlan0TaggedSnapDropModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets Vlan0 Tagged and SNAP Drop denial of service protection mode. More...
open_error_t	openapiDoSVlan0TaggedSnapDropModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets Vlan0 Tagged and SNAP Drop denial of service protection. More...

Detailed Description

Function Documentation

open_error_t openapiDoSAutoModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets Auto denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches Auto DoS mode

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSAutoModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets Auto denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets Auto DoS mode

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSFirstFragModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets first fragment denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches first fragment DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSFirstFragModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets first fragment denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets first fragment DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSFirstFragSizeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pMinTCPHdrSize
	)

Gets denial of service protection Minimum TCP Header Size.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMinTCPHdrSize	min TCP header size

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches DoS Minimum TCP Header Size

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSFirstFragSizeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	minTCPHdrSize
	)

Sets minimum TCP header size denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	minTCPHdrSize	min TCP header size

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets DoS minimum TCP header size

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSGlobalPingFloodingModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode,
		uint32_t *	pParam
	)

Gets ping flooding denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]
[out]	pParam	Param value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API get ping Flooding DoS Attack mode

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSGlobalPingFloodingModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode,
		uint32_t	param
	)

Sets ping flooding denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]
[in]	param	Param value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API enable/disable the mode for preventing ping Flooding DOS Attack on an interface.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSGlobalSmurfAttackModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets Smurf denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API gets Smurf DOS Attack mode.

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSGlobalSmurfAttackModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets preventing Smurf denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API enable/disable the mode for preventing Smurf DOS Attack

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSGlobalSynAckFloodingModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode,
		uint32_t *	pParam
	)

Gets preventing SynAck Flooding denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]
[out]	pParam	Param value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API gets SynAck Flooding DOS Attack mode.

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSGlobalSynAckFloodingModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode,
		uint32_t	param
	)

Sets preventing SynAck Flooding denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]
[in]	param	Param value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API enable/disable the mode for preventing SynAck Flooding DOS Attack.

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSICMPFragModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets ICMP Fragment denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches DoS ICMP Fragment mode

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSICMPFragModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets ICMP Fragment denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets ICMP Fragment DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSICMPModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets ICMP denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches ICMP DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSICMPModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets ICMP denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets ICMP DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSICMPSizeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pMaxICMPSize
	)

Gets denial of service protection maximum ICMP size.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMaxICMPSize	max ICMP size

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches DoS maximum ICMP size

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSICMPSizeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	maxICMPSize
	)

Sets maximum ICMP size denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	maxICMPSize	minimum ICMP size

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets DoS maximum ICMP size

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSICMPv4SizeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pMaxICMPSize
	)

Gets denial of service protection Maximum ICMPv4 payload size.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMaxICMPSize	Maximum ICMPv4 payload size

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches DoS Maximum ICMPv4 payload size

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSICMPv6ModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets ICMPv6 denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches DoS ICMPv6 mode

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSICMPv6ModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets ICMPv6 denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets DoS ICMPv6 mode to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSICMPv6SizeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pMaxICMPSize
	)

Gets denial of service protection Maximum ICMPv6 payload size.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMaxICMPSize	Maximum ICMPv6 payload size

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches DoS Maximum ICMPv6 payload size

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSICMPv6SizeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	maxICMPv6Size
	)

Sets maximum ICMPv6 size denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	maxICMPv6Size	minimum ICMPv6 size

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets DoS maximum ICMPv6 size

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSIntfPingFloodingModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	interface,
		OPEN_CONTROL_t *	pMode,
		uint32_t *	pParam
	)

Gets ping flooding denial of service protection mode on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	interface	interface number
[out]	pMode	Mode [Enable/Disable]
[out]	pParam	Param value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API get ping Flooding mode for an interface

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSIntfPingFloodingModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	interface,
		OPEN_CONTROL_t	mode,
		uint32_t	param
	)

Sets ping flooding denial of service protection on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	interface	interface number
[in]	mode	Mode [Enable/Disable]
[in]	param	Param value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API enable/disable the mode for preventing ping Flooding DOS Attack

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSIntfSmurfAttackModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	interface,
		OPEN_CONTROL_t *	pMode
	)

Gets Smurf denial of service protection mode on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	interface	interface number
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API gets Smurf DOS Attack mode for an interface

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSIntfSmurfAttackModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	interface,
		OPEN_CONTROL_t	mode
	)

Sets preventing Smurf denial of service protection on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	interface	interface number
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API enable/disable the mode for preventing Smurf DOS Attack

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSIntfSynAckFloodingModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	interface,
		OPEN_CONTROL_t *	pMode,
		uint32_t *	pParam
	)

Gets SynAck Flooding denial of service protection mode on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	interface	interface number
[out]	pMode	Mode [Enable/Disable]
[out]	pParam	Param value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API gets DoS SynAck Flooding mode for an interface

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSL4PortModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets L4 Port denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches L4 port DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSL4PortModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets L4 Port denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets L4 Port DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSPortDdisableModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets port D-disable state for denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches interface D-disable mode

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSPortDdisableModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets port D-disable for denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets enable/disable state for moving interface to D-disable state during DoS attack

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSSIPDIPModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets source IP address=destination IP address (SIP=DIP) denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches SIP=DIP DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSSIPDIPModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets source IP address=destination IP address (SIP=DIP) denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets SIP=DIP DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSSMACDMACModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches SMAC=DMAC DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSSMACDMACModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets SMAC=DMAC DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFinUrgPshModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP FIN,URG and PSH denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP FIN,URG and PSH DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFinUrgPshModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP FIN,URG and PSH denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP FIN,URG and PSH DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFlagModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP flag denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP flag DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFlagModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP flag denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP Flag DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFlagSeqModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP flag and sequence denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP flag and sequence DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFlagSeqModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP flag and sequence denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP flag and sequence DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFragModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP Fragment denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP Fragment DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPFragModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP fragment denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP Fragment DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPOffsetModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP Offset denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP Offset DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPOffsetModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP offset denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP Offset DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPPartialModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP Partial denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP Partial DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPPortModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP port denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP port DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPPortModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP port denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP port DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPSynFinModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP SYN and FIN denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP SYN and FIN DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPSynFinModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP SYN and FIN denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP SYN and FIN DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPSynModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets TCP SYN denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches TCP SYN DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSTCPSynModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets TCP SYN denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets TCP SYN DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSUDPPortModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets UDP port denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches UDP port DoS state

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSUDPPortModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets UDP port denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets UDP port DoS to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:

dos_example.c.

open_error_t openapiDoSVlan0TaggedSnapDropModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets Vlan0 Tagged and SNAP Drop denial of service protection mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches Vlan0 Tagged and SNAP Drop DoS mode

OpEN API Version: 1.25

Examples:

dos_example.c.

open_error_t openapiDoSVlan0TaggedSnapDropModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets Vlan0 Tagged and SNAP Drop denial of service protection.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets Vlan0 Tagged and SNAP Drop DoS mode

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

dos_example.c.