The EEE API provides support for obtaining data related to the switch CPU.

EEE OpEN API

This document provides a brief description of the EEE OpEN APIs. The APIs provide the following services:

Get maximum number of intervals tracked for CPU utilization.
Get an array of CPU utilization values, one per tracked period.

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

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

eee_example

eee_example.c is a sample application that demonstrates the use of the EEE OpEN APIs. It is started from the command line and has the following usage:

Usage: eee_example <test#> <arg1> <arg2> ... li Test 1: testGreenEthrEeeIsValidIntf: eee_example 1 <interface> li Test 2: testGreenEthrEeeValidIntfFirstGet: eee_example 2 li Test 3: testGreenEthrEeeValidIntfNextGet: eee_example 3 <interface> li Test 4: testGreenEthrEeeAdminModeGet: eee_example 4 <interface> li Test 5: testGreenEthrEeeTxIdleTimeGet: eee_example 5 <interface> li Test 6: testGreenEthrEeeTxWakeTimeGet: eee_example 6 <interface> li Test 7: testGreenEthrEeeAdminModeSet: eee_example 7 <interface> <mode> li Test 8: testGreenEthrEeeTxIdleTimeSet: eee_example 8 <interface> <time> li Test 9: testGreenEthrEeeTxWakeTimeSet: eee_example 9 <interface> <time> li Test 10: testGreenEthrEeeStatisticsClear: eee_example 10 <interface> <val> li Test 11: testGreenEthrEeeTxEventsGet: eee_example 11 <interface> li Test 12: testGreenEthrEeeTxDurationGet: eee_example 12 <interface> li Test 13: testGreenEthrEeeRxEventsGet: eee_example 13 <interface> li Test 14: testGreenEthrEeeRxDurationGet: eee_example 14 <interface> li Test 15: testGreenEthrEeeTxTwsysGet: eee_example 15 <interface> li Test 16: testGreenEthrEeeRxTwsysGet: eee_example 16 <interface> li Test 17: testGreenEthrEeeFbTwsysGet: eee_example 17 <interface> li Test 18: testGreenEthrEeeEchoTxTwsysGet: eee_example 18 <interface> li Test 19: testGreenEthrEeeEchoRxTwsysGet: eee_example 19 <interface> li Test 20: testGreenEthrEeeRemTxTwsysGet: eee_example 20 <interface> li Test 21: testGreenEthrEeeRemTxTwsysEchoGet: eee_example 21 <interface> li Test 22: testGreenEthrEeeRemRxTwsysGet: eee_example 22 <interface> li Test 23: testGreenEthrEeeRemRxTwsysEchoGet: eee_example 23 <interface> li Test 24: testGreenEthrEeeRemFbTwsysGet: eee_example 24 <interface> li Test 25: testGreenEthrEeeTxDllEnableGet: eee_example 25 <interface> li Test 26: testGreenEthrEeeTxDllReadyGet: eee_example 26 <interface> li Test 27: testGreenEthrEeeRxDllEnableGet: eee_example 27 <interface> li Test 28: testGreenEthrEeeRxDllReadyGet: eee_example 28 <interface> li Test 29: testGreenEthrEeeTotalLpiTimeGet: eee_example 29 li Test 30: testGreenEthrEeeLocalSummaryGet: eee_example 30 <interface> li Test 31: testGreenEthrEeeRemoteSummaryGet: eee_example 31 <interface> li Test 32: testGreenEthrGlobalEeeAdminModeGet: eee_example 32 li Test 33: testGreenEthrGlobalEeeAdminModeSet: eee_example 33 <mode> li Test 34: testGreenEthrEeeTimeSinceLastStatsResetGet: eee_example 34 <interface> li Test 35: testxGreenEthrEeeTimeSinceLastStatsResetGet: eee_example 35 <interface>

EEE CLI/API Cross Reference

CLI Command	OpEN API Reference
(Priv-User Mode)# show green-mode	openapiGreenEthrGlobalEeeAdminModeGet()

(Config)#green-mode eee | openapiGreenEthrGlobalEeeAdminModeGet()
openapiGreenEthrGlobalEeeAdminModeGet() (Interface-Config Mode)#
green-mode eee openapiGreenEthrEeeAdminModeSet() (Interface-Config Mode)#
green-mode eee tx-idle-time | openapiGreenEthrEeeTxIdleTimeSet() (Interface-Config Mode)#
green-mode eee tx-wake-time | openapiGreenEthrEeeTxWakeTimeSet()