IEEE 802.1x Configuration And Status [OPENAPI_DOT1X]

Enumerations
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_PAE_PORT_CAPABILITY { OPEN_DOT1X_PAE_PORT_NONE_CAPABLE = 0, OPEN_DOT1X_PAE_PORT_AUTH_CAPABLE }
	Port PAE capabilities. More...
enum	OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_t { OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_1 = 1, OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_2 = 2, OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_3 = 3 }
	Port protocol version. More...
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	openapiDot1xDefaultAuthenMethodGet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTH_METHOD_t *method)
	Gets the dot1x default authentication method. More...
open_error_t	openapiDot1xDefaultAuthenMethodSet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTH_METHOD_t method)
	Sets the dot1x default authentication method. More...
open_error_t	openapiDot1xEapolFloodModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
	Get eapol flood mode setting for dot1x. More...
open_error_t	openapiDot1xEapolFloodModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
	Set eapol flood mode setting for dot1x. More...
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. More...
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. More...
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. More...
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. More...
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. More...
open_error_t	openapiDot1xPortControlModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t *mode)
	Gets the dot1x port configured control mode. More...
open_error_t	openapiDot1xPortControlModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t mode)
	Sets the dot1x port configured control mode. More...
open_error_t	openapiDot1xPortEapLengthErrorFramesRxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapLengthErrorFramesRx)
	Get the dot1x port Eap Length error Frames Received Stat. More...
open_error_t	openapiDot1xPortEapolFramesRxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolFramesRx)
	Get the dot1x port Eapol Frames Received Stats. More...
open_error_t	openapiDot1xPortEapolFramesTxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolFramesTx)
	Get the dot1x port Eapol Frames Transmitted Stats. More...
open_error_t	openapiDot1xPortEapolLogoffFramesRxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolLogoffFramesRx)
	Get the dot1x port Eapol Logoff Frames Received Stat. More...
open_error_t	openapiDot1xPortEapolStartFramesRxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolStartFramesRx)
	Get the dot1x port Eapol Start Frames Received Stats. More...
open_error_t	openapiDot1xPortEapReqFramesTxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapReqFramesTx)
	Get the dot1x port Eap Request Frames Transmitted Stat. More...
open_error_t	openapiDot1xPortEapReqIdFramesTxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapReqIdFramesTx)
	Get the dot1x port Eap Request Id Frames Transmitted Stat. More...
open_error_t	openapiDot1xPortEapRespIdFramesRxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapRespIdFramesRx)
	Get number of EAP Response/Identity frames received. More...
open_error_t	openapiDot1xPortEapResponseFramesRxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapResponseFramesRx)
	Get the dot1x port Eap Response Frames Received Stat. More...
open_error_t	openapiDot1xPortGuestVlanGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanId)
	Gets the dot1x port guest vlan ID. More...
open_error_t	openapiDot1xPortGuestVlanSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId)
	Sets the dot1x port guest vlan ID. More...
open_error_t	openapiDot1xPortInvalidEapolFramesRxGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *invalidEapolFramesRx)
	Get the dot1x port Invalid Eapol Frames Received Stat. More...
open_error_t	openapiDot1xPortLastEapolFrameSourceGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, open_buffdesc *lastEapolFrameSource)
	Get the dot1x port Last Eapol Frame Source Stat. More...
open_error_t	openapiDot1xPortLastEapolFrameVersionGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *lastEapolFrameVersion)
	Get the dot1x port Last Eapol Frame Version Stat. More...
open_error_t	openapiDot1xPortMabEnabledGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mabEnabled)
	Sets the dot1x port MAC authentication bypass enable mode. More...
open_error_t	openapiDot1xPortMabEnabledSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mabEnabled)
	Sets the dot1x port MAC authentication bypass enable mode. More...
open_error_t	openapiDot1xPortMaxReAuthReqIdentityGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pMaxReAuthReqIndentity)
	Get the configured dot1x max reauth request-identity retries count on the specified port. More...
open_error_t	openapiDot1xPortMaxReAuthReqIdentitySet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t maxReAuthReqIndentity)
	Set the dot1x max reauth request-identity retries count on the specified port. More...
open_error_t	openapiDot1xPortMaxReqGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pMaxReq)
	Gets dot1x max requests on the specified port. More...
open_error_t	openapiDot1xPortMaxReqSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t maxReq)
	Sets the dot1x max requests on the specified port. More...
open_error_t	openapiDot1xPortOperatingControlModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t *mode)
	Gets the dot1x port operating control mode. More...
open_error_t	openapiDot1xPortOperationalMabModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Gets the dot1x port operational MAB mode. More...
open_error_t	openapiDot1xPortPaeCapabilitiesGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_DOT1X_PAE_PORT_CAPABILITY *pPaeCapability)
	Gets dot1x PAE capabilities on the specified port. More...
open_error_t	openapiDot1xPortPaeCapabilitiesSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_DOT1X_PAE_PORT_CAPABILITY paeCapability)
	Sets the port's dot1x capabilities (Supplicant or Authenticator). More...
open_error_t	openapiDot1xPortPaeStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_APM_STATES_t *state)
	Gets the dot1x port PAE state. More...
open_error_t	openapiDot1xPortProtocolVersionGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_t *pProtocolVersion)
	Gets dot1x protocol version on the specified port. More...
open_error_t	openapiDot1xPortQuietPeriodGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *quietPeriod)
	Get the dot1x quiet period on the specified port. More...
open_error_t	openapiDot1xPortQuietPeriodSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t quietPeriod)
	Set the dot1x quiet period on the specified port. More...
open_error_t	openapiDot1xPortServerTimeoutGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pServerTimeout)
	Gets dot1x Authentiation Server timeout on the specified port. More...
open_error_t	openapiDot1xPortServerTimeoutSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t serverTimeout)
	Sets the dot1x Authentiation server timeout on the specified port. More...
open_error_t	openapiDot1xPortStatsClear (openapiClientHandle_t *client_handle, uint32_t intIfNum)
	Clear the dot1x stats on the specified port. More...
open_error_t	openapiDot1xPortStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_STATUS_t *status)
	Gets the dot1x port status. More...
open_error_t	openapiDot1xPortSuppTimeoutGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pSuppTimeout)
	Gets dot1x supplicant timeout on the specified port. More...
open_error_t	openapiDot1xPortSuppTimeoutSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t suppTimeout)
	Sets the dot1x supplicant timeout on the specified port. More...
open_error_t	openapiDot1xPortTxPeriodGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *txPeriod)
	Get the dot1x transmit period on the specified port. More...
open_error_t	openapiDot1xPortTxPeriodSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t txPeriod)
	Set the dot1x transmit period on the specified port. More...
open_error_t	openapiDot1xPortVlanAssignedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlan)
	Gets the dot1x port assigned VLAN. More...
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. More...
open_error_t	openapiDot1xSystemAuthControlModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Gets the dot1x global administrative mode. More...
open_error_t	openapiDot1xSystemAuthControlModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets the dot1x global administrative mode. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_DOT1X_PAE_PORT_CAPABILITY

Port PAE capabilities.

Enumerator
OPEN_DOT1X_PAE_PORT_NONE_CAPABLE	None.
OPEN_DOT1X_PAE_PORT_AUTH_CAPABLE	Supplicant.

Definition at line 108 of file openapi_dot1x.h.

enum OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_t

Port protocol version.

Enumerator
OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_1	version 1 is the 2001 standard of 802.1x
OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_2	version 2 is the 2004 standard of 802.1x
OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_3	version 3 is the 2010 standard of 802.1x

Definition at line 100 of file openapi_dot1x.h.

Function Documentation

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]	method	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]	method	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 openapiDot1xEapolFloodModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get eapol flood mode setting for dot1x.

Parameters

[in]	client_handle	client handle from registration API
[out]	adminMode	Dot1x eapol flood mode [Enable/Disable]

Return values

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

Note

This API gets the eapol flood mode setting for dot1x

OpEN API Version: 1.25

open_error_t openapiDot1xEapolFloodModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Set eapol flood mode setting for dot1x.

Parameters

[in]	client_handle	client handle from registration API
[in]	adminMode	Dot1x eapol flood mode [Enable/Disable]

Return values

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

Note

This API sets the eapol flood mode setting for dot1x

OpEN API Version: 1.25

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]	logicalIfNum	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]	logicalIfNum	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 This API no longer supported, please use openapiAuthMgrLogicalPortVlanAssignmentGet instead

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.

Note

   This function is not supported from OpEN API version 1.26. port's Backend Authentication state is no longer supported.

OpEN API Version: 1.14 Deprecated OpEN API Version: 1.26

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 This API no longer supported, please use openapiAuthMgrPortControlModeGet instead

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 This API no longer supported, please use openapiAuthMgrPortControlModeSet instead

open_error_t openapiDot1xPortEapLengthErrorFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapLengthErrorFramesRx
	)

Get the dot1x port Eap Length error Frames Received Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapLengthErrorFramesRx	EAP length error frames

Return values

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

Note

This API gets the dot1x port Eap Length error Frames Received Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapolFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapolFramesRx
	)

Get the dot1x port Eapol Frames Received Stats.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapolFramesRx	EAPOL start frames received

Return values

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

Note

This API gets the dot1x port Eapol Frames Received Stats

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapolFramesTxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapolFramesTx
	)

Get the dot1x port Eapol Frames Transmitted Stats.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapolFramesTx	EAPOL frames transmitted

Return values

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

Note

This API gets the dot1x port Eapol Frames Transmitted Stats

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapolLogoffFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapolLogoffFramesRx
	)

Get the dot1x port Eapol Logoff Frames Received Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapolLogoffFramesRx	EAPOL logoff frames received

Return values

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

Note

This API gets the dot1x port Eapol Logoff Frames Received Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapolStartFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapolStartFramesRx
	)

Get the dot1x port Eapol Start Frames Received Stats.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapolStartFramesRx	EAPOL start frames received

Return values

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

Note

This API gets the dot1x port Eapol Start Frames Received Stats

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapReqFramesTxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapReqFramesTx
	)

Get the dot1x port Eap Request Frames Transmitted Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapReqFramesTx	EAP Request frames transmitted

Return values

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

Note

This API gets the dot1x port Eap Request Frames Transmitted Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapReqIdFramesTxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapReqIdFramesTx
	)

Get the dot1x port Eap Request Id Frames Transmitted Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapReqIdFramesTx	EAP Req/Id frames transmitted

Return values

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

Note

This API gets the dot1x port Eap Request Id Frames Transmitted Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapRespIdFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapRespIdFramesRx
	)

Get number of EAP Response/Identity frames received.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapRespIdFramesRx	EAP Resp/Id frames received

Return values

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

Note

This API gets the number of EAP Response/Identity frames received

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortEapResponseFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	eapResponseFramesRx
	)

Get the dot1x port Eap Response Frames Received Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	eapResponseFramesRx	EAP Response frames received

Return values

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

Note

This API gets the dot1x port Eap Response Frames Received Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

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 This API no longer supported, please use openapiAuthMgrPortGuestVlanGet instead

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 This API no longer supported, please use openapiAuthMgrPortGuestVlanSet instead

open_error_t openapiDot1xPortInvalidEapolFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	invalidEapolFramesRx
	)

Get the dot1x port Invalid Eapol Frames Received Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	invalidEapolFramesRx	Invalid EAPOL frames received

Return values

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

Note

This API gets the dot1x port Invalid Eapol Frames Received Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortLastEapolFrameSourceGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		open_buffdesc *	lastEapolFrameSource
	)

Get the dot1x port Last Eapol Frame Source Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	lastEapolFrameSource	last EAPOL version received

Return values

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

Note

This API gets the dot1x port Last Eapol Frame Source Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

open_error_t openapiDot1xPortLastEapolFrameVersionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	lastEapolFrameVersion
	)

Get the dot1x port Last Eapol Frame Version Stat.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	lastEapolFrameVersion	last EAPOL version received

Return values

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

Note

This API gets the dot1x port Last Eapol Frame Version Stat

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

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 This API no longer supported, please use openapiMabPortMabEnabledGet instead

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 This API no longer supported, please use openapiMabPortMabEnabledSet instead

open_error_t openapiDot1xPortMaxReAuthReqIdentityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	pMaxReAuthReqIndentity
	)

Get the configured dot1x max reauth request-identity retries count on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Internal interface number
[out]	pMaxReAuthReqIndentity	Maximum request-Identity count

Return values

OPEN_E_UNAVAIL	Operation unsupported.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches dot1x max reauth request-identity retries count on the specified port.

OpEN API Version: 1.26

open_error_t openapiDot1xPortMaxReAuthReqIdentitySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	maxReAuthReqIndentity
	)

Set the dot1x max reauth request-identity retries count on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	Internal interface number
[in]	maxReAuthReqIndentity	Maximum request-Identity value

Return values

OPEN_E_UNAVAIL	Operation unsupported.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets dot1x max reauth request-identity retries count on the specified port.

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

OpEN API Version: 1.26

open_error_t openapiDot1xPortMaxReqGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	pMaxReq
	)

Gets dot1x max requests on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	pMaxReq	Max requests value.

Return values

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

Note

This API fetches dot1x max requests value on the specified port.

OpEN API Version: 1.26

open_error_t openapiDot1xPortMaxReqSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	maxReq
	)

Sets the dot1x max requests on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	maxReq	Max requests value.

Return values

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

Note

This API sets the dot1x max requests on the specified port.

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

OpEN API Version: 1.26

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 This API no longer supported, please use openapiAuthMgrPortOperatingControlModeGet instead

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 This API no longer supported, please use openapiMabPortOperationalMabModeGet instead

open_error_t openapiDot1xPortPaeCapabilitiesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_DOT1X_PAE_PORT_CAPABILITY *	pPaeCapability
	)

Gets dot1x PAE capabilities on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	pPaeCapability	pae capabilities value.

Return values

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

Note

This API fetches dot1x PAE capabilities value on the specified port.

OpEN API Version: 1.26

open_error_t openapiDot1xPortPaeCapabilitiesSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_DOT1X_PAE_PORT_CAPABILITY	paeCapability
	)

Sets the port's dot1x capabilities (Supplicant or Authenticator).

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	paeCapability	Dot1x capabilities.

Return values

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

Note

This API sets port's dot1x capabilities (Supplicant or Authenticator).

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

OpEN API Version: 1.26

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 openapiDot1xPortProtocolVersionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_t *	pProtocolVersion
	)

Gets dot1x protocol version on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	pProtocolVersion	dot1x protocol version of specified port.

Return values

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

Note

This API fetches dot1x protocol version value on the specified port.

OpEN API Version: 1.26

open_error_t openapiDot1xPortQuietPeriodGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	quietPeriod
	)

Get the dot1x quiet period on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	quietPeriod	the uint value for the quiet period

Return values

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

Note

The quietPeriod is the initialization value for quietWhile,

which is a timer used by the Authenticator state machine

to define periods of time in which it will not attempt to

acquire a Supplicant.

OpEN API Version: 1.25

open_error_t openapiDot1xPortQuietPeriodSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	quietPeriod
	)

Set the dot1x quiet period on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	quietPeriod	the uint value for the quiet period

Return values

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

Note

The quietPeriod is the initialization value for quietWhile,

which is a timer used by the Authenticator state machine

to define periods of time in which it will not attempt to

acquire a Supplicant.

OpEN API Version: 1.25

open_error_t openapiDot1xPortServerTimeoutGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	pServerTimeout
	)

Gets dot1x Authentiation Server timeout on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	pServerTimeout	Authentication Server timeout value.

Return values

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

Note

This API fetches dot1x Authentiation Server timeout value on the specified port.

OpEN API Version: 1.26

open_error_t openapiDot1xPortServerTimeoutSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	serverTimeout
	)

Sets the dot1x Authentiation server timeout on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	serverTimeout	Authentication Server timeout value.

Return values

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

Note

This API sets the dot1x server timeout on the specified port.

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

OpEN API Version: 1.26

open_error_t openapiDot1xPortStatsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum
	)

Clear the dot1x stats on the specified port.

Parameters

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

Return values

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

Note

This API clears the dot1x stats on the specified port

OpEN API Version: 1.25

Examples:

dot1x_eap_stats_example.c.

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 This API no longer supported, please use openapiAuthMgrPortStatusGet instead

open_error_t openapiDot1xPortSuppTimeoutGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	pSuppTimeout
	)

Gets dot1x supplicant timeout on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	pSuppTimeout	Supplicant timeout value.

Return values

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

Note

This API fetches dot1x supplicant timeout value on the specified port.

OpEN API Version: 1.26

open_error_t openapiDot1xPortSuppTimeoutSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	suppTimeout
	)

Sets the dot1x supplicant timeout on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	suppTimeout	Supplicant timeout value.

Return values

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

Note

This API sets the dot1x supplicant timeout on the specified port.

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

OpEN API Version: 1.26

open_error_t openapiDot1xPortTxPeriodGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	txPeriod
	)

Get the dot1x transmit period on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	txPeriod	the uint value for the transmit period

Return values

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

Note

The txPeriod is the initialization value for txWhen,

which is a timer used by the Authenticator state machine

to determine when to send an EAPOL EAP Request/Identity

frame to the Supplicant.

OpEN API Version: 1.25

open_error_t openapiDot1xPortTxPeriodSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	txPeriod
	)

Set the dot1x transmit period on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	txPeriod	the uint value for the transmit period

Return values

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

Note

The txPeriod is the initialization value for txWhen,

which is a timer used by the Authenticator state machine

to determine when to send an EAPOL EAP Request/Identity

frame to the Supplicant.

OpEN API Version: 1.25

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 This API no longer supported, please use openapiAuthMgrPortVlanAssignedGet instead

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 This API no longer supported, please use openapiAuthMgrPortVlanAssignedReasonGet instead

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