Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
This document provides a brief description of the User Application Configuration OpEN APIs. It provides the following services:
All 'Set' operations would affect the Switch behavior and configuration.
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.
userapp_example.c is a sample application that demonstrates the use of the User Application Configuration OpEN API. userapp_config_db_example is started from the command line and exercises all the User Application Configuration OpEN APIs one by one.
# ./userapp_config_db_example
ICOS version = 1.25.18.42
Creating new database: database_example SUCCESS Applying entry to database: database_example, with keyname: entry_example, and value: data_example SUCCESS Fetching value for keyname: entry_example SUCCESS Removing entry for keyname: entry_example SUCCESS Fetching value for keyname: entry_example doesn't exist SUCCESS Deleting database: database_example SUCCESS
CLI Command | OpEN API Reference ----------— | --------------—
(console#)show support-assist status (config)#support-assist | openapiUserAppConfigDbCreateAppDb (conf-support-assist)# server <server-name>|openapiUserAppConfigDbSet() (console#)show support-assist status |openapiUserAppConfigDbGet() (conf-support-assist)#no server <server-name>|openapiUserAppConfigDbRemoveItem() (console#)show support-assist status |openapiUserAppConfigDbGet() (config)#no support-assist | openapiUserAppConfigDbDeleteAppDb()