Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
Macros | Enumerations | Functions
openapi_authmgr.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_AUTHMGR_USER_NAME_LEN   65
 

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
}
 OpEN uses this enumeration to define port host mode. More...
 
enum  OPEN_AUTHMGR_METHOD_t { OPEN_AUTHMGR_METHOD_NONE = 0, OPEN_AUTHMGR_METHOD_8021X, OPEN_AUTHMGR_METHOD_MAB, OPEN_AUTHMGR_METHOD_CP }
 OpEN uses this enumeration to define authentication manager method. More...
 
enum  OPEN_AUTHMGR_METHOD_TYPE_t { OPEN_AUTHMGR_TYPE_ORDER = 1, OPEN_AUTHMGR_TYPE_PRIORITY }
 OpEN uses this enumeration to define authentication manager method mode. More...
 
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 }
 OpEN uses this enumeration to define port authorization mode. More...
 
enum  OPEN_AUTHMGR_PORT_STATUS_t { OPEN_AUTHMGR_PORT_STATUS_NA = 0, OPEN_AUTHMGR_PORT_STATUS_AUTHORIZED, OPEN_AUTHMGR_PORT_STATUS_UNAUTHORIZED }
 OpEN uses this enumeration to define port authorization status. More...
 
enum  OPEN_AUTHMGR_STATES_t {
  OPEN_AUTHMGR_INITIALIZE = 0, OPEN_AUTHMGR_AUTHENTICATING, OPEN_AUTHMGR_AUTHENTICATED, OPEN_AUTHMGR_HELD,
  OPEN_AUTHMGR_UNAUTHENTICATED, OPEN_AUTHMGR_STATES
}
 OpEN uses this enumeration to define authentication manager states. More...
 
enum  OPEN_AUTHMGR_TERMINATION_ACTION_t { OPEN_AUTHMGR_TERMINATION_ACTION_DEFAULT = 1, OPEN_AUTHMGR_TERMINATION_ACTION_RADIUS }
 OpEN uses this enumeration to define radius termination action (needed by UI) More...
 
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
}
 OpEN uses this enumeration to define vlan assignment mode. More...
 

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