Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Authentication

Authentication is a network security feature that is used to control users from accessing the network. It is the process of identifying a user, usually based on a username and password with each user having a unique set of credentials. It can be carried out by various methods like RADIUS, TACACS, local database etc..

Authentication OpEN API

This document provides a brief description of the Authentication OpEN APIs. The Authentication OpEN APIs allow processes outside of the ICOS main process (switchdrvr) access to User Authentication services. It provides the following services:

All 'Set' operations may affect the Switch behavior and configuration.

Example C Application authentication_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.

authentication_example

authentication_example.c is a sample application that demonstrates the use of the Authentication OpEN APIs. authentication_example is started from the command line and has the following usage syntax:

Usage: authentication_example <test#> <arg1> <arg2> ...

It exercises all the Authentication OpEN APIs with appropriate arguments to manage the Authentication feature in the ICOS main process (switchdrvr).

Authentication CLI/API Cross Reference

CLI Command OpEN API Reference
(Config)#
aaa authentication {enable | login} {<listname> | default} <method1> [<method2>.....<methodn>]
openapiAuthenticationListCreate()
openapiAuthenticationMethodsAdd()
openapiAuthenticationListFirstGet()
openapiAuthenticationListNextGet()
openapiAuthenticationMethodListGet()
(Config)#
no aaa authentication {enable | login} listname
openapiAuthenticationListDelete()
(Line-Config-Mode)#
{login | enable} authentication {<list-name> | default}
openapiAuthenticationListLineSet()
openapiAuthenticationListLineGet()
(Line-Config Mode)#
no {login | enable} authentication
openapiAuthenticationListLineDelete()