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

Green ethernet OpEN API

This document provides a brief description of the Green ethernet 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 green_ethernet_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.

green_ethernet_example

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

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

Test 1: testGreenEthrIsValidIntfType: green_ethernet_example 1 <interface>
Test 2: testGreenEthrValidIntfFirstGet: green_ethernet_example 2
Test 3: testGreenEthrValidIntfNextGet: green_ethernet_example 3 <interface>
Test 4: testGreenEthrIsIntfEEECapable: green_ethernet_example 4 <interface>
Test 5: testGreenEthrEnergyDetectModeSet: green_ethernet_example 5 <interface> <mode>
Test 6: testGreenEthrShrtRchAutoModeSet: green_ethernet_example 6 <interface> <mode>
Test 7: testGreenEthrShrtRchForceModeSet: green_ethernet_example 7 <interface> <mode>
Test 8: testGreenEthrIsIntfEEECapable: green_ethernet_example 8 <interface>
Test 9: testGreenEthrEnergyDetectAdminModeGet: green_ethernet_example 9 <interface>
Test 10: testGreenEthrShrtRchAutoAdminModeGet: green_ethernet_example 10 <interface>
Test 11: testGreenEthrShrtRchForceAdminModeGet: green_ethernet_example 11 <interface>
Test 12: testGreenEthrEnergyDetectOprStatusGet: green_ethernet_example 12 <interface>
Test 13: testGreenEthrShrtRchOprStatusGet: green_ethernet_example 13 <interface>
Test 14: testGreenEthrGlobalShortReachModeGet: green_ethernet_example 14
Test 15: testGreenEthrGlobalEnergyDetectModeGet: green_ethernet_example 15
Test 16: testGreenEthrGlobalShortReachModeSet: green_ethernet_example 16 <mode>
Test 17: testGreenEthrGlobalEnergyDetectModeSet: green_ethernet_example 17 <mode>

Green ethernet CLI/API Cross Reference

CLI Command	OpEN API Reference
(Priv-User Mode)# show green-mode	openapiGreenEthrIsValidIntfType() openapiGreenEthrEnergyDetectAdminModeGet() openapiGreenEthrEnergyDetectOprStatusStrGet() openapiGreenEthrShrtRchAutoAdminModeGet() openapiGreenEthrShrtRchForceAdminModeGet() openapiGreenEthrShrtRchOprStatusStrGet() openapiGreenEthrEeeAutoCapability() openapiGreenEthrEeeNativeCapability()

(Config)#green-mode eee | openapiGreenEthrIsValidIntfType()
openapiGreenEthrEeeAdminModeGet()
openapiGreenEthrEeeAdminModeSet() (Config)#green-mode energy-detect | openapiGreenEthrGlobalEnergyDetectModeSet (Config)#green-mode short-reach | openapiGreenEthrGlobalShortReachModeSet