This document provides a brief description of the Capability_licensing OpEN APIs. It provides the following services:

Get the number of license files in the system
Get the first license index in the system.
Get the next license index in the system.
Get the type of license.
Get the status of license in the system.
Get the parameter value of license file in the system.
Get the version number of license file in the system.
Get the key of license file in the system.
Get the model name of license file.
Get the serial number of license file.
Delete a license file.
Delete all license files in the system.

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

capability_licensing_example

capability_licensing_example.c is a sample application that demonstrates the use of OpEN's Capability_licensing APIs. capability_licensing_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

Usage: ./capability_licensing_example <test#> <arg1> <arg2> ...
Test 1: Get the number of license files in the system: capability_licensing_example 1
Test 2: Get the first license index in the system: capability_licensing_example 2
Test 3: Get the next license index in the system: capability_licensing_example 3 <CurrentLicenseIndex>
Test 4: Get the type of license: capability_licensing_example 4 <licenseIndex>
Test 5: Get the status of license in the system: capability_licensing_example 5 <licenseIndex>
Test 6: Get the parameter value of license file in the system: capability_licensing_example 6 <licenseIndex> <paramType>
Test 7: Get the version number of license file in the system: capability_licensing_example 7 <licenseIndex>
Test 8: Get the key of license file in the system: capability_licensing_example 8 <licenseIndex>
Test 9: Get the model name of license file: capability_licensing_example 9 <licenseIndex>
Test 10: Get the serial number of license file: capability_licensing_example 10 <licenseIndex>
Test 11: Remove a license file: capability_licensing_example 11 <licenseIndex>
Test 12: Remove all license files in the system: capability_licensing_example 12
Test 13: Run API sanity checks: capability_licensing_example 13

Capability_licensing CLI/API Cross Reference

CLI Command	OpEN API Reference
(Priv-User Mode)#show license	openapiCapabLicenseCountGet() openapiCapabLicenseTypeGet() openapiCapabLicenseStatusGet() openapiCapabLicenseNextIndexGet()
(Priv-User Mode)#show license file <file_number>	openapiCapabLicenseParamGet() openapiCapabLicenseVersionGet() openapiCapabLicenseKeyGet() openapiCapabLicenseModelGet() openapiCapabLicenseModelGet() openapiCapabLicenseSerialNumberGet()

(Priv-User Mode)#license clear <file_number/all> | openapiCapabLicenseRemove()
openapiCapabLicenseRemoveAll()