Port-based network access control allows a network administrator to restrict the use of IEEE 802 LAN service access points (ports) to secure communication between authenticated and authorized devices. This standard specifies a common architecture, functional elements, and protocols that support mutual authentication between the clients of ports attached to the same LAN and that secure communication between the ports, including the media access method independent protocols that are used to discover and establish the security associations used by IEEE 802.1AE MAC Security.
DOT1X OpEN API
This document provides a brief description of the DOT1X OpEN APIs. It provides the following services:
- Get/Set the dot1x global administrative mode on switch.
- Get/Set the dot1x default authentication method on switch.
- Get the dot1x port PAE state on switch.
- Get the dot1x port back end authorization state on switch.
- Get/Set dot1x eapol flood mode on switch.
- Get/Set dot1x quiet period on the specified port on switch.
- Get/Set dot1x transmit period on the specified port on switch.
All 'Set' operations would affect the Switch behavior and configuration.
Example C Application dot1x_example
Initialization
In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.
dot1x_example
dot1x_example.c is a sample application that demonstrates the use of the DOT1X OpEN API. dot1x_example is started from the command line. It then exercises all the DOT1X OpEN APIs one by one with appropriate arguments to manage the DOT1X component in the ICOS main process (switchdrvr).
Sample Output (LiNe/LinuxHost platform)
# ./dot1x_example
Usage: dot1x_example <test#> <arg1> <arg2> ...
Test 0: Get 802.1x configured global operating control mode.: dot1x_example 0
Test 1: Set 802.1x configured global operating control mode.: dot1x_example 1 <mode>
Test 2: Get 802.1x default authentication method.: dot1x_example 2
Test 3: Set 802.1x default authentication method.: dot1x_example 3 <method>
Test 4: Get 802.1x port PAE state.: dot1x_example 12 <interface>
Test 5: Get 802.1x port backend authorization state.: dot1x_example 13 <interface>
Test 6: Set 802.1x eapol flood mode.: dot1x_example 6 <mode>
Test 7: Get 802.1x eapol flood mode.: dot1x_example 7
Test 8: Set 802.1x quiet period on the specified port.: dot1x_example 8 <interface><quietPeriod>
Test 9: Get 802.1x quiet period on the specified port.: dot1x_example 9 <interface>
Test 10: Set 802.1x transmit period on the specified port.: dot1x_example 10 <interface><txPeriod>
Test 11: Get 802.1x transmit period on the specified port.: dot1x_example 11 <interface>
DOT1X CLI/API Cross Reference
