Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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 |
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... | |
enum OPEN_POE_DETECTION_t |
PoE detection mode.
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.
Definition at line 74 of file openapi_poe.h.
PoE port error code.
Definition at line 88 of file openapi_poe.h.
PoE port power class.
Definition at line 62 of file openapi_poe.h.
PoE Mgmt Mode.
Definition at line 158 of file openapi_poe.h.
Definition at line 134 of file openapi_poe.h.
enum OPEN_POE_PRIORITY_t |
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.
enum OPEN_POE_TYPE_t |
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.
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | maxPowerLimit | Pointer to max power limit |
OPEN_E_NONE | If interface port max power limit returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | poeType | PoE type |
[in] | unit | Unit number |
[out] | ifNum | First interface number |
OPEN_E_NONE | If PoE first interface number found |
OPEN_E_FAIL | If PoE first interface number not found |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiPoeFWImageVersionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
open_buffdesc * | version | ||
) |
Obtain POE Firmware Version.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | version | Firmware version string. Passed-in buffer size must be at least OPEN_MAX_POE_CARD_INFO_BUF_SIZE. |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.18
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | isSupported | Returns OPEN_TRUE if supported, else OPEN_FALSE |
OPEN_E_NONE | If PoE support result returned |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | poeType | PoE type |
[in] | ifNum | Interface number |
[out] | isValid | Returns OPEN_TRUE if valid, else OPEN_FALSE |
OPEN_E_NONE | If result return whether interface is capable of supporting PoE |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiPoePethPsePortTimerCtrlClear | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum | ||
) |
Clear timer schedule association for the port.
(Extended Version)
[in] | client_handle | Client handle from registration API |
[in] | ifNum | Interface number |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other internal failure. |
OpEN API Version: 1.19
open_error_t openapiPoePseMainAdminEnableSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
OPEN_CONTROL_t | adminMode | ||
) |
Sets global POE administrative mode .
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | adminMode | mode setting |
OPEN_E_NONE | If admin mode set successfully |
OPEN_E_FAIL | If admin mode could not be set |
OPEN_E_PARAM | If invalid parameter passed |
OpEN API Version: 1.19
open_error_t openapiPoePseMainConsumptionPowerGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t * | power | ||
) |
Get the total power consumed for a unit.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | power | Pointer to total power consumed |
OPEN_E_NONE | If total power consumed for a given unit returned |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_FAIL | If an internal error occured |
OpEN API Version: 1.18
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | powerLimit | Power Limit |
- | Minimum value OPEN_POE_PORT_LIMIT_MIN | |
- | Maximum value openapiPoeFindMaxPowerLimit() |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.19
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | powerPriority | Power priority |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.19
open_error_t openapiPoePseMainDetectionModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
OPEN_POE_DETECTION_t * | detectionMode | ||
) |
Gets detection mode of a given unit.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | detectionMode | Pointer to detection mode |
OPEN_E_NONE | If detection mode of a given unit returned |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiPoePseMainDetectionModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
OPEN_POE_DETECTION_t | detectionMode | ||
) |
Sets detection mode of a given unit.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | detectionMode | Detection mode |
OPEN_E_NONE | If set operation successful |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiPoePseMainOperStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
OPEN_POE_SYSTEM_OPER_STATUS_t * | status | ||
) |
Obtain PSE Main Operational Status.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | status | Main operational status |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.18
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | mode | pointer 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}) |
OPEN_E_NONE | If the PoE management mode was obtained. |
OPEN_E_FAIL | If an internal error occured. |
OPEN_E_PARAM | If invalid parameter is passed. |
OpEN API Version: 1.18
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | mode | Unit's mode |
OPEN_E_NONE | If the PoE management mode was set. |
OPEN_E_FAIL | If an internal error occured. |
OPEN_E_PARAM | If invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiPoePseMainReset | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit | ||
) |
Reset PoE on all interfaces.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.19
open_error_t openapiPoePseMainUsageThresholdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t * | threshold | ||
) |
Gets usage threshold in percent.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | threshold | Pointer to threshold percent |
OPEN_E_NONE | If threshold of a given unit returned |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiPoePseMainUsageThresholdSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t | threshold | ||
) |
Sets usage threshold in percent.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | threshold | Threshold percent |
- | Minimum percent OPEN_POE_USAGE_THRESHOLD_MIN | |
- | Maximum percent OPEN_POE_USAGE_THRESHOLD_MAX |
OPEN_E_NONE | If set operation successful |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiPoePsePortAdminEnableGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | adminMode | ||
) |
Gets an interface's POE administrative mode.
[in] | client_handle | Client handle from registration API |
[in] | ifNum | Interface number |
[out] | adminMode | mode setting |
OPEN_E_NONE | If admin mode get successfully |
OPEN_E_FAIL | If admin mode could not be set |
OPEN_E_ERROR | If ifNum does not exist or is invalid |
OPEN_E_PARAM | If invalid parameter passed |
OpEN API Version: 1.14
open_error_t openapiPoePsePortAdminEnableSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | adminMode | ||
) |
Sets an interface's POE administrative mode.
[in] | client_handle | Client handle from registration API |
[in] | ifNum | Interface number |
[in] | adminMode | mode setting |
OPEN_E_NONE | If admin mode set successfully |
OPEN_E_FAIL | If admin mode could not be set |
OPEN_E_NOT_FOUND | If ifNum does not exist or is invalid |
OPEN_E_PARAM | If invalid parameter passed |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[in] | ifNum | Interface number |
[out] | mpsAbsentCtr | Pointer to MPS absent counter |
[out] | invalidSignatureCtr | Pointer to invalid signature counter |
[out] | powerDeniedCtr | Pointer to power denied counter |
[out] | overloadCtr | Pointer to overload counter |
[out] | shortCtr | Pointer to short counter |
OPEN_E_NONE | If PSE state machine counters returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | powerLimit | Pointer to power limit |
OPEN_E_NONE | If interface port current power limit returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[in] | powerLimit | Power Limit |
- | Minimum value OPEN_POE_PORT_LIMIT_MIN | |
- | Maximum value openapiPoeFindMaxPowerLimit() |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | powerPriority | Pointer to power priority |
OPEN_E_NONE | If interface port current power priority returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[in] | powerPriority | Power priority |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | detectionMode | Pointer to detection mode |
OPEN_E_NONE | If detection mode of a given interface returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[in] | detectionMode | Detection mode |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | detectionStatus | Pointer to detection status, ({Returns: POE_DISABLED, POE_SEARCHING, POE_DELIVERING_POWER, POE_FAULT, POE_TEST, POE_OTHER_FAULT}) |
OPEN_E_NONE | If operational status of the port returned |
OPEN_E_FAIL | If operational status of the port not returned |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
open_error_t openapiPoePsePortErrorCodeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | errorCode | ||
) |
Gets Interface port error code.
[in] | client_handle | Client handle from registration API |
[in] | ifNum | Interface number |
[out] | errorCode | Pointer to error code |
OPEN_E_NONE | If interface port error code returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | highPower | Pointer to high power |
OPEN_E_NONE | If high power mode of a given interface returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If 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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | highPowerMode | Pointer to high power mode |
OPEN_E_NONE | If high power mode of a given interface returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[in] | highPowerMode | High power mode |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
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, ...
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | powerClass | Pointer to port classification, (Returns: classification) |
OPEN_E_NONE | If interface port terminal classification returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | powerUpMode | Pointer to power up mode |
OPEN_E_NONE | If power up mode of a given interface returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[in] | powerUpMode | Power up mode |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
open_error_t openapiPoePsePortReset | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t | ifNum | ||
) |
Reset PoE on a given interface.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.19
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | power | Pointer to port output power |
[out] | current | Pointer to port output current |
[out] | voltage | Pointer to port output voltage |
[out] | temperature | Pointer to port output temperature |
OPEN_E_NONE | If interface port output returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | timerName | Timer schedule name string. Passed-in buffer size must be at least OPEN_MAX_POE_TIMER_NAME_BUF_LEN. |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.19
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[in] | timerName | Timer schedule name string. Passed-in buffer size must be at most OPEN_MAX_POE_TIMER_NAME_BUF_LEN, including the terminating NULL byte. |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.19
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[out] | violationType | Pointer to violation type |
OPEN_E_NONE | If violation type of a given interface returned |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | ifNum | Interface number |
[in] | violationType | Violation type |
OPEN_E_NONE | If set operation successful |
OPEN_E_FAIL | If interface does not exist |
OPEN_E_PARAM | If invalid parameter is passed |
OPEN_E_UNAVAIL | If feature is not supported. |
OpEN API Version: 1.8
open_error_t openapiPoePseThresholdPowerGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t * | power | ||
) |
Obtain threshold power.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | power | Threshold power |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.18
open_error_t openapiPoePseTotalAvailablePowerGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t * | power | ||
) |
Obtain total available power.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | power | Total available power |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.18
open_error_t openapiPoeTrapModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
OPEN_CONTROL_t * | enabled | ||
) |
Determine if POE Trap Mode is enabled.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | enabled | OPEN_ENABLE if enabled, else OPEN_DISABLE |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.18
open_error_t openapiPoeTrapModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
OPEN_CONTROL_t | enabled | ||
) |
Sets POE Trap Mode.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | enabled | OPEN_ENABLE if enabled, else OPEN_DISABLE |
OPEN_E_NONE | On success |
OPEN_E_FAIL | On failure |
OPEN_E_PARAM | If invalid parameter is passed |
OpEN API Version: 1.19