Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
PoE Configuration And Status [OPENAPI_POE]

Macros

#define OPEN_MAX_POE_CARD_INFO_BUF_SIZE   128
 
#define OPEN_MAX_POE_TIMER_NAME_BUF_LEN   32
 
#define OPEN_POE_PORT_LIMIT_DOT3AF   15400
 
#define OPEN_TIMERANGE_NAME_LEN_MAX   32
 

Enumerations

enum  OPEN_POE_DETECTION_t {
  OPEN_POE_DETECTION_INVALID = 0, OPEN_POE_DETECTION_LEGACY = 1, OPEN_POE_DETECTION_4PT_DOT3AF = 2, OPEN_POE_DETECTION_4PT_DOT3AF_LEG = 3,
  OPEN_POE_DETECTION_2PT_DOT3AF = 4, OPEN_POE_DETECTION_2PT_DOT3AF_LEG = 5, OPEN_POE_DETECTION_NONE = 6, OPEN_POE_DETECTION_COUNT = 7
}
 PoE detection mode. More...
 
enum  OPEN_POE_LIMIT_TYPE_t {
  OPEN_POE_LIMIT_TYPE_INVALID = 0, OPEN_POE_LIMIT_TYPE_DOT3AF = 1, OPEN_POE_LIMIT_TYPE_USER = 2, OPEN_POE_LIMIT_TYPE_NONE = 3,
  OPEN_POE_LIMIT_TYPE_COUNT = 4
}
 
enum  OPEN_POE_PORT_DETECTION_STATUS_t {
  OPEN_POE_PORT_DETECTION_STATUS_INVALID = -1, OPEN_POE_PORT_DETECTION_STATUS_DISABLED = 0, OPEN_POE_PORT_DETECTION_STATUS_SEARCHING = 1, OPEN_POE_PORT_DETECTION_STATUS_DELIVERING_POWER = 2,
  OPEN_POE_PORT_DETECTION_STATUS_TEST = 3, OPEN_POE_PORT_DETECTION_STATUS_FAULT = 4, OPEN_POE_PORT_DETECTION_STATUS_OTHER_FAULT = 5, OPEN_POE_PORT_DETECTION_STATUS_REQUESTING_POWER = 6,
  OPEN_POE_PORT_DETECTION_STATUS_OVERLOAD = 7
}
 PoE port detection status. More...
 
enum  OPEN_POE_PORT_FAULT_STATUS_t {
  OPEN_POE_PORT_FAULT_STATUS_NONE = 0xFF, OPEN_POE_PORT_FAULT_STATUS_OVLO = 0, OPEN_POE_PORT_FAULT_STATUS_MPS_ABSENT = 1, OPEN_POE_PORT_FAULT_STATUS_SHORT = 2,
  OPEN_POE_PORT_FAULT_STATUS_OVERLOAD = 3, OPEN_POE_PORT_FAULT_STATUS_POWER_DENIED = 4, OPEN_POE_PORT_FAULT_STATUS_THERMAL_SHUTDOWN = 5, OPEN_POE_PORT_FAULT_STATUS_STARTUP_FAILURE = 6,
  OPEN_POE_PORT_FAULT_STATUS_UVLO = 7
}
 PoE port error code. More...
 
enum  OPEN_POE_PORT_POWER_CLASS_t {
  OPEN_POE_PORT_POWER_INVALID = 0, OPEN_POE_PORT_POWER_CLASS0 = 1, OPEN_POE_PORT_POWER_CLASS1 = 2, OPEN_POE_PORT_POWER_CLASS2 = 3,
  OPEN_POE_PORT_POWER_CLASS3 = 4, OPEN_POE_PORT_POWER_CLASS4 = 5
}
 PoE port power class. More...
 
enum  OPEN_POE_POWER_MGMT_t {
  OPEN_POE_POWER_MGMT_INVALID = 0, OPEN_POE_POWER_MGMT_STATIC = 1, OPEN_POE_POWER_MGMT_DYNAMIC = 2, OPEN_POE_POWER_MGMT_STATIC_PRI = 3,
  OPEN_POE_POWER_MGMT_DYNAMIC_PRI = 4, OPEN_POE_POWER_MGMT_CLASS = 5
}
 PoE Mgmt Mode. More...
 
enum  OPEN_POE_POWER_UP_MODE_t {
  OPEN_POE_POWER_UP_MODE_INVALID =-1, OPEN_POE_POWER_UP_MODE_8023AF = 0, OPEN_POE_POWER_UP_MODE_HIGH_INRUSH = 1, OPEN_POE_POWER_UP_MODE_PRE_8023AT = 2,
  OPEN_POE_POWER_UP_MODE_8023AT = 3, OPEN_POE_POWER_UP_MODE_UPOE = 4, OPEN_POE_POWER_UP_MODE_COUNT = 5
}
 
enum  OPEN_POE_PRIORITY_t {
  OPEN_POE_PRIORITY_INVALID = 0, OPEN_POE_PRIORITY_LOW = 1, OPEN_POE_PRIORITY_MEDIUM = 2, OPEN_POE_PRIORITY_HIGH = 3,
  OPEN_POE_PRIORITY_CRITICAL = 4, OPEN_POE_PRIORITY_COUNT = 5
}
 
enum  OPEN_POE_SYSTEM_OPER_STATUS_t { OPEN_POE_SYSTEM_OPER_STATUS_ON = 1, OPEN_POE_SYSTEM_OPER_STATUS_OFF = 2, OPEN_POE_SYSTEM_OPER_STATUS_FAULTY = 3 }
 PoE main operational status code. More...
 
enum  OPEN_POE_TYPE_t {
  OPEN_POE_TYPE_POE = 1, OPEN_POE_TYPE_POE_PLUS = 2, OPEN_POE_TYPE_PSE = 3, OPEN_POE_TYPE_PSE_PLUS = 4,
  OPEN_POE_TYPE_PD = 5, OPEN_POE_TYPE_PD_PLUS = 6, OPEN_POE_TYPE_UPOE = 7
}
 PoE types. More...
 

Functions

open_error_t openapiPoeFindMaxPowerLimit (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *maxPowerLimit)
 Find max power limit based on PoE/PoE+/UPoE for given unit and interface number. More...
 
open_error_t openapiPoeFirstInterfaceGet (openapiClientHandle_t *client_handle, OPEN_POE_TYPE_t poeType, uint32_t unit, uint32_t *ifNum)
 Get the PoE first interface number. More...
 
open_error_t openapiPoeFWImageVersionGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *version)
 Obtain POE Firmware Version. More...
 
open_error_t openapiPoeIsSupported (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_BOOL_t *isSupported)
 Check to see if PoE is supported on this platform. More...
 
open_error_t openapiPoeIsValidInterface (openapiClientHandle_t *client_handle, OPEN_POE_TYPE_t poeType, uint32_t ifNum, OPEN_BOOL_t *isValid)
 Determine if the interface is capable of supporting PoE. More...
 
open_error_t openapiPoePethPsePortTimerCtrlClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Clear timer schedule association for the port. More...
 
open_error_t openapiPoePseMainAdminEnableSet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t adminMode)
 Sets global POE administrative mode . More...
 
open_error_t openapiPoePseMainConsumptionPowerGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
 Get the total power consumed for a unit. More...
 
open_error_t openapiPoePseMainCurPowerLimitSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t powerLimit)
 Sets the current watt limit the PSE can deliver on all interfaces. More...
 
open_error_t openapiPoePseMainCurPowerPrioritySet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_PRIORITY_t powerPriority)
 Sets port priority value used in management algorithm on all interfaces. More...
 
open_error_t openapiPoePseMainDetectionModeGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_DETECTION_t *detectionMode)
 Gets detection mode of a given unit. More...
 
open_error_t openapiPoePseMainDetectionModeSet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_DETECTION_t detectionMode)
 Sets detection mode of a given unit. More...
 
open_error_t openapiPoePseMainOperStatusGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_SYSTEM_OPER_STATUS_t *status)
 Obtain PSE Main Operational Status. More...
 
open_error_t openapiPoePseMainPowerMgmtModeGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_POWER_MGMT_t *mode)
 Get the power management mode of the unit. More...
 
open_error_t openapiPoePseMainPowerMgmtModeSet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_POE_POWER_MGMT_t mode)
 Set the power management mode of the unit. More...
 
open_error_t openapiPoePseMainReset (openapiClientHandle_t *client_handle, uint32_t unit)
 Reset PoE on all interfaces. More...
 
open_error_t openapiPoePseMainUsageThresholdGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *threshold)
 Gets usage threshold in percent. More...
 
open_error_t openapiPoePseMainUsageThresholdSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t threshold)
 Sets usage threshold in percent. More...
 
open_error_t openapiPoePsePortAdminEnableGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *adminMode)
 Gets an interface's POE administrative mode. More...
 
open_error_t openapiPoePsePortAdminEnableSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t adminMode)
 Sets an interface's POE administrative mode. More...
 
open_error_t openapiPoePsePortCountersGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *mpsAbsentCtr, uint32_t *invalidSignatureCtr, uint32_t *powerDeniedCtr, uint32_t *overloadCtr, uint32_t *shortCtr)
 Gets all counters of PSE state machine. More...
 
open_error_t openapiPoePsePortCurPowerLimitGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *powerLimit)
 Gets the current watt limit the PSE can deliver to a port. More...
 
open_error_t openapiPoePsePortCurPowerLimitSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t powerLimit)
 Sets the current watt limit the PSE can deliver to a port. More...
 
open_error_t openapiPoePsePortCurPowerPriorityGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_PRIORITY_t *powerPriority)
 Gets interface port priority value used in management algorithm. More...
 
open_error_t openapiPoePsePortCurPowerPrioritySet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_PRIORITY_t powerPriority)
 Sets interface port priority value used in management algorithm. More...
 
open_error_t openapiPoePsePortDetectionModeGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_DETECTION_t *detectionMode)
 Gets port detection mode of a given interface. More...
 
open_error_t openapiPoePsePortDetectionModeSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_DETECTION_t detectionMode)
 Sets port detection mode on a given interface. More...
 
open_error_t openapiPoePsePortDetectionStatusGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *detectionStatus)
 Gets operational status of the port PD detection. More...
 
open_error_t openapiPoePsePortErrorCodeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *errorCode)
 Gets Interface port error code. More...
 
open_error_t openapiPoePsePortHighPowerGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_CONTROL_t *highPower)
 Gets interface ability to provide POE high power. More...
 
open_error_t openapiPoePsePortHighPowerModeGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_CONTROL_t *highPowerMode)
 Gets interface ability to provide POE high power. More...
 
open_error_t openapiPoePsePortHighPowerModeSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_CONTROL_t highPowerMode)
 Sets interface ability to provide POE high power. More...
 
open_error_t openapiPoePsePortPowerClassificationsGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *powerClass)
 Gets interface port terminal classification, eg. More...
 
open_error_t openapiPoePsePortPowerUpModeGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_POWER_UP_MODE_t *powerUpMode)
 Gets interface ability of power up. More...
 
open_error_t openapiPoePsePortPowerUpModeSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_POWER_UP_MODE_t powerUpMode)
 Sets interface ability of power up. More...
 
open_error_t openapiPoePsePortReset (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum)
 Reset PoE on a given interface. More...
 
open_error_t openapiPoePsePortSensorsGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, uint32_t *power, uint32_t *current, uint32_t *voltage, uint32_t *temperature)
 Gets Interface port output power, current(milliamp), voltage drawn by device and temperature(degree celsius) measured at the poe controller hardware. More...
 
open_error_t openapiPoePsePortTimerScheduleNameGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, open_buffdesc *timerName)
 Get timer schedule name for a given interface. More...
 
open_error_t openapiPoePsePortTimerScheduleNameSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, open_buffdesc *timerName)
 Sets the timer schedule name for a given interface. More...
 
open_error_t openapiPoePsePortViolationTypeGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_LIMIT_TYPE_t *violationType)
 Gets violation type of a given interface. More...
 
open_error_t openapiPoePsePortViolationTypeSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t ifNum, OPEN_POE_LIMIT_TYPE_t violationType)
 Sets violation type on a given interface. More...
 
open_error_t openapiPoePseThresholdPowerGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
 Obtain threshold power. More...
 
open_error_t openapiPoePseTotalAvailablePowerGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *power)
 Obtain total available power. More...
 
open_error_t openapiPoeTrapModeGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t *enabled)
 Determine if POE Trap Mode is enabled. More...
 
open_error_t openapiPoeTrapModeSet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_CONTROL_t enabled)
 Sets POE Trap Mode. More...
 

Detailed Description

Enumeration Type Documentation

PoE detection mode.

Enumerator
OPEN_POE_DETECTION_INVALID 

Invalid.

OPEN_POE_DETECTION_LEGACY 

Legacy.

OPEN_POE_DETECTION_4PT_DOT3AF 

4pt dot3af

OPEN_POE_DETECTION_4PT_DOT3AF_LEG 

4pt dot3af leg

OPEN_POE_DETECTION_2PT_DOT3AF 

2pt dot3af

OPEN_POE_DETECTION_2PT_DOT3AF_LEG 

2pt dot3af leg

OPEN_POE_DETECTION_NONE 

None.

OPEN_POE_DETECTION_COUNT 

Count.

Definition at line 110 of file openapi_poe.h.

Enumerator
OPEN_POE_LIMIT_TYPE_INVALID 

Invalid.

OPEN_POE_LIMIT_TYPE_DOT3AF 

Dot3af.

OPEN_POE_LIMIT_TYPE_USER 

User.

OPEN_POE_LIMIT_TYPE_NONE 

None.

OPEN_POE_LIMIT_TYPE_COUNT 

Count.

Definition at line 146 of file openapi_poe.h.

PoE port detection status.

Enumerator
OPEN_POE_PORT_DETECTION_STATUS_INVALID 

Invalid.

OPEN_POE_PORT_DETECTION_STATUS_DISABLED 

Disabled.

OPEN_POE_PORT_DETECTION_STATUS_SEARCHING 

Searching.

OPEN_POE_PORT_DETECTION_STATUS_DELIVERING_POWER 

Delivering Power.

OPEN_POE_PORT_DETECTION_STATUS_TEST 

Test.

OPEN_POE_PORT_DETECTION_STATUS_FAULT 

Fault.

OPEN_POE_PORT_DETECTION_STATUS_OTHER_FAULT 

Other Fault.

OPEN_POE_PORT_DETECTION_STATUS_REQUESTING_POWER 

Requesting Power.

OPEN_POE_PORT_DETECTION_STATUS_OVERLOAD 

Overload.

Definition at line 74 of file openapi_poe.h.

PoE port error code.

Enumerator
OPEN_POE_PORT_FAULT_STATUS_NONE 

None.

OPEN_POE_PORT_FAULT_STATUS_OVLO 

OVLO.

OPEN_POE_PORT_FAULT_STATUS_MPS_ABSENT 

Mps Absent.

OPEN_POE_PORT_FAULT_STATUS_SHORT 

Short.

OPEN_POE_PORT_FAULT_STATUS_OVERLOAD 

Overload.

OPEN_POE_PORT_FAULT_STATUS_POWER_DENIED 

Power Denied.

OPEN_POE_PORT_FAULT_STATUS_THERMAL_SHUTDOWN 

Thermal Shutdown.

OPEN_POE_PORT_FAULT_STATUS_STARTUP_FAILURE 

Startup Failure.

OPEN_POE_PORT_FAULT_STATUS_UVLO 

UVLO.

Definition at line 88 of file openapi_poe.h.

PoE port power class.

Enumerator
OPEN_POE_PORT_POWER_INVALID 

Invalid.

OPEN_POE_PORT_POWER_CLASS0 

Class 0.

OPEN_POE_PORT_POWER_CLASS1 

Class 1.

OPEN_POE_PORT_POWER_CLASS2 

Class 2.

OPEN_POE_PORT_POWER_CLASS3 

Class 3.

OPEN_POE_PORT_POWER_CLASS4 

Class 4.

Definition at line 62 of file openapi_poe.h.

PoE Mgmt Mode.

Enumerator
OPEN_POE_POWER_MGMT_INVALID 

Invalid.

OPEN_POE_POWER_MGMT_STATIC 

Static without Port Priority.

OPEN_POE_POWER_MGMT_DYNAMIC 

Dynamic without Port Priority.

OPEN_POE_POWER_MGMT_STATIC_PRI 

Static with Port Priority.

OPEN_POE_POWER_MGMT_DYNAMIC_PRI 

Dynamic with Port Priority.

OPEN_POE_POWER_MGMT_CLASS 

Class.

Definition at line 158 of file openapi_poe.h.

Enumerator
OPEN_POE_POWER_UP_MODE_INVALID 

Invalid.

OPEN_POE_POWER_UP_MODE_8023AF 

IEEE 802.3af.

OPEN_POE_POWER_UP_MODE_HIGH_INRUSH 

Legacy PD's requiring high inrush current > 400mA.

OPEN_POE_POWER_UP_MODE_PRE_8023AT 

Uses 802.3af inrush , switch to 802.3at inrush immediately with out LLDP.

OPEN_POE_POWER_UP_MODE_8023AT 

IEEE 802.3at.

OPEN_POE_POWER_UP_MODE_UPOE 

Cisco UPOE standard.

OPEN_POE_POWER_UP_MODE_COUNT 

Count.

Definition at line 134 of file openapi_poe.h.

Enumerator
OPEN_POE_PRIORITY_INVALID 

Invalid.

OPEN_POE_PRIORITY_LOW 

Low.

OPEN_POE_PRIORITY_MEDIUM 

Medium.

OPEN_POE_PRIORITY_HIGH 

High.

OPEN_POE_PRIORITY_CRITICAL 

Critical.

OPEN_POE_PRIORITY_COUNT 

Count.

Definition at line 123 of file openapi_poe.h.

PoE main operational status code.

Enumerator
OPEN_POE_SYSTEM_OPER_STATUS_ON 

On.

OPEN_POE_SYSTEM_OPER_STATUS_OFF 

Off.

OPEN_POE_SYSTEM_OPER_STATUS_FAULTY 

Faulty.

Definition at line 102 of file openapi_poe.h.

PoE types.

Enumerator
OPEN_POE_TYPE_POE 

POE.

OPEN_POE_TYPE_POE_PLUS 

POE_PLUS.

OPEN_POE_TYPE_PSE 

PSE.

OPEN_POE_TYPE_PSE_PLUS 

PSE_PLUS.

OPEN_POE_TYPE_PD 

PD.

OPEN_POE_TYPE_PD_PLUS 

PD_PLUS.

OPEN_POE_TYPE_UPOE 

UPOE.

Definition at line 50 of file openapi_poe.h.

Function Documentation

open_error_t openapiPoeFindMaxPowerLimit ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
uint32_t *  maxPowerLimit 
)

Find max power limit based on PoE/PoE+/UPoE for given unit and interface number.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]maxPowerLimitPointer to max power limit
Return values
OPEN_E_NONEIf interface port max power limit returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoeFirstInterfaceGet ( openapiClientHandle_t client_handle,
OPEN_POE_TYPE_t  poeType,
uint32_t  unit,
uint32_t *  ifNum 
)

Get the PoE first interface number.

Parameters
[in]client_handleClient handle from registration API
[in]poeTypePoE type
[in]unitUnit number
[out]ifNumFirst interface number
Return values
OPEN_E_NONEIf PoE first interface number found
OPEN_E_FAILIf PoE first interface number not found
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoeFWImageVersionGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
open_buffdesc version 
)

Obtain POE Firmware Version.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]versionFirmware version string. Passed-in buffer size must be at least OPEN_MAX_POE_CARD_INFO_BUF_SIZE.
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoeIsSupported ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_BOOL_t isSupported 
)

Check to see if PoE is supported on this platform.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]isSupportedReturns OPEN_TRUE if supported, else OPEN_FALSE
Return values
OPEN_E_NONEIf PoE support result returned
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoeIsValidInterface ( openapiClientHandle_t client_handle,
OPEN_POE_TYPE_t  poeType,
uint32_t  ifNum,
OPEN_BOOL_t isValid 
)

Determine if the interface is capable of supporting PoE.

Parameters
[in]client_handleClient handle from registration API
[in]poeTypePoE type
[in]ifNumInterface number
[out]isValidReturns OPEN_TRUE if valid, else OPEN_FALSE
Return values
OPEN_E_NONEIf result return whether interface is capable of supporting PoE
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePethPsePortTimerCtrlClear ( openapiClientHandle_t client_handle,
uint32_t  ifNum 
)

Clear timer schedule association for the port.

(Extended Version)

Parameters
[in]client_handleClient handle from registration API
[in]ifNumInterface number
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther internal failure.

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePseMainAdminEnableSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_CONTROL_t  adminMode 
)

Sets global POE administrative mode .

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]adminModemode setting
Return values
OPEN_E_NONEIf admin mode set successfully
OPEN_E_FAILIf admin mode could not be set
OPEN_E_PARAMIf invalid parameter passed

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePseMainConsumptionPowerGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t *  power 
)

Get the total power consumed for a unit.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]powerPointer to total power consumed
Return values
OPEN_E_NONEIf total power consumed for a given unit returned
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_FAILIf an internal error occured

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoePseMainCurPowerLimitSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  powerLimit 
)

Sets the current watt limit the PSE can deliver on all interfaces.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]powerLimitPower Limit
-Minimum value OPEN_POE_PORT_LIMIT_MIN
-Maximum value openapiPoeFindMaxPowerLimit()
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePseMainCurPowerPrioritySet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_POE_PRIORITY_t  powerPriority 
)

Sets port priority value used in management algorithm on all interfaces.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]powerPriorityPower priority
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePseMainDetectionModeGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_POE_DETECTION_t detectionMode 
)

Gets detection mode of a given unit.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]detectionModePointer to detection mode
Return values
OPEN_E_NONEIf detection mode of a given unit returned
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePseMainDetectionModeSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_POE_DETECTION_t  detectionMode 
)

Sets detection mode of a given unit.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]detectionModeDetection mode
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePseMainOperStatusGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_POE_SYSTEM_OPER_STATUS_t status 
)

Obtain PSE Main Operational Status.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]statusMain operational status
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoePseMainPowerMgmtModeGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_POE_POWER_MGMT_t mode 
)

Get the power management mode of the unit.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]modepointer to Unit's mode ({Returns: OPEN_POE_POWER_MGMT_INVALID, OPEN_POE_POWER_MGMT_CLASS, OPEN_POE_POWER_MGMT_STATIC, OPEN_POE_POWER_MGMT_DYNAMIC, OPEN_POE_POWER_MGMT_STATIC_PRI, OPEN_POE_POWER_MGMT_DYNAMIC_PRI})
Return values
OPEN_E_NONEIf the PoE management mode was obtained.
OPEN_E_FAILIf an internal error occured.
OPEN_E_PARAMIf invalid parameter is passed.

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoePseMainPowerMgmtModeSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_POE_POWER_MGMT_t  mode 
)

Set the power management mode of the unit.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]modeUnit's mode
Return values
OPEN_E_NONEIf the PoE management mode was set.
OPEN_E_FAILIf an internal error occured.
OPEN_E_PARAMIf invalid parameter is passed.
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoePseMainReset ( openapiClientHandle_t client_handle,
uint32_t  unit 
)

Reset PoE on all interfaces.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePseMainUsageThresholdGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t *  threshold 
)

Gets usage threshold in percent.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]thresholdPointer to threshold percent
Return values
OPEN_E_NONEIf threshold of a given unit returned
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePseMainUsageThresholdSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  threshold 
)

Sets usage threshold in percent.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]thresholdThreshold percent
-Minimum percent OPEN_POE_USAGE_THRESHOLD_MIN
-Maximum percent OPEN_POE_USAGE_THRESHOLD_MAX
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortAdminEnableGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t adminMode 
)

Gets an interface's POE administrative mode.

Parameters
[in]client_handleClient handle from registration API
[in]ifNumInterface number
[out]adminModemode setting
Return values
OPEN_E_NONEIf admin mode get successfully
OPEN_E_FAILIf admin mode could not be set
OPEN_E_ERRORIf ifNum does not exist or is invalid
OPEN_E_PARAMIf invalid parameter passed

OpEN API Version: 1.14

Examples:
poe_example.c.
open_error_t openapiPoePsePortAdminEnableSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t  adminMode 
)

Sets an interface's POE administrative mode.

Parameters
[in]client_handleClient handle from registration API
[in]ifNumInterface number
[in]adminModemode setting
Return values
OPEN_E_NONEIf admin mode set successfully
OPEN_E_FAILIf admin mode could not be set
OPEN_E_NOT_FOUNDIf ifNum does not exist or is invalid
OPEN_E_PARAMIf invalid parameter passed

OpEN API Version: 1.14

Examples:
poe_example.c.
open_error_t openapiPoePsePortCountersGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  mpsAbsentCtr,
uint32_t *  invalidSignatureCtr,
uint32_t *  powerDeniedCtr,
uint32_t *  overloadCtr,
uint32_t *  shortCtr 
)

Gets all counters of PSE state machine.

Parameters
[in]client_handleClient handle from registration API
[in]ifNumInterface number
[out]mpsAbsentCtrPointer to MPS absent counter
[out]invalidSignatureCtrPointer to invalid signature counter
[out]powerDeniedCtrPointer to power denied counter
[out]overloadCtrPointer to overload counter
[out]shortCtrPointer to short counter
Return values
OPEN_E_NONEIf PSE state machine counters returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortCurPowerLimitGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
uint32_t *  powerLimit 
)

Gets the current watt limit the PSE can deliver to a port.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]powerLimitPointer to power limit
Return values
OPEN_E_NONEIf interface port current power limit returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortCurPowerLimitSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
uint32_t  powerLimit 
)

Sets the current watt limit the PSE can deliver to a port.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[in]powerLimitPower Limit
-Minimum value OPEN_POE_PORT_LIMIT_MIN
-Maximum value openapiPoeFindMaxPowerLimit()
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortCurPowerPriorityGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_PRIORITY_t powerPriority 
)

Gets interface port priority value used in management algorithm.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]powerPriorityPointer to power priority
Return values
OPEN_E_NONEIf interface port current power priority returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortCurPowerPrioritySet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_PRIORITY_t  powerPriority 
)

Sets interface port priority value used in management algorithm.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[in]powerPriorityPower priority
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortDetectionModeGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_DETECTION_t detectionMode 
)

Gets port detection mode of a given interface.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]detectionModePointer to detection mode
Return values
OPEN_E_NONEIf detection mode of a given interface returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortDetectionModeSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_DETECTION_t  detectionMode 
)

Sets port detection mode on a given interface.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[in]detectionModeDetection mode
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortDetectionStatusGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
uint32_t *  detectionStatus 
)

Gets operational status of the port PD detection.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]detectionStatusPointer to detection status, ({Returns: POE_DISABLED, POE_SEARCHING, POE_DELIVERING_POWER, POE_FAULT, POE_TEST, POE_OTHER_FAULT})
Return values
OPEN_E_NONEIf operational status of the port returned
OPEN_E_FAILIf operational status of the port not returned
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortErrorCodeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  errorCode 
)

Gets Interface port error code.

Parameters
[in]client_handleClient handle from registration API
[in]ifNumInterface number
[out]errorCodePointer to error code
Return values
OPEN_E_NONEIf interface port error code returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortHighPowerGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_CONTROL_t highPower 
)

Gets interface ability to provide POE high power.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]highPowerPointer to high power
Return values
OPEN_E_NONEIf high power mode of a given interface returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

open_error_t openapiPoePsePortHighPowerModeGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_CONTROL_t highPowerMode 
)

Gets interface ability to provide POE high power.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]highPowerModePointer to high power mode
Return values
OPEN_E_NONEIf high power mode of a given interface returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortHighPowerModeSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_CONTROL_t  highPowerMode 
)

Sets interface ability to provide POE high power.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[in]highPowerModeHigh power mode
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortPowerClassificationsGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
uint32_t *  powerClass 
)

Gets interface port terminal classification, eg.

IP phones, WLAN access points, ...

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]powerClassPointer to port classification, (Returns: classification)
Return values
OPEN_E_NONEIf interface port terminal classification returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortPowerUpModeGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_POWER_UP_MODE_t powerUpMode 
)

Gets interface ability of power up.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]powerUpModePointer to power up mode
Return values
OPEN_E_NONEIf power up mode of a given interface returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortPowerUpModeSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_POWER_UP_MODE_t  powerUpMode 
)

Sets interface ability of power up.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[in]powerUpModePower up mode
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortReset ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum 
)

Reset PoE on a given interface.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePsePortSensorsGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
uint32_t *  power,
uint32_t *  current,
uint32_t *  voltage,
uint32_t *  temperature 
)

Gets Interface port output power, current(milliamp), voltage drawn by device and temperature(degree celsius) measured at the poe controller hardware.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]powerPointer to port output power
[out]currentPointer to port output current
[out]voltagePointer to port output voltage
[out]temperaturePointer to port output temperature
Return values
OPEN_E_NONEIf interface port output returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortTimerScheduleNameGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
open_buffdesc timerName 
)

Get timer schedule name for a given interface.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]timerNameTimer schedule name string. Passed-in buffer size must be at least OPEN_MAX_POE_TIMER_NAME_BUF_LEN.
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePsePortTimerScheduleNameSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
open_buffdesc timerName 
)

Sets the timer schedule name for a given interface.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[in]timerNameTimer schedule name string. Passed-in buffer size must be at most OPEN_MAX_POE_TIMER_NAME_BUF_LEN, including the terminating NULL byte.
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

Examples:
poe_example.c.
open_error_t openapiPoePsePortViolationTypeGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_LIMIT_TYPE_t violationType 
)

Gets violation type of a given interface.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[out]violationTypePointer to violation type
Return values
OPEN_E_NONEIf violation type of a given interface returned
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePsePortViolationTypeSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t  ifNum,
OPEN_POE_LIMIT_TYPE_t  violationType 
)

Sets violation type on a given interface.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]ifNumInterface number
[in]violationTypeViolation type
Return values
OPEN_E_NONEIf set operation successful
OPEN_E_FAILIf interface does not exist
OPEN_E_PARAMIf invalid parameter is passed
OPEN_E_UNAVAILIf feature is not supported.

OpEN API Version: 1.8

Examples:
poe_example.c.
open_error_t openapiPoePseThresholdPowerGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t *  power 
)

Obtain threshold power.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]powerThreshold power
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed
Note
Power is returned as milliwatts.

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoePseTotalAvailablePowerGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t *  power 
)

Obtain total available power.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]powerTotal available power
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed
Note
Power is returned as milliwatts.

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoeTrapModeGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_CONTROL_t enabled 
)

Determine if POE Trap Mode is enabled.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]enabledOPEN_ENABLE if enabled, else OPEN_DISABLE
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.18

Examples:
poe_example.c.
open_error_t openapiPoeTrapModeSet ( openapiClientHandle_t client_handle,
uint32_t  unit,
OPEN_CONTROL_t  enabled 
)

Sets POE Trap Mode.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]enabledOPEN_ENABLE if enabled, else OPEN_DISABLE
Return values
OPEN_E_NONEOn success
OPEN_E_FAILOn failure
OPEN_E_PARAMIf invalid parameter is passed

OpEN API Version: 1.19

Examples:
poe_example.c.