Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
openapi_dot1x.h File Reference
#include "openapi_common.h"
#include "openapi_user_manager.h"

Go to the source code of this file.

Enumerations

enum  OPEN_AUTHMGR_HOST_CONTROL_t {
  OPEN_AUTHMGR_INVALID_HOST_MODE = 0, OPEN_AUTHMGR_SINGLE_AUTH_MODE = 1, OPEN_AUTHMGR_MULTI_HOST_MODE = 2, OPEN_AUTHMGR_MULTI_DOMAIN_AUTH_MODE = 3,
  OPEN_AUTHMGR_MULTI_AUTH_MODE = 4, OPEN_AUTHMGR_MULTI_DOMAIN_HOST_MODE = 5
}
 
enum  OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t { OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_INVALID = 0, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_EAP_MD5 = 1, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_PAP = 2, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_CHAP = 3 }
 
enum  OPEN_DOT1X_APM_STATES_t {
  OPEN_DOT1X_APM_INITIALIZE = 1, OPEN_DOT1X_APM_DISCONNECTED = 2, OPEN_DOT1X_APM_CONNECTING = 3, OPEN_DOT1X_APM_AUTHENTICATING = 4,
  OPEN_DOT1X_APM_AUTHENTICATED = 5, OPEN_DOT1X_APM_ABORTING = 6, OPEN_DOT1X_APM_HELD = 7, OPEN_DOT1X_APM_FORCE_AUTH = 8,
  OPEN_DOT1X_APM_FORCE_UNAUTH = 9
}
 
enum  OPEN_DOT1X_BAM_STATES_t {
  OPEN_DOT1X_BAM_REQUEST = 1, OPEN_DOT1X_BAM_RESPONSE = 2, OPEN_DOT1X_BAM_SUCCESS = 3, OPEN_DOT1X_BAM_FAIL = 4,
  OPEN_DOT1X_BAM_TIMEOUT = 5, OPEN_DOT1X_BAM_IDLE = 6, OPEN_DOT1X_BAM_INITIALIZE = 7
}
 
enum  OPEN_DOT1X_PORT_CONTROL_t { OPEN_DOT1X_PORT_FORCE_UNAUTHORIZED = 1, OPEN_DOT1X_PORT_AUTO = 2, OPEN_DOT1X_PORT_FORCE_AUTHORIZED = 3, OPEN_DOT1X_PORT_NA = 4 }
 
enum  OPEN_DOT1X_PORT_STATUS_t { OPEN_DOT1X_PORT_STATUS_AUTHORIZED = 1, OPEN_DOT1X_PORT_STATUS_UNAUTHORIZED = 2, OPEN_DOT1X_PORT_STATUS_NA = 3 }
 
enum  OPEN_DOT1X_VLAN_ASSIGNED_MODE_t {
  OPEN_DOT1X_DEFAULT_ASSIGNED_VLAN = 1, OPEN_DOT1X_RADIUS_ASSIGNED_VLAN = 2, OPEN_DOT1X_UNAUTHENTICATED_VLAN = 3, OPEN_DOT1X_GUEST_VLAN = 4,
  OPEN_DOT1X_VOICE_VLAN = 5, OPEN_DOT1X_MONITOR_MODE_VLAN = 6, OPEN_DOT1X_NOT_ASSIGNED = 7
}
 

Functions

open_error_t openapiAuthMgrAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
 Gets the authentication manager global administrative mode. 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 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 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 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 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 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 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 openapiDot1xPortPaeStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_APM_STATES_t *state)
 Gets the dot1x port PAE state. 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 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...
 
open_error_t openapiMabPortMABAuthTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t *val)
 Gets the authentication host mode for the specified interface. More...
 
open_error_t openapiMabPortMABAuthTypeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_MAB_AUTH_TYPE_t val)
 Sets the authentication type to be used by MAB for the specified interface. More...