Enumerations
enum	OPEN_AUTHMGR_HOST_CONTROL_t { OPEN_AUTHMGR_INVALID_HOST_MODE = 0, OPEN_AUTHMGR_SINGLE_AUTH_MODE = 1, OPEN_AUTHMGR_MULTI_HOST_MODE = 2, OPEN_AUTHMGR_MULTI_DOMAIN_AUTH_MODE = 3, OPEN_AUTHMGR_MULTI_AUTH_MODE = 4, OPEN_AUTHMGR_MULTI_DOMAIN_HOST_MODE = 5 }

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 }

enum	OPEN_DOT1X_APM_STATES_t { OPEN_DOT1X_APM_INITIALIZE = 1, OPEN_DOT1X_APM_DISCONNECTED = 2, OPEN_DOT1X_APM_CONNECTING = 3, OPEN_DOT1X_APM_AUTHENTICATING = 4, OPEN_DOT1X_APM_AUTHENTICATED = 5, OPEN_DOT1X_APM_ABORTING = 6, OPEN_DOT1X_APM_HELD = 7, OPEN_DOT1X_APM_FORCE_AUTH = 8, OPEN_DOT1X_APM_FORCE_UNAUTH = 9 }

enum	OPEN_DOT1X_BAM_STATES_t { OPEN_DOT1X_BAM_REQUEST = 1, OPEN_DOT1X_BAM_RESPONSE = 2, OPEN_DOT1X_BAM_SUCCESS = 3, OPEN_DOT1X_BAM_FAIL = 4, OPEN_DOT1X_BAM_TIMEOUT = 5, OPEN_DOT1X_BAM_IDLE = 6, OPEN_DOT1X_BAM_INITIALIZE = 7 }

enum	OPEN_DOT1X_PORT_CONTROL_t { OPEN_DOT1X_PORT_FORCE_UNAUTHORIZED = 1, OPEN_DOT1X_PORT_AUTO = 2, OPEN_DOT1X_PORT_FORCE_AUTHORIZED = 3, OPEN_DOT1X_PORT_NA = 4 }

enum	OPEN_DOT1X_PORT_STATUS_t { OPEN_DOT1X_PORT_STATUS_AUTHORIZED = 1, OPEN_DOT1X_PORT_STATUS_UNAUTHORIZED = 2, OPEN_DOT1X_PORT_STATUS_NA = 3 }

enum	OPEN_DOT1X_VLAN_ASSIGNED_MODE_t { OPEN_DOT1X_DEFAULT_ASSIGNED_VLAN = 1, OPEN_DOT1X_RADIUS_ASSIGNED_VLAN = 2, OPEN_DOT1X_UNAUTHENTICATED_VLAN = 3, OPEN_DOT1X_GUEST_VLAN = 4, OPEN_DOT1X_VOICE_VLAN = 5, OPEN_DOT1X_MONITOR_MODE_VLAN = 6, OPEN_DOT1X_NOT_ASSIGNED = 7 }

Functions
open_error_t	openapiAuthMgrAdminModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t mode)
	Gets the authentication manager global administrative mode.

open_error_t	openapiAuthMgrAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets the authentication manager global administrative mode.

open_error_t	openapiAuthMgrAuthenticationHostModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_AUTHMGR_HOST_CONTROL_t mode)
	Gets the authentication host mode for the specified interface.

open_error_t	openapiAuthMgrAuthenticationHostModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_HOST_CONTROL_t mode)
	Sets the authentication host mode for the specified interface.

open_error_t	openapiAuthMgrAuthenticationPeriodicGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_BOOL_t val)
	Gets the authentication periodic (reauth) enabled status for the specified interface.

open_error_t	openapiAuthMgrAuthenticationPeriodicSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t val)
	Sets the authentication periodic (reauth) enabled status for the specified interface.

open_error_t	openapiAuthMgrAuthenticationReAuthPeriodFromServerSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t val)
	Sets the flag to get reauthentication period from server/user for the specified interface.

open_error_t	openapiAuthMgrAuthenticationReAuthPeriodGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t val)
	Gets the reauthentication period for the specified interface.

open_error_t	openapiAuthMgrAuthenticationReAuthPeriodServerGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_BOOL_t val)
	Gets the flag to get reauthentication period from server/user for the specified interface.

open_error_t	openapiAuthMgrAuthenticationReAuthPeriodSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Sets the reauthentication period for the specified interface.

open_error_t	openapiDot1xDefaultAuthenMethodGet (openapiClientHandle_t client_handle, OPEN_USER_MGR_AUTH_METHOD_t method)
	Gets the dot1x default authentication method.

open_error_t	openapiDot1xDefaultAuthenMethodSet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTH_METHOD_t method)
	Sets the dot1x default authentication method.

open_error_t	openapiDot1xLogicalPortFirstGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t logicalIfNum)
	Gets the first dot1x logical interface identifier for a given physical port.

open_error_t	openapiDot1xLogicalPortNextGet (openapiClientHandle_t client_handle, uint32_t logicalIfNum, uint32_t nextLogicalIfNum)
	Gets the next dot1x logical interface identifier on the same physical port as the given logical interface identifier.

open_error_t	openapiDot1xLogicalPortSupplicantMacAddrGet (openapiClientHandle_t client_handle, uint32_t logicalIfNum, open_buffdesc macAddr)
	Gets the MAC address of the dot1x supplicant present on the specified logical interface.

open_error_t	openapiDot1xLogicalPortVlanAssignmentGet (openapiClientHandle_t client_handle, uint32_t logicalIfNum, uint32_t vlan, OPEN_DOT1X_VLAN_ASSIGNED_MODE_t *reason)
	Gets the dot1x assigned VLAN ID and reason for the specified logical interface.

open_error_t	openapiDot1xPortBackendAuthStateGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_DOT1X_BAM_STATES_t state)
	Gets the dot1x port back end authorization state.

open_error_t	openapiDot1xPortControlModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t mode)
	Gets the dot1x port configured control mode.

open_error_t	openapiDot1xPortControlModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t mode)
	Sets the dot1x port configured control mode.

open_error_t	openapiDot1xPortGuestVlanGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t vlanId)
	Gets the dot1x port guest vlan ID.

open_error_t	openapiDot1xPortGuestVlanSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId)
	Sets the dot1x port guest vlan ID.

open_error_t	openapiDot1xPortMabEnabledGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_BOOL_t mabEnabled)
	Sets the dot1x port MAC authentication bypass enable mode.

open_error_t	openapiDot1xPortMabEnabledSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mabEnabled)
	Sets the dot1x port MAC authentication bypass enable mode.

open_error_t	openapiDot1xPortOperatingControlModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t mode)
	Gets the dot1x port operating control mode.

open_error_t	openapiDot1xPortOperationalMabModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Gets the dot1x port operational MAB mode.

open_error_t	openapiDot1xPortPaeStateGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_DOT1X_APM_STATES_t state)
	Gets the dot1x port PAE state.

open_error_t	openapiDot1xPortStatusGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_STATUS_t status)
	Gets the dot1x port status.

open_error_t	openapiDot1xPortVlanAssignedGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t vlan)
	Gets the dot1x port assigned VLAN.

open_error_t	openapiDot1xPortVlanAssignedReasonGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_DOT1X_VLAN_ASSIGNED_MODE_t reason)
	Gets the dot1x port assigned VLAN reason.

open_error_t	openapiDot1xSystemAuthControlModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t mode)
	Gets the dot1x global administrative mode.

open_error_t	openapiDot1xSystemAuthControlModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets the dot1x global administrative mode.

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.

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.

Detailed Description

Function Documentation

open_error_t openapiAuthMgrAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Gets the authentication manager global administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Administrative mode

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

open_error_t openapiAuthMgrAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets the authentication manager global administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Administrative mode

Return values

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

OpEN API Version: 1.19

open_error_t openapiAuthMgrAuthenticationHostModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_HOST_CONTROL_t *	mode
	)

Gets the authentication host mode for the specified interface.

Parameters

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

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

open_error_t openapiAuthMgrAuthenticationHostModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_HOST_CONTROL_t	mode
	)

Sets the authentication host mode for the specified interface.

Parameters

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

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

open_error_t openapiAuthMgrAuthenticationPeriodicGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	val
	)

Gets the authentication periodic (reauth) enabled status for the specified interface.

Parameters

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

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

open_error_t openapiAuthMgrAuthenticationPeriodicSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	val
	)

Sets the authentication periodic (reauth) enabled status for the specified interface.

Parameters

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

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

open_error_t openapiAuthMgrAuthenticationReAuthPeriodFromServerSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	val
	)

Sets the flag to get reauthentication period from server/user for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[in]	val	Flag to get reauthentication period from server/user

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

open_error_t openapiAuthMgrAuthenticationReAuthPeriodGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Gets the reauthentication period for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	val	Reauthentication period

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

open_error_t openapiAuthMgrAuthenticationReAuthPeriodServerGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	val
	)

Gets the flag to get reauthentication period from server/user for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	val	Flag to get reauthentication period from server/user

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

open_error_t openapiAuthMgrAuthenticationReAuthPeriodSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	val
	)

Sets the reauthentication period for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[in]	val	Reauthentication period

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

open_error_t openapiDot1xDefaultAuthenMethodGet	(	openapiClientHandle_t *	client_handle,
		OPEN_USER_MGR_AUTH_METHOD_t *	method
	)

Gets the dot1x default authentication method.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	authentication method

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xDefaultAuthenMethodSet	(	openapiClientHandle_t *	client_handle,
		OPEN_USER_MGR_AUTH_METHOD_t	method
	)

Sets the dot1x default authentication method.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	authentication method

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xLogicalPortFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	logicalIfNum
	)

Gets the first dot1x logical interface identifier for a given physical port.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID for the physical port
[out]	logicalIfNum	logical interface identifier

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed or no logical port found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

open_error_t openapiDot1xLogicalPortNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	logicalIfNum,
		uint32_t *	nextLogicalIfNum
	)

Gets the next dot1x logical interface identifier on the same physical port as the given logical interface identifier.

Parameters

[in]	client_handle	client handle from registration API
[in]	logicalIfNum	logical interface identifier
[out]	nextLogicalIfNum	next logical interface identifier on the same physical port as the given logical interface identifier

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed or no next logical port found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

open_error_t openapiDot1xLogicalPortSupplicantMacAddrGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	logicalIfNum,
		open_buffdesc *	macAddr
	)

Gets the MAC address of the dot1x supplicant present on the specified logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	macAddr	supplicant's MAC address, buffdesc must provide at least OPEN_MAC_ADDR_LEN bytes of space

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xLogicalPortVlanAssignmentGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	logicalIfNum,
		uint32_t *	vlan,
		OPEN_DOT1X_VLAN_ASSIGNED_MODE_t *	reason
	)

Gets the dot1x assigned VLAN ID and reason for the specified logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	vlan	VLAN ID
[out]	reason	reason the VLAN was assigned

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xPortBackendAuthStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1X_BAM_STATES_t *	state
	)

Gets the dot1x port back end authorization state.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	state	State

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xPortControlModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1X_PORT_CONTROL_t *	mode
	)

Gets the dot1x port configured control mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	mode	control 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.14

open_error_t openapiDot1xPortControlModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1X_PORT_CONTROL_t	mode
	)

Sets the dot1x port configured control mode.

Parameters

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

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xPortGuestVlanGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	vlanId
	)

Gets the dot1x port guest vlan ID.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	vlanId	VLAN ID

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xPortGuestVlanSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	vlanId
	)

Sets the dot1x port guest vlan ID.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[in]	vlanId	VLAN ID

Return values

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

OpEN API Version: 1.14

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

Sets the dot1x 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.14

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

Sets the dot1x 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.14

open_error_t openapiDot1xPortOperatingControlModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1X_PORT_CONTROL_t *	mode
	)

Gets the dot1x port operating control mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	mode	Operating control 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.14

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

Gets the dot1x 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.14

open_error_t openapiDot1xPortPaeStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1X_APM_STATES_t *	state
	)

Gets the dot1x port PAE state.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	state	State

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xPortStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1X_PORT_STATUS_t *	status
	)

Gets the dot1x port status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	status	Status

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xPortVlanAssignedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	vlan
	)

Gets the dot1x port assigned VLAN.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	vlan	VLAN ID

Return values

OPEN_E_NONE	VLAN ID get successful.
OPEN_E_FAIL	VLAN ID get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

open_error_t openapiDot1xPortVlanAssignedReasonGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1X_VLAN_ASSIGNED_MODE_t *	reason
	)

Gets the dot1x port assigned VLAN reason.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	reason	Reason

Return values

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

OpEN API Version: 1.14

open_error_t openapiDot1xSystemAuthControlModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Gets the dot1x global administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Administrative 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.14

open_error_t openapiDot1xSystemAuthControlModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets the dot1x global administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Administrative mode

Return values

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

OpEN API Version: 1.14

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

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

Enumerations

Functions

Detailed Description

Function Documentation