Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Power over Ethernet (PoE)

PoE OpEN API

Power over Ethernet feature requires that the switch is equipped with special PoE controller hardware for it to function as a power sourcing equipment. Network switches and routers with the combination of FastPath software and any PoE controller provide an industry standard robust PoE solution for high power applications.

This document provides a brief description of the Power over Ethernet (PoE) OpEN APIs. It provides the following services:

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

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

poe_example

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

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

PoE CLI/API Cross Reference

CLI Command OpEN API Reference
(Config)#
show poe
openapiPoePseMainPowerMgmtModeGet()
openapiPoePseMainConsumptionPowerGet()
openapiPoeFWImageVersionGet()
openapiPoePseMainOperStatusGet()
openapiPoePseThresholdPowerGet()
openapiPoePseTotalAvailablePowerGet()
openapiPoeTrapModeGet()
(Config)#
show poe port
openapiPoeFirstInterfaceGet()
openapiPoePsePortPowerClassificationsGet()
openapiPoePsePortSensorsGet()
openapiPoePsePortDetectionStatusGet()
openapiPoePsePortErrorCodeGet()
openapiPoePsePortCountersGet()
(Config)#
[no] poe detection <detection-mode>
openapiPoePseMainDetectionModeSet()
openapiPoePseMainDetectionModeGet()
openapiPoePsePortDetectionModeSet()
openapiPoePsePortDetectionModeGet()
(Config)#
[no] poe limit <power-limit>
openapiPoePsePortCurPowerLimitSet()
openapiPoePsePortCurPowerLimitGet()
openapiPoePsePortViolationTypeSet()
openapiPoePsePortViolationTypeGet()
(Config)#
[no] poe priority <power-priority>
openapiPoePsePortCurPowerPrioritySet()
openapiPoePsePortCurPowerPriorityGet()
(Config)#
[no] poe high-power
openapiPoePsePortHighPowerModeSet()
openapiPoePsePortHighPowerModeGet()
openapiPoePsePortPowerUpModeSet()
openapiPoePsePortPowerUpModeGet()
(Config)#
poe usagethreshold <threshold>
openapiPoePseMainUsageThresholdSet()
openapiPoePseMainUsageThresholdGet()
(Config)#
config poe usagethreshold
openapiPoePseMainUsageThresholdSet()
(Interface-Config Mode)#
[no] poe timer schedule <name>
openapiPoePethPsePortTimerCtrlClear()
(Interface-Config Mode)#
poe timer schedule <name>
openapiPoePsePortTimerScheduleNameSet()