MAB Configuration And Status [OPENAPI_MAB]

Enumerations
enum	OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t { OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_INVALID = 0, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_EAP_MD5 = 1, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_PAP = 2, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_CHAP = 3 }

Functions
open_error_t	openapiMabPortMABAuthTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t *val)
	Gets the authentication host mode for the specified interface. More...
open_error_t	openapiMabPortMABAuthTypeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t val)
	Sets the authentication type to be used by MAB for the specified interface. More...
open_error_t	openapiMabPortMabEnabledGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mabEnabled)
	Sets the port MAC authentication bypass enable mode. More...
open_error_t	openapiMabPortMabEnabledSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mabEnabled)
	Sets the port MAC authentication bypass enable mode. More...
open_error_t	openapiMabPortOperationalMabModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Gets the port operational MAB mode. More...
open_error_t	openapiMabRequestAttribute2paramGet (openapiClientHandle_t *client_handle, open_buffdesc *password)
	Get password for MAB request attribute 2. More...
open_error_t	openapiMabRequestAttribute2paramSet (openapiClientHandle_t *client_handle, open_buffdesc *passwd, OPEN_BOOL_t encrypted)
	Set password for MAB request attribute 2. More...

Detailed Description

Function Documentation

open_error_t openapiMabPortMABAuthTypeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t *	val
	)

Gets the authentication host mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	val	Authentication type

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other internal failure.

OpEN API Version: 1.19

Examples:

mab_example.c.

open_error_t openapiMabPortMABAuthTypeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t	val
	)

Sets the authentication type to be used by MAB for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[in]	val	Authentication type

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other internal failure.

OpEN API Version: 1.19

Examples:

mab_example.c.

open_error_t openapiMabPortMabEnabledGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	mabEnabled
	)

Sets the port MAC authentication bypass enable mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	mabEnabled	OPEN_TRUE if MAB enabled, else OPEN_FALSE

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.25

Examples:

mab_example.c.

open_error_t openapiMabPortMabEnabledSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	mabEnabled
	)

Sets the port MAC authentication bypass enable mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[in]	mabEnabled	Set to OPEN_TRUE to enable MAB, OPEN_FALSE to disable

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.25

Examples:

mab_example.c.

open_error_t openapiMabPortOperationalMabModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Gets the port operational MAB mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	mode	Mode

Return values

OPEN_E_NONE	Mode get successful.
OPEN_E_FAIL	Mode get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.25

Examples:

mab_example.c.

open_error_t openapiMabRequestAttribute2paramGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	password
	)

Get password for MAB request attribute 2.

Parameters

[in]	client_handle	client handle from registration API
[out]	password	Attribute 2 password

Return values

OPEN_E_NONE	Password get is successful.
OPEN_E_FAIL	Unable to get password.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.26

Examples:

mab_example.c.

open_error_t openapiMabRequestAttribute2paramSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	passwd,
		OPEN_BOOL_t	encrypted
	)

Set password for MAB request attribute 2.

Parameters

[in]	client_handle	client handle from registration API
[in]	passwd	Attribute 2 password
[in]	encrypted	Password is in encrypted format or not

Return values

OPEN_E_NONE	Password set is successful.
OPEN_E_FAIL	Unable to set password.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.26

Examples:

mab_example.c.