Authentication Manager Configuration And Status [OPENAPI_AUTHMGR]

Macros
#define	OPEN_AUTHMGR_AUTH_HISTORY_TABLE_ENTRY_INDEX_MAX   0xFFFFFFFF
	OpEN uses this enumeration to define authentication manager states.
#define	OPEN_AUTHMGR_USER_NAME_LEN   65
	Max Unsigned Integer Value i.e. More...

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_METHOD_t { OPEN_AUTHMGR_METHOD_NONE = 0, OPEN_AUTHMGR_METHOD_8021X, OPEN_AUTHMGR_METHOD_MAB, OPEN_AUTHMGR_METHOD_CP }
enum	OPEN_AUTHMGR_METHOD_TYPE_t { OPEN_AUTHMGR_TYPE_ORDER = 1, OPEN_AUTHMGR_TYPE_PRIORITY }
enum	OPEN_AUTHMGR_PORT_CONTROL_t { OPEN_AUTHMGR_PORT_FORCE_UNAUTHORIZED = 1, OPEN_AUTHMGR_PORT_AUTO = 2, OPEN_AUTHMGR_PORT_FORCE_AUTHORIZED = 3, OPEN_AUTHMGR_PORT_NA = 4 }
enum	OPEN_AUTHMGR_PORT_DIRECTION_t { OPEN_AUTHMGR_PORT_DIRECTION_INVALID = 0, OPEN_AUTHMGR_PORT_DIRECTION_BOTH, OPEN_AUTHMGR_PORT_DIRECTION_IN }
	Port controlled directions. More...
enum	OPEN_AUTHMGR_PORT_STATUS_t { OPEN_AUTHMGR_PORT_STATUS_NA = 0, OPEN_AUTHMGR_PORT_STATUS_AUTHORIZED, OPEN_AUTHMGR_PORT_STATUS_UNAUTHORIZED }
enum	OPEN_AUTHMGR_STATES_t {   OPEN_AUTHMGR_INITIALIZE = 0, OPEN_AUTHMGR_AUTHENTICATING, OPEN_AUTHMGR_AUTHENTICATED, OPEN_AUTHMGR_HELD,   OPEN_AUTHMGR_UNAUTHENTICATED, OPEN_AUTHMGR_STATES }
enum	OPEN_AUTHMGR_TERMINATION_ACTION_t { OPEN_AUTHMGR_TERMINATION_ACTION_DEFAULT = 1, OPEN_AUTHMGR_TERMINATION_ACTION_RADIUS }
enum	OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t {   OPEN_AUTHMGR_NOT_ASSIGNED = 0, OPEN_AUTHMGR_DEFAULT_ASSIGNED_VLAN, OPEN_AUTHMGR_RADIUS_ASSIGNED_VLAN, OPEN_AUTHMGR_UNAUTHENTICATED_VLAN,   OPEN_AUTHMGR_GUEST_VLAN, OPEN_AUTHMGR_VOICE_VLAN, OPEN_AUTHMGR_MONITOR_MODE_VLAN, OPEN_AUTHMGR_CRITICAL_VLAN }

Functions
open_error_t	openapiAuthMgrAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Gets the authentication manager global administrative mode. More...
open_error_t	openapiAuthMgrAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets the authentication manager global administrative mode. More...
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. More...
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. More...
open_error_t	openapiAuthMgrAuthenticationInActivityPeriodGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Gets the inactivity period for the specified interface. More...
open_error_t	openapiAuthMgrAuthenticationInActivityPeriodSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Sets the inactivity period for the specified interface. More...
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. More...
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. More...
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. More...
open_error_t	openapiAuthMgrAuthenticationReAuthPeriodFromSeverGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *reAuthPeriod)
	Get the reauthentication status which is coonfigured on the radius server. More...
open_error_t	openapiAuthMgrAuthenticationReAuthPeriodGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Gets the reauthentication period for the specified interface. More...
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. More...
open_error_t	openapiAuthMgrAuthenticationReAuthPeriodSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Sets the reauthentication period for the specified interface. More...
open_error_t	openapiAuthMgrDynamicVlanCreationModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dynamicVlanMode)
	Get the authentication manager Dynamic Vlan Creation Mode. More...
open_error_t	openapiAuthMgrDynamicVlanCreationModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dynamicVlanMode)
	Set the authentication manager Dynamic Vlan Creation Mode. More...
open_error_t	openapiAuthMgrEnabledMethodGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method)
	Get the Enabled method order. More...
open_error_t	openapiAuthMgrEnabledPriorityGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method)
	Get the Enabled method priority. More...
open_error_t	openapiAuthMgrHistoryLogAuthStatusGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, OPEN_AUTHMGR_PORT_STATUS_t *authStatus)
	Gets the client authenticated status from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogClientMacAddressGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, open_buffdesc *macAddress)
	Gets the client MAC address from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogEntryIsValid (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex)
	Checks if the authentication manager history log entry exists in history table. More...
open_error_t	openapiAuthMgrHistoryLogFilterIdGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, open_buffdesc *filterId)
	Gets the filter ID from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogIndexNextGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum, uint32_t *entryIndex)
	Gets the authentication manager next History Log interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogInterfacePurge (openapiClientHandle_t *client_handle, uint32_t intIfNum)
	Purges all authentication manager auth history log entries for a given interface. More...
open_error_t	openapiAuthMgrHistoryLogMethodGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, OPEN_AUTHMGR_METHOD_t *method)
	Gets the authentication method from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogPurgeAll (openapiClientHandle_t *client_handle)
	Purges all authentication manager auth history log entries. More...
open_error_t	openapiAuthMgrHistoryLogReasonCodeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, uint32_t *reasonCode)
	Gets the reason code from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogReasonStringGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, uint32_t reasonCode, open_buffdesc *reason)
	Gets the reason code in string format from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogReverseIndexNextGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum, uint32_t *entryIndex)
	Gets the authentication manager next History Log interface and entry index in reverse order. More...
open_error_t	openapiAuthMgrHistoryLogTimestampGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, open_buffdesc *timeStamp)
	Gets the time stamp from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogVlanAssignedTypeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *vlanAssignedType)
	Gets the VLAN assigned type from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrHistoryLogVlanIdGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t entryIndex, uint32_t *vlanId)
	Gets the VLAN ID from the authentication manager auth history table for a given interface and entry index. More...
open_error_t	openapiAuthMgrLogicalPortClientAuthenticatedMethodGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_AUTHMGR_METHOD_t *method)
	Get the client authenticated Method for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortClientAuthStateGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_AUTHMGR_STATES_t *authState)
	Get the client reauth state for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortClientAuthStatusGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_AUTHMGR_PORT_STATUS_t *authStatus)
	Get the client authenticated Status for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortClientMacAddrGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, open_buffdesc *macAddrBuffDesc)
	Get the client/supplicant Mac address for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortClientReauthStateGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_CONTROL_t *reauthState)
	Get the client reauthenticating state for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortClientVlanTypeGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *vlanType)
	Get the authenticated client vlan type (data/voice) for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortFilterIdGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, open_buffdesc *filterId)
	Get the filter id for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortFirstGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *firstlIntIfNum)
	Gets the first logical port in use for the physcial interface. More...
open_error_t	openapiAuthMgrLogicalPortNextGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *nextlIntIfNum)
	Gets the next logical port for the physcial interface. More...
open_error_t	openapiAuthMgrLogicalPortSessionTimeGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *sessionTime)
	Get Logical port Session time. More...
open_error_t	openapiAuthMgrLogicalPortSessionTimeoutGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *sessionTimeout)
	Get the session timeout value for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortTerminationActionGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *terminationAction)
	Get the logical port termination action value. More...
open_error_t	openapiAuthmgrLogicalPortTimeLeftForTerminateActionGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *timeLeft)
	Get the time left for the session termination action to occur for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortUserNameGet (openapiClientHandle_t *client_handle, uint32_t lIntIfNum, open_buffdesc *userName)
	Get the client username for the logical interface. More...
open_error_t	openapiAuthMgrLogicalPortVlanAssignmentGet (openapiClientHandle_t *client_handle, uint32_t logicalIfNum, uint32_t *vlan, OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *reason)
	Gets the authentication manager assigned VLAN ID and reason for the specified logical interface. More...
open_error_t	openapiAuthMgrNumClientsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *clientsCount)
	Get the number of clients authenticated. More...
open_error_t	openapiAuthMgrPortAdminControlledDirectionsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_AUTHMGR_PORT_DIRECTION_t *pCntrlDir)
	Gets Auth manager admin control direction on the specified port. More...
open_error_t	openapiAuthMgrPortAdminControlledDirectionsSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_AUTHMGR_PORT_DIRECTION_t cntrlDir)
	Sets the authentication admin control direction on the specified port. More...
open_error_t	openapiAuthMgrPortAuthMethodOrderGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method)
	Get authentication manager method order. More...
open_error_t	openapiAuthMgrPortAuthMethodOrderSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t method)
	Set authentication manager method order. More...
open_error_t	openapiAuthMgrPortAuthMethodPriorityGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method)
	Get authentication manager method priority. More...
open_error_t	openapiAuthMgrPortAuthMethodPrioritySet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t method)
	Set authentication manager method priority. More...
open_error_t	openapiAuthMgrPortControlModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_CONTROL_t *mode)
	Gets the authentication manager port configured control mode. More...
open_error_t	openapiAuthMgrPortControlModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_CONTROL_t mode)
	Sets the authentication manager port configured control mode. More...
open_error_t	openapiAuthMgrPortGuestVlanGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanId)
	Get the Authentication guest vlan Id. More...
open_error_t	openapiAuthMgrPortGuestVlanSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId)
	Set the Authentication Server Alive action. More...
open_error_t	openapiAuthMgrPortInitializeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t initialize)
	To initialize (or) re-authenticate the specific interface. More...
open_error_t	openapiAuthMgrPortMaxAuthAttemptsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *maxAuthAttempts)
	Get the max number of failed authentication attempts value on the specified port. More...
open_error_t	openapiAuthMgrPortMaxAuthAttemptsSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t maxAuthAttempts)
	Set the max number of failed authentication attempts value on the specified port. More...
open_error_t	openapiAuthMgrPortMaxUsersGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *maxUsers)
	Get the max users of the port. More...
open_error_t	openapiAuthMgrPortMaxUsersSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t maxUsers)
	Set the max users for the port. More...
open_error_t	openapiAuthMgrPortOperatingControlModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_CONTROL_t *mode)
	Gets the authentication manager port operating control mode. More...
open_error_t	openapiAuthMgrPortStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_STATUS_t *status)
	Gets the authentication manager port status. More...
open_error_t	openapiAuthMgrPortUnauthenticatedVlanGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *vlanId)
	Get the Authentication fail action (Unauthenticated vlan) value. More...
open_error_t	openapiAuthMgrPortUnauthenticatedVlanSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t vlanId)
	Set the Authentication fail action (Unauthenticated vlan) value. More...
open_error_t	openapiAuthMgrPortVlanAssignedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlan)
	Gets the authentication manager port assigned VLAN. More...
open_error_t	openapiAuthMgrPortVlanAssignedReasonGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *reason)
	Gets the authentication manager port assigned VLAN reason. More...
open_error_t	openapiAuthMgrVlanAssignmentModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *vlanAssignmentMode)
	Get the authentication manager Vlan Assignment Mode. More...
open_error_t	openapiAuthMgrVlanAssignmentModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t vlanAssignmentMode)
	Set the authentication manager Vlan Assignment Mode. More...
open_error_t	openapiDbAuthMgrAuthenticationReAuthPeriodGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *reAuthPeriod)
	Get the reauthentication period on the specified port. More...

Detailed Description

Macro Definition Documentation

#define OPEN_AUTHMGR_USER_NAME_LEN   65

Max Unsigned Integer Value i.e.

; (2 ^ 16)-1 or (2 ^ 32)-1

Examples:

authmgr_example.c.

Definition at line 43 of file openapi_authmgr.h.

Enumeration Type Documentation

enum OPEN_AUTHMGR_HOST_CONTROL_t

Enumerator
OPEN_AUTHMGR_INVALID_HOST_MODE	None.
OPEN_AUTHMGR_SINGLE_AUTH_MODE	SINGLE-AUTH.
OPEN_AUTHMGR_MULTI_HOST_MODE	MULTI-HOST.
OPEN_AUTHMGR_MULTI_DOMAIN_AUTH_MODE	MULTI-DOMAIN.
OPEN_AUTHMGR_MULTI_AUTH_MODE	MULTI-AUTH.
OPEN_AUTHMGR_MULTI_DOMAIN_HOST_MODE	MULTI-DOMAIN-MULTI-HOST.

Definition at line 112 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_METHOD_t

Enumerator
OPEN_AUTHMGR_METHOD_NONE	Undefined.
OPEN_AUTHMGR_METHOD_8021X	802.1X
OPEN_AUTHMGR_METHOD_MAB	MAB.
OPEN_AUTHMGR_METHOD_CP	Captive-Portal.

Definition at line 66 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_METHOD_TYPE_t

Enumerator
OPEN_AUTHMGR_TYPE_ORDER	ORDER.
OPEN_AUTHMGR_TYPE_PRIORITY	PRIORITY.

Definition at line 59 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_PORT_CONTROL_t

Enumerator
OPEN_AUTHMGR_PORT_FORCE_UNAUTHORIZED	FORCE-AUTHORIZED.
OPEN_AUTHMGR_PORT_AUTO	AUTO.
OPEN_AUTHMGR_PORT_FORCE_AUTHORIZED	FORCE_UNAUTHORIZED.
OPEN_AUTHMGR_PORT_NA	None.

Definition at line 103 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_PORT_DIRECTION_t

Port controlled directions.

Enumerator
OPEN_AUTHMGR_PORT_DIRECTION_INVALID	Invalid.
OPEN_AUTHMGR_PORT_DIRECTION_BOTH	Both direction.
OPEN_AUTHMGR_PORT_DIRECTION_IN	In direction.

Definition at line 123 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_PORT_STATUS_t

Enumerator
OPEN_AUTHMGR_PORT_STATUS_NA	None.
OPEN_AUTHMGR_PORT_STATUS_AUTHORIZED	AUTHORIZED.
OPEN_AUTHMGR_PORT_STATUS_UNAUTHORIZED	UNAUTHORIZED.

Definition at line 75 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_STATES_t

Enumerator
OPEN_AUTHMGR_AUTHENTICATING	AUTHENTICATING.
OPEN_AUTHMGR_AUTHENTICATED	AUTHENTICATED.
OPEN_AUTHMGR_HELD	HELD.
OPEN_AUTHMGR_UNAUTHENTICATED	UNAUTHENTICATED.
OPEN_AUTHMGR_STATES	None.

Definition at line 48 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_TERMINATION_ACTION_t

Enumerator
OPEN_AUTHMGR_TERMINATION_ACTION_DEFAULT	DEFAULT.
OPEN_AUTHMGR_TERMINATION_ACTION_RADIUS	RADIUS.

Definition at line 96 of file openapi_authmgr.h.

enum OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t

Enumerator
OPEN_AUTHMGR_NOT_ASSIGNED	None.
OPEN_AUTHMGR_DEFAULT_ASSIGNED_VLAN	DEFAULT ASSIGNED VLAN.
OPEN_AUTHMGR_RADIUS_ASSIGNED_VLAN	RADIUS ASSIGNED VLAN.
OPEN_AUTHMGR_UNAUTHENTICATED_VLAN	UNAUTHENTICATED VLAN.
OPEN_AUTHMGR_GUEST_VLAN	GUEST VLAN.
OPEN_AUTHMGR_VOICE_VLAN	VOICE VLAN.
OPEN_AUTHMGR_MONITOR_MODE_VLAN	MONITOR VLAN.
OPEN_AUTHMGR_CRITICAL_VLAN	CRITICAL VLAN.

Definition at line 83 of file openapi_authmgr.h.

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

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

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

Gets the inactivity period for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[out]	val	inactivity 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.27

Examples:

authmgr_example.c.

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

Sets the inactivity period for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface ID
[in]	val	inactivity 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.27

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrAuthenticationReAuthPeriodFromSeverGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	reAuthPeriod
	)

Get the reauthentication status which is coonfigured on the radius server.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	reAuthPeriod	reauthentication period

Return values

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

Note

The reAuthPeriod is the initialization value for reAuthWhen,

which is a timer used by the Authenticator state machine to

determine when reauthentication of the Supplicant takes place.

OpEN API Version: 1.25

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

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

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrDynamicVlanCreationModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	dynamicVlanMode
	)

Get the authentication manager Dynamic Vlan Creation Mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	dynamicVlanMode	radius dynamic vlan creation 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 authentication manager Dynamic Vlan Creation Mode

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrDynamicVlanCreationModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	dynamicVlanMode
	)

Set the authentication manager Dynamic Vlan Creation Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	dynamicVlanMode	radius dynamic vlan creation 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 authentication manager Dynamic Vlan Creation Mode

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrEnabledMethodGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	index,
		OPEN_AUTHMGR_METHOD_t *	method
	)

Get the Enabled method order.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	index	position of the method or order
[out]	method	authentication manager methods, i,e. dot1x/mab/cp

Return values

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

Note

This API gets the enabled method order

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrEnabledPriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	index,
		OPEN_AUTHMGR_METHOD_t *	method
	)

Get the Enabled method priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	index	position of the method or order
[out]	method	authentication manager methods, i,e. dot1x/mab/cp

Return values

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

Note

This API gets the enabled method priority

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogAuthStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		OPEN_AUTHMGR_PORT_STATUS_t *	authStatus
	)

Gets the client authenticated status from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	authStatus	client authenticated status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the client authentication status from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogClientMacAddressGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		open_buffdesc *	macAddress
	)

Gets the client MAC address from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	macAddress	MAC Address

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the client MAC address from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogEntryIsValid	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex
	)

Checks if the authentication manager history log entry exists in history table.

Parameters

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

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API checks if the history log entry exists.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogFilterIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		open_buffdesc *	filterId
	)

Gets the filter ID from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	filterId	filter id

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the filter ID from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogIndexNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	intIfNum,
		uint32_t *	entryIndex
	)

Gets the authentication manager next History Log interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in,out]	intIfNum	internal interface number
[in,out]	entryIndex	entry index

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the next interface number and entry index.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogInterfacePurge	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum
	)

Purges all authentication manager auth history log entries for a given interface.

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.
OPEN_E_INTERNAL	Other internal failure.

Note

This API clears the authentication manager auth history log entries for a given interface.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogMethodGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		OPEN_AUTHMGR_METHOD_t *	method
	)

Gets the authentication method from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	method	authentication manager methods, i,e. dot1x/mab/cp

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the authentication method from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogPurgeAll

(

openapiClientHandle_t *

client_handle

)

Purges all authentication manager auth history log entries.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API clears all authentication manager auth history log entries in the system.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogReasonCodeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		uint32_t *	reasonCode
	)

Gets the reason code from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	reasonCode	reason code

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the reason code from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogReasonStringGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		uint32_t	reasonCode,
		open_buffdesc *	reason
	)

Gets the reason code in string format from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[in]	reasonCode	reason code
[out]	reason	reason code string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the reason code sitring based on reason code from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogReverseIndexNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	intIfNum,
		uint32_t *	entryIndex
	)

Gets the authentication manager next History Log interface and entry index in reverse order.

Parameters

[in]	client_handle	client handle from registration API
[in,out]	intIfNum	internal interface number
[in,out]	entryIndex	entry index

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the next interface number and entry index in reverse order.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogTimestampGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		open_buffdesc *	timeStamp
	)

Gets the time stamp from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	timeStamp	time stamp

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the time stamp from the authentication manager auth history table for a given interface and entry index.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogVlanAssignedTypeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *	vlanAssignedType
	)

Gets the VLAN assigned type from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	vlanAssignedType	VLAN assigned type

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the VLAN assigned type from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrHistoryLogVlanIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	entryIndex,
		uint32_t *	vlanId
	)

Gets the VLAN ID from the authentication manager auth history table for a given interface and entry index.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	entryIndex	entry index
[out]	vlanId	VLAN ID

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Other internal failure.

Note

This API gets the VLAN ID from the authentication manager auth history table for a given interface and entry index. Use openapiAuthMgrHistoryLogIndexNextGet to get the entryIndex.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortClientAuthenticatedMethodGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		OPEN_AUTHMGR_METHOD_t *	method
	)

Get the client authenticated Method for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	method	authenticated method

Return values

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

Note

This API gets the client authenticated Method for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortClientAuthStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		OPEN_AUTHMGR_STATES_t *	authState
	)

Get the client reauth state for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	authState	reauthenticating state

Return values

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

Note

This API gets the client reauth state for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortClientAuthStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		OPEN_AUTHMGR_PORT_STATUS_t *	authStatus
	)

Get the client authenticated Status for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	authStatus	client authenticated status

Return values

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

Note

This API gets the client authenticated Status for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortClientMacAddrGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		open_buffdesc *	macAddrBuffDesc
	)

Get the client/supplicant Mac address for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	macAddrBuffDesc	Mac Address of the supplicant

Return values

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

Note

This API gets the client/supplicant Mac address for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortClientReauthStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		OPEN_CONTROL_t *	reauthState
	)

Get the client reauthenticating state for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	reauthState	reauthenticating state

Return values

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

Note

This API gets the client reauthenticating state for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortClientVlanTypeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		uint32_t *	vlanType
	)

Get the authenticated client vlan type (data/voice) for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	vlanType	vlan type (data/voice)

Return values

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

Note

This API gets the authenticated client vlan type (data/voice) for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortFilterIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		open_buffdesc *	filterId
	)

Get the filter id for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	filterId	filter id for the logical interface

Return values

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

Note

This API gets the filter id for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	firstlIntIfNum
	)

Gets the first logical port in use for the physcial interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	the internal interface
[out]	firstlIntIfNum	the first logical interface

Return values

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

Note

This API gets the first logical port in use for the physcial interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		uint32_t *	nextlIntIfNum
	)

Gets the next logical port for the physcial interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	nextlIntIfNum	the next logical interface

Return values

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

Note

This API gets the next logical port for the physcial interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortSessionTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		uint32_t *	sessionTime
	)

Get Logical port Session time.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	sessionTime	session time

Return values

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

Note

This API gets the logical port session time

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortSessionTimeoutGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		uint32_t *	sessionTimeout
	)

Get the session timeout value for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	sessionTimeout	session timeout for the logical interface

Return values

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

Note

This API gets the session timeout value for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortTerminationActionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		uint32_t *	terminationAction
	)

Get the logical port termination action value.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	terminationAction	termination action value

Return values

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

Note

This API gets the logical port termination action value

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthmgrLogicalPortTimeLeftForTerminateActionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		uint32_t *	timeLeft
	)

Get the time left for the session termination action to occur for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	timeLeft	the left out time value

Return values

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

Note

This API gets the time left for the session termination action to occur for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortUserNameGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	lIntIfNum,
		open_buffdesc *	userName
	)

Get the client username for the logical interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	lIntIfNum	the logical interface
[out]	userName	user name for the logical interface

Return values

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

Note

This API gets the client username for the logical interface

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrLogicalPortVlanAssignmentGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	logicalIfNum,
		uint32_t *	vlan,
		OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *	reason
	)

Gets the authentication manager 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.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrNumClientsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	clientsCount
	)

Get the number of clients authenticated.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	clientsCount	authenticated clients count

Return values

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

Note

This API gets the number of clients authenticated

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortAdminControlledDirectionsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_AUTHMGR_PORT_DIRECTION_t *	pCntrlDir
	)

Gets Auth manager admin control direction on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	pCntrlDir	Controlled direction value.

Return values

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

Note

This API fetches Auth manager admin control direction on the specified port.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortAdminControlledDirectionsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_AUTHMGR_PORT_DIRECTION_t	cntrlDir
	)

Sets the authentication admin control direction on the specified port.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	cntrlDir	Controlled direction 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 authentication admin control direction on the specified port.

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

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortAuthMethodOrderGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	index,
		OPEN_AUTHMGR_METHOD_t *	method
	)

Get authentication manager method order.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	index	position of the method or order
[out]	method	authentication manager methods, i,e. dot1x/mab/cp

Return values

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

Note

This API gets the authentication manager method order.

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortAuthMethodOrderSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	index,
		OPEN_AUTHMGR_METHOD_t	method
	)

Set authentication manager method order.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	index	position of the method or order
[in]	method	authentication manager methods, i,e. dot1x/mab/cp

Return values

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

Note

This API sets the authentication manager method order.

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortAuthMethodPriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	index,
		OPEN_AUTHMGR_METHOD_t *	method
	)

Get authentication manager method priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	index	position of the method or order
[out]	method	authentication manager methods, i,e. dot1x/mab/cp

Return values

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

Note

This API gets the authentication manager method priority.

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortAuthMethodPrioritySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	index,
		OPEN_AUTHMGR_METHOD_t	method
	)

Set authentication manager method priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	index	position of the method or order
[in]	method	authentication manager methods, i,e. dot1x/mab/cp

Return values

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

Note

This API sets the authentication manager method priority.

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortControlModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_PORT_CONTROL_t *	mode
	)

Gets the authentication manager 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.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortControlModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_PORT_CONTROL_t	mode
	)

Sets the authentication manager 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.25

Examples:

authmgr_example.c.

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

Get the Authentication 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.25

Examples:

authmgr_example.c.

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

Set the Authentication Server Alive action.

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.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortInitializeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t	initialize
	)

To initialize (or) re-authenticate the specific interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	initialize	Initialize value. value of OPEN_TRUE forces initialization of a port.

Return values

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

Note

This API is used to initialize (or) re-authenticate the specific interface.

All authentication sessions are cleared on the interface.

OpEN API Version: 1.26

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortMaxAuthAttemptsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	maxAuthAttempts
	)

Get the max number of failed authentication attempts value on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	maxAuthAttempts	value for the max authentication failed attempts

Return values

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

Note

This API gets the max number of failed authentication attempts value on the specified port

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortMaxAuthAttemptsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	maxAuthAttempts
	)

Set the max number of failed authentication attempts value on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	maxAuthAttempts	value for the max authentication failed attempts

Return values

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

Note

This API sets the max number of failed authentication attempts value on the specified port

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortMaxUsersGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	maxUsers
	)

Get the max users of the port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	maxUsers	max users per port

Return values

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

Note

The maxUsers is the maximum number of hosts that can be

authenticated on a port using mac based authentication

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortMaxUsersSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	maxUsers
	)

Set the max users for the port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[in]	maxUsers	max users per port

Return values

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

Note

The maxUsers is the maximum number of hosts that can be

authenticated on a port using mac based authentication

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortOperatingControlModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_PORT_CONTROL_t *	mode
	)

Gets the authentication manager 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.25

open_error_t openapiAuthMgrPortStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_PORT_STATUS_t *	status
	)

Gets the authentication manager 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.25

open_error_t openapiAuthMgrPortUnauthenticatedVlanGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	vlanId
	)

Get the Authentication fail action (Unauthenticated vlan) value.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	vlanId	Unauthenticated vlan

Return values

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

Note

This API gets the Authentication fail action (Unauthenticated vlan) value

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrPortUnauthenticatedVlanSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	vlanId
	)

Set the Authentication fail action (Unauthenticated vlan) value.

Parameters

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

Return values

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

Note

This API sets the Authentication fail action (Unauthenticated vlan) value

OpEN API Version: 1.25

Examples:

authmgr_example.c.

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

Gets the authentication manager 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.

Note

This function was deprecated in OpEN API version 1.26. Please use openapiAuthMgrLogicalPortVlanAssignmentGet().

OpEN API Version: 1.25 OpEN API Version: 1.26

open_error_t openapiAuthMgrPortVlanAssignedReasonGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *	reason
	)

Gets the authentication manager 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.

Note

This function was deprecated in OpEN API version 1.26. Please use openapiAuthMgrLogicalPortVlanAssignmentGet().

OpEN API Version: 1.25 OpEN API Version: 1.26

open_error_t openapiAuthMgrVlanAssignmentModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	vlanAssignmentMode
	)

Get the authentication manager Vlan Assignment Mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	vlanAssignmentMode	radius vlan assignment 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 authentication manager Vlan Assignment Mode

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiAuthMgrVlanAssignmentModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	vlanAssignmentMode
	)

Set the authentication manager Vlan Assignment Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanAssignmentMode	radius vlan assignment 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 authentication manager Vlan Assignment Mode

OpEN API Version: 1.25

Examples:

authmgr_example.c.

open_error_t openapiDbAuthMgrAuthenticationReAuthPeriodGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	reAuthPeriod
	)

Get the reauthentication period on the specified port.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	reAuthPeriod	reauthentication period

Return values

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

Note

The reAuthPeriod is the initialization value for reAuthWhen,

which is a timer used by the Authenticator state machine to

determine when reauthentication of the Supplicant takes place.

OpEN API Version: 1.25