Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_BXS_STR_BUFFER_SIZE 128 |
127 chars + terminating nul | |
Enumerations | |
enum | OPEN_BOXS_ITEM_STATE_t { OPEN_ITEMSTATE_NONE = 0, OPEN_ITEMSTATE_NOT_PRESENT = 1, OPEN_ITEMSTATE_OPERATIONAL = 2, OPEN_ITEMSTATE_FAILED = 3, OPEN_ITEMSTATE_POWERING = 4, OPEN_ITEMSTATE_NOPOWER = 5, OPEN_ITEMSTATE_NOT_POWERING = 6, OPEN_ITEMSTATE_INCOMPATIBLE = 7 } |
Item state definition - for power supplies and fans. | |
enum | OPEN_BOXS_ITEM_TYPE_t { OPEN_TYPE_NONE = 0, OPEN_TYPE_FIXED = 1, OPEN_TYPE_REMOVABLE = 2 } |
Item type definitions. | |
enum | OPEN_BOXS_TEMPSENSOR_STATE_t { OPEN_TEMPSENSOR_STATE_NONE = 0, OPEN_TEMPSENSOR_STATE_LOW = 1, OPEN_TEMPSENSOR_STATE_NORMAL = 2, OPEN_TEMPSENSOR_STATE_WARNING = 3, OPEN_TEMPSENSOR_STATE_CRITICAL = 4, OPEN_TEMPSENSOR_STATE_SHUTDOWN = 5, OPEN_TEMPSENSOR_STATE_NOTPRESENT = 6, OPEN_TEMPSENSOR_STATE_NOTOPERATIONAL = 7 } |
Item state definition - for thermal sensors. | |
enum | OPEN_LED_CMD_t { OPEN_LED_CMD_OFF = 0, OPEN_LED_CMD_ON = 1 } |
enum | OPEN_LED_STATUS_t { OPEN_LED_STATUS_OFF = 0, OPEN_LED_STATUS_ON = 1 } |
enum | OPEN_SFP_MODULE_TYPE_t { OPEN_MODULE_NONE = 0, OPEN_MODULE_SFP = 1, OPEN_MODULE_SFPPLUS = 2, OPEN_MODULE_QSFP = 3, OPEN_MODULE_DAC = 4, OPEN_MODULE_AX741 = 5, OPEN_MODULE_AX742 = 6, OPEN_MODULE_AX743 = 7, OPEN_MODULE_AX744 = 8, OPEN_MODULE_AX745 = 9 } |
Functions | |
open_error_t | openapiBoxsFanDescripGet (openapiClientHandle_t *client_handle, uint32_t fanNum, open_buffdesc *descrip) |
Gets the description of a given fan. More... | |
open_error_t | openapiBoxsFanDescripSizeGet (openapiClientHandle_t *client_handle, uint32_t *descripSize) |
Gets the maximum size for the fan description. More... | |
open_error_t | openapiBoxsFanDutyCycleGet (openapiClientHandle_t *client_handle, uint32_t fanNum, uint32_t *fanDuty) |
Gets the duty-cycle of a given fan number. More... | |
open_error_t | openapiBoxsFanSpeedGet (openapiClientHandle_t *client_handle, uint32_t fanNum, uint32_t *fanSpeed) |
Gets the speed of a given fan number. More... | |
open_error_t | openapiBoxsFanStateGet (openapiClientHandle_t *client_handle, uint32_t fanNum, OPEN_BOXS_ITEM_STATE_t *fanState) |
Gets the state of a given fan number. More... | |
open_error_t | openapiBoxsFanTypeGet (openapiClientHandle_t *client_handle, uint32_t fanNum, OPEN_BOXS_ITEM_TYPE_t *fanType) |
Gets the type of a given fan number. More... | |
open_error_t | openapiBoxsGeneralTempGet (openapiClientHandle_t *client_handle, uint32_t *genTemp) |
Gets the general temperature of the system. More... | |
open_error_t | openapiBoxsHwVersionGet (openapiClientHandle_t *client_handle, uint32_t *version) |
Gets the board revision number on the unit. More... | |
open_error_t | openapiBoxsiGeneralFanDutyLevelGet (openapiClientHandle_t *client_handle, uint32_t *genFanDutyLevel) |
Gets the general fan duty-level. More... | |
open_error_t | openapiBoxsiGeneralFanSpeedGet (openapiClientHandle_t *client_handle, uint32_t *genFanSpeed) |
Gets the general fan speed. More... | |
open_error_t | openapiBoxsNumOfFansGet (openapiClientHandle_t *client_handle, uint32_t *numFans) |
Gets the maximum number of FANs on the unit. More... | |
open_error_t | openapiBoxsNumOfPowSuppliesGet (openapiClientHandle_t *client_handle, uint32_t *numPowSuplies) |
Gets the maximum number of power supplies in the unit. More... | |
open_error_t | openapiBoxsNumOfTempSensorsGet (openapiClientHandle_t *client_handle, uint32_t *numOfTempSemsors) |
Gets the maximum number of temperature sensors in the unit. More... | |
open_error_t | openapiBoxsPortLedsModeGet (openapiClientHandle_t *client_handle, OPEN_LED_STATUS_t *val) |
Gets port and PoE LED status on the given interface(s). More... | |
open_error_t | openapiBoxsPortLedsModeSet (openapiClientHandle_t *client_handle, OPEN_LED_CMD_t val) |
Turns on/off port and PoE LEDs on the given interface(s). More... | |
open_error_t | openapiBoxsPowSupplyDescripGet (openapiClientHandle_t *client_handle, uint32_t psNum, open_buffdesc *descrip) |
Gets the description of a given power supply. More... | |
open_error_t | openapiBoxsPowSupplyDescripSizeGet (openapiClientHandle_t *client_handle, uint32_t *descripSize) |
Gets the maximum size for the power supply description. More... | |
open_error_t | openapiBoxsPowSupplyStateGet (openapiClientHandle_t *client_handle, uint32_t psNo, OPEN_BOXS_ITEM_STATE_t *psState) |
Gets the status of a given power supply. More... | |
open_error_t | openapiBoxsPowSupplyTypeGet (openapiClientHandle_t *client_handle, uint32_t psNo, OPEN_BOXS_ITEM_TYPE_t *psType) |
Gets the type of a given power supply. More... | |
open_error_t | openapiBoxsSfpComplianceGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *complianceDesc) |
Gets the compliance of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpComplianceSizeGet (openapiClientHandle_t *client_handle, uint32_t *complianceSize) |
Gets the size of compliance of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpLinkLength50umGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *linkLength50um) |
Gets the Link Length(50um) of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpLinkLength62_5umGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *linkLength62_5um) |
Gets the Link Length(62_5um) of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpNominalSignalRate (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nominalSigRate) |
Gets the Nominal Signal Rate of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpPartNumberGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *partNumberDesc) |
Gets the SFP transceiver part number. More... | |
open_error_t | openapiBoxsSfpPartNumberSizeGet (openapiClientHandle_t *client_handle, uint32_t *partNumberSize) |
Gets the size of part number of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpSerialNumberGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *serialNumberDesc) |
Gets the SFP transceiver serial number. More... | |
open_error_t | openapiBoxsSfpSerialNumberSizeGet (openapiClientHandle_t *client_handle, uint32_t *serialNumberSize) |
Gets the size of serial number of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_SFP_MODULE_TYPE_t *moduleType) |
Gets the SFP module type. More... | |
open_error_t | openapiBoxsSfpVendorNameGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vendorNameDesc) |
Gets the SFP transceiver vendor name. More... | |
open_error_t | openapiBoxsSfpVendorNameSizeGet (openapiClientHandle_t *client_handle, uint32_t *vendorNameSize) |
Gets the size if vendor name of SFP transceiver. More... | |
open_error_t | openapiBoxsSfpVendorRevisionGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vendorRevDesc) |
Gets the SFP transceiver vendor revision number. More... | |
open_error_t | openapiBoxsSfpVendorRevSizeGet (openapiClientHandle_t *client_handle, uint32_t *vendorRevSize) |
Gets the size of vendor revision of SFP transceiver. More... | |
open_error_t | openapiBoxsSystemLedModeGet (openapiClientHandle_t *client_handle, OPEN_LED_STATUS_t *val) |
Gets system LED status. More... | |
open_error_t | openapiBoxsSystemLedModeSet (openapiClientHandle_t *client_handle, OPEN_LED_CMD_t val) |
Turns on/off system LEDs. More... | |
open_error_t | openapiBoxsTempGet (openapiClientHandle_t *client_handle, uint32_t sensorNum, uint32_t *temperature) |
Gets the temperature value read by the given temperature sensor. More... | |
open_error_t | openapiBoxsTempRangeGet (openapiClientHandle_t *client_handle, uint32_t *minTemp, uint32_t *maxTemp) |
Gets allowed temperature range for normal operation. More... | |
open_error_t | openapiBoxsTempSensorDescripGet (openapiClientHandle_t *client_handle, uint32_t sensorNum, open_buffdesc *descrip) |
Gets the description of a given temperature sensor. More... | |
open_error_t | openapiBoxsTempSensorDescripSizeGet (openapiClientHandle_t *client_handle, uint32_t *descripSize) |
Gets the maximum size for the temperature sensor description. More... | |
open_error_t | openapiBoxsTempSensorMaxTempGet (openapiClientHandle_t *client_handle, uint32_t sensorNum, uint32_t *maxTemperature) |
Gets the maximum temperature of a given temperature sensor. More... | |
open_error_t | openapiBoxsTempSensorStatusGet (openapiClientHandle_t *client_handle, uint32_t sensorNum, OPEN_BOXS_TEMPSENSOR_STATE_t *state) |
Gets the state of a given temperature sensor. More... | |
open_error_t | openapiCpldVersionGet (openapiClientHandle_t *client_handle, open_buffdesc *cpldVersion) |
Get the CPLD version of the system. More... | |
open_error_t | openapiFiberPortsLaneOpticsGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t lane, uint32_t *temperature, uint32_t *voltage, uint32_t *current, open_buffdesc *powerIn, open_buffdesc *powerOut, OPEN_BOOL_t *txFault, OPEN_BOOL_t *los) |
Test the fiber cable and return information on a per lane basis. More... | |
open_error_t | openapiFiberPortsOpticsFaultStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *localFaultStatus, uint32_t *remoteFaultStatus) |
Get the fault status of fiber port optical transceiver. More... | |
open_error_t | openapiFiberPortsOpticsGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *temperature, uint32_t *voltage, uint32_t *current, uint64_t *powerIn, uint64_t *powerOut, OPEN_BOOL_t *txFault, OPEN_BOOL_t *los) |
Get the diagnostic data for fiber ports optical transceiver. More... | |
open_error_t | openapiFiberPortsTransceiverPresenceGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *present) |
Get the transceiver presence status for fiber ports. More... | |
open_error_t | openapiPortLocatorGlobalDisable (openapiClientHandle_t *client_handle) |
Disables port locator globally. More... | |
open_error_t | openapiPortLocatorInterfaceEnable (openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t enable) |
enable or disable port locator on an interface More... | |
Definition at line 77 of file openapi_boxs.h.
open_error_t openapiBoxsFanDescripGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fanNum, | ||
open_buffdesc * | descrip | ||
) |
Gets the description of a given fan.
[in] | client_handle | Client handle from registration API |
[in] | fanNum | Fan number, ZERO to maximum. |
[out] | descrip | Description of the temperature sensor. Use "openapiBoxsFanDescripSizeGet()" to get the size of the description. |
OPEN_E_NONE | Returned size of fan description. |
OPEN_E_FAIL | Failed to get fan description size. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsFanDescripSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | descripSize | ||
) |
Gets the maximum size for the fan description.
[in] | client_handle | client handle from registration API |
[out] | descripSize | size for the fan description. |
OPEN_E_NONE | Returned fan description size. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsFanDutyCycleGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fanNum, | ||
uint32_t * | fanDuty | ||
) |
Gets the duty-cycle of a given fan number.
[in] | client_handle | client handle from registration API |
[in] | fanNum | fan number, ZERO to maximum. |
[out] | fanDuty | duty-cycle of the fan. |
OPEN_E_NONE | duty-cycle of the fan returned. |
OPEN_E_FAIL | Failed to get the duty-cycle of the fan. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsFanSpeedGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fanNum, | ||
uint32_t * | fanSpeed | ||
) |
Gets the speed of a given fan number.
[in] | client_handle | client handle from registration API |
[in] | fanNum | fan number, ZERO to maximum. |
[out] | fanSpeed | speed of the fan. |
OPEN_E_NONE | speed of the fan get successfully. |
OPEN_E_FAIL | Failed to get the speed of the fan. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsFanStateGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fanNum, | ||
OPEN_BOXS_ITEM_STATE_t * | fanState | ||
) |
Gets the state of a given fan number.
[in] | client_handle | client handle from registration API |
[in] | fanNum | fan number, ZERO to maximum. |
[out] | fanState | state of the fan. |
OPEN_E_NONE | state of the fan returned. |
OPEN_E_FAIL | Failed to get the state of the fan. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsFanTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | fanNum, | ||
OPEN_BOXS_ITEM_TYPE_t * | fanType | ||
) |
Gets the type of a given fan number.
[in] | client_handle | client handle from registration API |
[in] | fanNum | fan number, ZERO to maximum. |
[out] | fanType | type of the fan. |
OPEN_E_NONE | type of the fan returned. |
OPEN_E_FAIL | Failed to get the type of the fan. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsGeneralTempGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | genTemp | ||
) |
Gets the general temperature of the system.
[in] | client_handle | client handle from registration API |
[out] | genTemp | general temperature read from system. |
OPEN_E_NONE | Returned general temperature value. |
OPEN_E_FAIL | Failed to get general temperature. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsHwVersionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | version | ||
) |
Gets the board revision number on the unit.
[in] | client_handle | client handle from registration API |
[out] | version | Board version on the unit. |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Failed to get board revision. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.19
open_error_t openapiBoxsiGeneralFanDutyLevelGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | genFanDutyLevel | ||
) |
Gets the general fan duty-level.
[in] | client_handle | client handle from registration API |
[out] | genFanDutyLevel | General fan duty-level. |
OPEN_E_NONE | Returned general duty-level of the fan. |
OPEN_E_FAIL | Failed to get general fan duty-cycle. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsiGeneralFanSpeedGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | genFanSpeed | ||
) |
Gets the general fan speed.
[in] | client_handle | client handle from registration API |
[out] | genFanSpeed | general speed of the fans. |
OPEN_E_NONE | Returned general fan speed. |
OPEN_E_FAIL | Failed to get the general fan speed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsNumOfFansGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | numFans | ||
) |
Gets the maximum number of FANs on the unit.
[in] | client_handle | client handle from registration API |
[out] | numFans | maximum number of fans. |
OPEN_E_NONE | maximum number of fans supported returned. |
OPEN_E_FAIL | Failed to get the maximum number of fans . |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsNumOfPowSuppliesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | numPowSuplies | ||
) |
Gets the maximum number of power supplies in the unit.
[in] | client_handle | client handle from registration API |
[out] | numPowSuplies | maximum number of power supplies. |
OPEN_E_NONE | maximum number of power supplies get successfully. |
OPEN_E_FAIL | Failed to get the maximum number of power supplies. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsNumOfTempSensorsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | numOfTempSemsors | ||
) |
Gets the maximum number of temperature sensors in the unit.
[in] | client_handle | client handle from registration API |
[out] | numOfTempSemsors | maximum number of temperature sensors. |
OPEN_E_NONE | maximum number of temperature sensors get successfully. |
OPEN_E_FAIL | Failed to get the maximum number of temperature sensors. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsPortLedsModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_LED_STATUS_t * | val | ||
) |
Gets port and PoE LED status on the given interface(s).
[in] | client_handle | client handle from registration API |
[out] | val | LED status |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | If feature is not supported. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.19
open_error_t openapiBoxsPortLedsModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_LED_CMD_t | val | ||
) |
Turns on/off port and PoE LEDs on the given interface(s).
[in] | client_handle | client handle from registration API |
[in] | val | Turn on/off the LED |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_EXISTS | Already configured. |
OPEN_E_UNAVAIL | If feature is not supported. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.19
open_error_t openapiBoxsPowSupplyDescripGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | psNum, | ||
open_buffdesc * | descrip | ||
) |
Gets the description of a given power supply.
[in] | client_handle | Client handle from registration API |
[in] | psNum | Power supply number, ZERO to maximum. |
[out] | descrip | Description of the power supply. Use "openapiBoxsPowSupplyDescripSizeGet()" to get size of the description. |
OPEN_E_NONE | Returned size of power supply description. |
OPEN_E_FAIL | Failed to get power supply description size. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsPowSupplyDescripSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | descripSize | ||
) |
Gets the maximum size for the power supply description.
[in] | client_handle | client handle from registration API |
[out] | descripSize | size for the power supply description. |
OPEN_E_NONE | Returned power supply description size. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsPowSupplyStateGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | psNo, | ||
OPEN_BOXS_ITEM_STATE_t * | psState | ||
) |
Gets the status of a given power supply.
[in] | client_handle | client handle from registration API |
[in] | psNo | power supply number, ZERO to maximum. |
[out] | psState | state of the power supply. |
OPEN_E_NONE | state of the power supply returned. |
OPEN_E_FAIL | Failed to get the state of the power supply. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsPowSupplyTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | psNo, | ||
OPEN_BOXS_ITEM_TYPE_t * | psType | ||
) |
Gets the type of a given power supply.
[in] | client_handle | client handle from registration API |
[in] | psNo | power supply number, ZERO to maximum. |
[out] | psType | type of the power supply. |
OPEN_E_NONE | type of the power supply returned. |
OPEN_E_FAIL | Failed to get the type of the power supply. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpComplianceGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | complianceDesc | ||
) |
Gets the compliance of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve the SFP compliance. |
[out] | complianceDesc | buff descriptor to get compliance of the SFP transceiver. |
OPEN_E_NONE | Compliance returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpComplianceSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | complianceSize | ||
) |
Gets the size of compliance of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[out] | complianceSize | size of SFP compliance. |
OPEN_E_NONE | size of SFP compliance returned successfully. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpLinkLength50umGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | linkLength50um | ||
) |
Gets the Link Length(50um) of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve the link length (50um) of SFP transceiver. |
[out] | linkLength50um | Link length(50um) of the SFP transceiver. |
OPEN_E_NONE | Link Length(50um) returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpLinkLength62_5umGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | linkLength62_5um | ||
) |
Gets the Link Length(62_5um) of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve the link length (62_5um) of SFP transceiver. |
[out] | linkLength62_5um | Link length(62.5um) of the SFP transceiver. |
OPEN_E_NONE | Link Length(62.5um) returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpNominalSignalRate | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | nominalSigRate | ||
) |
Gets the Nominal Signal Rate of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve the Nominal Signal Rate of SFP transceiver. |
[out] | nominalSigRate | buff descriptor to get Nominal Signal Rate of the SFP transceiver. |
OPEN_E_NONE | Nominal Signal Rate returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpPartNumberGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | partNumberDesc | ||
) |
Gets the SFP transceiver part number.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve SFP part number. |
[out] | partNumberDesc | buff descriptor to get part number of the SFP transceiver. |
OPEN_E_NONE | Serial number returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpPartNumberSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | partNumberSize | ||
) |
Gets the size of part number of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[out] | partNumberSize | size of SFP part number. |
OPEN_E_NONE | size of SFP part number returned successfully. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpSerialNumberGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | serialNumberDesc | ||
) |
Gets the SFP transceiver serial number.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve SFP serial number. |
[out] | serialNumberDesc | buff descriptor to get serial number of the SFP transceiver. |
OPEN_E_NONE | Serial number returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpSerialNumberSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | serialNumberSize | ||
) |
Gets the size of serial number of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[out] | serialNumberSize | size of SFP serial number. |
OPEN_E_NONE | size of SFP serial number returned successfully. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_SFP_MODULE_TYPE_t * | moduleType | ||
) |
Gets the SFP module type.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to get the type. |
[out] | moduleType | type of module. |
OPEN_E_NONE | Interface type returned successfully. |
OPEN_E_FAIL | Failed to get the interface type. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpVendorNameGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | vendorNameDesc | ||
) |
Gets the SFP transceiver vendor name.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve SFP vendor name. |
[out] | vendorNameDesc | buff descriptor to get vendor name of the SFP transceiver. |
OPEN_E_NONE | Vendor name returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpVendorNameSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | vendorNameSize | ||
) |
Gets the size if vendor name of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[out] | vendorNameSize | size of SFP vendor name. |
OPEN_E_NONE | size of SFP vendor name returned successfully. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpVendorRevisionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | vendorRevDesc | ||
) |
Gets the SFP transceiver vendor revision number.
[in] | client_handle | client handle from registration API. |
[in] | ifNum | interface ID to retrieve SFP vendor revision. |
[out] | vendorRevDesc | buff descriptor to get vendor revision. |
OPEN_E_NONE | Serial number returned successfully. |
OPEN_E_FAIL | Failed to get the transceiver data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSfpVendorRevSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | vendorRevSize | ||
) |
Gets the size of vendor revision of SFP transceiver.
[in] | client_handle | client handle from registration API. |
[out] | vendorRevSize | size of SFP vendor revision. |
OPEN_E_NONE | size of SFP vendor revision returned successfully. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiBoxsSystemLedModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_LED_STATUS_t * | val | ||
) |
Gets system LED status.
[in] | client_handle | client handle from registration API |
[out] | val | LED status |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | If feature is not supported. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.19
open_error_t openapiBoxsSystemLedModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_LED_CMD_t | val | ||
) |
Turns on/off system LEDs.
[in] | client_handle | client handle from registration API |
[in] | val | Turn on/off the LED |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_EXISTS | Already configured. |
OPEN_E_UNAVAIL | If feature is not supported. |
OPEN_E_INTERNAL | Internal error. |
OpEN API Version: 1.19
open_error_t openapiBoxsTempGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | sensorNum, | ||
uint32_t * | temperature | ||
) |
Gets the temperature value read by the given temperature sensor.
[in] | client_handle | client handle from registration API |
[in] | sensorNum | temperature sensor number, ZERO to maximum. |
[out] | temperature | temperature value read by the sensor. |
OPEN_E_NONE | Returned sensor temperature successfully. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsTempRangeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | minTemp, | ||
uint32_t * | maxTemp | ||
) |
Gets allowed temperature range for normal operation.
[in] | client_handle | client handle from registration API |
[out] | minTemp | Minimum value in range |
[out] | maxTemp | Maximum value in range |
OPEN_E_NONE | Returned allowed temperature range. |
OPEN_E_FAIL | Failed to get temperature range. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiBoxsTempSensorDescripGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | sensorNum, | ||
open_buffdesc * | descrip | ||
) |
Gets the description of a given temperature sensor.
[in] | client_handle | client handle from registration API |
[in] | sensorNum | temperature sensor number, ZERO to maximum. |
[out] | descrip | description of the temperature sensor. use "openapiBoxsTempSensorDescripSizeGet()" to get the size of the description. |
OPEN_E_NONE | The description of the temperature sensor returned. |
OPEN_E_FAIL | Failed to get the description of the temperature sensor. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsTempSensorDescripSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | descripSize | ||
) |
Gets the maximum size for the temperature sensor description.
[in] | client_handle | client handle from registration API |
[out] | descripSize | size for the temperature sensor description. |
OPEN_E_NONE | size for the temperature sensor description returned. |
OPEN_E_FAIL | Failed to get the size for the temperature sensor description. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.1
open_error_t openapiBoxsTempSensorMaxTempGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | sensorNum, | ||
uint32_t * | maxTemperature | ||
) |
Gets the maximum temperature of a given temperature sensor.
[in] | client_handle | client handle from registration API |
[in] | sensorNum | temperature sensor number, ZERO to maximum. |
[out] | maxTemperature | maximum temperature of the given sensor. |
OPEN_E_NONE | Returned Maximum temperature of the sensor. |
OPEN_E_FAIL | Failed to get maximum temperature of the sensor. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Feature is not supported. |
OpEN API Version: 1.15
open_error_t openapiBoxsTempSensorStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | sensorNum, | ||
OPEN_BOXS_TEMPSENSOR_STATE_t * | state | ||
) |
Gets the state of a given temperature sensor.
[in] | client_handle | client handle from registration API |
[in] | sensorNum | temperature sensor number, ZERO to maximum. |
[out] | state | state of the temperature sensorNum. |
OPEN_E_NONE | State of the temperature sensor returned. |
OPEN_E_FAIL | Failed to get the state of the temperature sensor. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiCpldVersionGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | cpldVersion | ||
) |
Get the CPLD version of the system.
[in] | client_handle | Client handle from registration API |
[out] | cpldVersion | Pointer to CPLD version string storage
|
OPEN_E_NONE | if operation is successful |
OPEN_E_FAIL | if operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if no device exist or not supported |
OpEN API Version: 1.15
open_error_t openapiFiberPortsLaneOpticsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | lane, | ||
uint32_t * | temperature, | ||
uint32_t * | voltage, | ||
uint32_t * | current, | ||
open_buffdesc * | powerIn, | ||
open_buffdesc * | powerOut, | ||
OPEN_BOOL_t * | txFault, | ||
OPEN_BOOL_t * | los | ||
) |
Test the fiber cable and return information on a per lane basis.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[in] | lane | Lane number Can be determined using openapiIfExpPortOperModeLaneCountGet() |
[out] | temperature | Temperature (degrees C) |
[out] | voltage | Voltage (milliVolts) |
[out] | current | Current (milliAmps) |
[out] | powerIn | Power Input (microWatts) |
[out] | powerOut | Power output (microWatts) |
[out] | txFault | Transmit Fault |
[out] | los | Loss of signal |
OPEN_E_NONE | Fiber ports diagnostic data obtained successfully. |
OPEN_E_INTERNAL | Failed to accommadate output string. |
OPEN_E_NOT_FOUND | Fiber ports diagnostic data not found. |
OPEN_E_ERROR | Failed to fetch the fiber port diagnostic data or the interface does not exist |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiFiberPortsOpticsFaultStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | localFaultStatus, | ||
uint32_t * | remoteFaultStatus | ||
) |
Get the fault status of fiber port optical transceiver.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | localFaultStatus | local fault status (non-zero value indicates fault.) |
[out] | remoteFaultStatus | remote fault status (non-zero value indicates fault.) |
OPEN_E_NONE | Status obtained successfully. |
OPEN_E_ERROR | Failed to fetch the fiber port fault status or the interface does not exist |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.14
open_error_t openapiFiberPortsOpticsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | temperature, | ||
uint32_t * | voltage, | ||
uint32_t * | current, | ||
uint64_t * | powerIn, | ||
uint64_t * | powerOut, | ||
OPEN_BOOL_t * | txFault, | ||
OPEN_BOOL_t * | los | ||
) |
Get the diagnostic data for fiber ports optical transceiver.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | temperature | Temperature (degrees C) |
[out] | voltage | Voltage (milliVolts) |
[out] | current | Current (milliAmps) |
[out] | powerIn | Power Input (microWatts) |
[out] | powerOut | Power output (microWatts) |
[out] | txFault | Transmit Fault |
[out] | los | Loss of signal |
OPEN_E_NONE | Fiber ports diagnostic data obtained successfully. |
OPEN_E_NOT_FOUND | Fiber ports diagnostic data not found. |
OPEN_E_ERROR | Failed to fetch the fiber port diagnostic data or the interface does not exist |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.14
open_error_t openapiFiberPortsTransceiverPresenceGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_BOOL_t * | present | ||
) |
Get the transceiver presence status for fiber ports.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface number |
- | Minimum value 1 | |
- | Maximum value openapiMaxInterfaceCountGet() | |
[out] | present | Transceiver presence status |
OPEN_E_NONE | Presence status obtained successfully. |
OPEN_E_ERROR | Could not determine status. Possibly due to an invalid interface number or not a fiber port. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Not supported for this platform. |
OpEN API Version: 1.15
open_error_t openapiPortLocatorGlobalDisable | ( | openapiClientHandle_t * | client_handle | ) |
Disables port locator globally.
[in] | client_handle | client handle from registration API. |
OPEN_E_NONE | |
OPEN_E_UNAVAIL | Not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiPortLocatorInterfaceEnable | ( | openapiClientHandle_t * | client_handle, |
uint32_t | interface, | ||
OPEN_CONTROL_t | enable | ||
) |
enable or disable port locator on an interface
[in] | client_handle | client handle from registration API. |
[in] | interface | interface to enable or disable. |
[in] | enable | port operation mode. |
OPEN_E_NONE | |
OPEN_E_UNAVAIL | Not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1