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

User Manager manages user accounts with their unique credentials to control users from accessing computer or network resources. Each user is associated with a privilege level - read-only, read-write and super-user to restrict the resource usage based on privilege.

User Accounts OpEN API

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

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

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

user_accounts_example

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

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

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

User Accounts CLI/API Cross Reference

CLI Command OpEN API Reference
(Priv-User Mode)#
enable password <password>
openapiEnablePasswordSet()
(Priv-User Mode)#
no enable password
openapiEnablePasswordRemove()
(Config)#
username <name> password <password>
openapiUserSet()
openapiUserFirstGet()
openapiUserNextGet()
(Config)#
username <name> level <level>
openapiUserLevelSet()
openapiUserLevelGet()
(Config)#
no username <name>
openapiUserDelete()