38 #ifndef OPENAPI_BOXS_H_INCLUDED
39 #define OPENAPI_BOXS_H_INCLUDED
46 OPEN_ITEMSTATE_NONE = 0,
47 OPEN_ITEMSTATE_NOT_PRESENT = 1,
48 OPEN_ITEMSTATE_OPERATIONAL = 2,
49 OPEN_ITEMSTATE_FAILED = 3,
50 OPEN_ITEMSTATE_POWERING = 4,
51 OPEN_ITEMSTATE_NOPOWER = 5,
52 OPEN_ITEMSTATE_NOT_POWERING = 6,
53 OPEN_ITEMSTATE_INCOMPATIBLE = 7
59 OPEN_TEMPSENSOR_STATE_NONE = 0,
60 OPEN_TEMPSENSOR_STATE_LOW = 1,
61 OPEN_TEMPSENSOR_STATE_NORMAL = 2,
62 OPEN_TEMPSENSOR_STATE_WARNING = 3,
63 OPEN_TEMPSENSOR_STATE_CRITICAL = 4,
64 OPEN_TEMPSENSOR_STATE_SHUTDOWN = 5,
65 OPEN_TEMPSENSOR_STATE_NOTPRESENT = 6,
66 OPEN_TEMPSENSOR_STATE_NOTOPERATIONAL = 7
74 OPEN_TYPE_REMOVABLE = 2
99 OPEN_LED_STATUS_OFF = 0,
100 OPEN_LED_STATUS_ON = 1
103 #define OPEN_BXS_STR_BUFFER_SIZE 128
128 open_error_t openapiFiberPortsOpticsFaultStatusGet(openapiClientHandle_t *client_handle, uint32_t ifNum,
129 uint32_t *localFaultStatus, uint32_t *remoteFaultStatus);
159 uint32_t *temperature, uint32_t *voltage, uint32_t *current,
160 uint64_t *powerIn, uint64_t *powerOut,
196 uint32_t *temperature, uint32_t *voltage, uint32_t *current,
238 uint32_t * genFanSpeed);
255 uint32_t * genFanDutyLevel);
290 uint32_t fanNum, uint32_t * fanSpeed);
347 uint32_t fanNum, uint32_t * fanDuty);
364 uint32_t * descripSize);
404 uint32_t * numPowSuplies);
422 client_handle, uint32_t psNo,
441 client_handle, uint32_t psNo,
459 uint32_t * descripSize);
537 uint32_t * numOfTempSemsors);
555 uint32_t * descripSize);
593 uint32_t sensorNum, uint32_t * temperature);
610 client_handle, uint32_t sensorNum,
632 uint32_t * maxTemperature);
751 uint32_t ifNum, uint32_t *linkLength50um);
769 uint32_t ifNum, uint32_t *linkLength62_5um);
788 uint32_t ifNum, uint32_t *nominalSigRate);
824 uint32_t *vendorNameSize);
839 uint32_t *serialNumberSize);
854 uint32_t *partNumberSize);
869 uint32_t *vendorRevSize);
884 uint32_t *complianceSize);
989 OPEN_LED_STATUS_t *val);
1008 OPEN_LED_CMD_t val);
1026 OPEN_LED_STATUS_t *val);
open_error_t openapiBoxsSfpPartNumberGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *partNumberDesc)
Gets the SFP transceiver part number.
open_error_t openapiBoxsTempRangeGet(openapiClientHandle_t *client_handle, uint32_t *minTemp, uint32_t *maxTemp)
Gets allowed temperature range for normal operation.
open_error_t openapiBoxsFanDutyCycleGet(openapiClientHandle_t *client_handle, uint32_t fanNum, uint32_t *fanDuty)
Gets the duty-cycle of a given fan number.
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.
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.
open_error_t openapiBoxsTempSensorDescripGet(openapiClientHandle_t *client_handle, uint32_t sensorNum, open_buffdesc *descrip)
Gets the description of a given temperature sensor.
OPEN_BOXS_TEMPSENSOR_STATE_t
Item state definition - for thermal sensors.
open_error_t openapiBoxsFanDescripSizeGet(openapiClientHandle_t *client_handle, uint32_t *descripSize)
Gets the maximum size for the fan description.
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.
open_error_t openapiBoxsSfpSerialNumberSizeGet(openapiClientHandle_t *client_handle, uint32_t *serialNumberSize)
Gets the size of serial number of SFP transceiver.
open_error_t openapiBoxsSfpVendorNameSizeGet(openapiClientHandle_t *client_handle, uint32_t *vendorNameSize)
Gets the size if vendor name of SFP transceiver.
open_error_t openapiBoxsSfpPartNumberSizeGet(openapiClientHandle_t *client_handle, uint32_t *partNumberSize)
Gets the size of part number of SFP transceiver.
open_error_t
OPEN uses these enumerators to indicate the error codes.
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.
open_error_t openapiBoxsPortLedsModeGet(openapiClientHandle_t *client_handle, OPEN_LED_STATUS_t *val)
Gets port and PoE LED status on the given interface(s).
open_error_t openapiBoxsSfpNominalSignalRate(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nominalSigRate)
Gets the Nominal Signal Rate of SFP transceiver.
SFP+ plugin module, AX743.
open_error_t openapiBoxsiGeneralFanDutyLevelGet(openapiClientHandle_t *client_handle, uint32_t *genFanDutyLevel)
Gets the general fan duty-level.
open_error_t openapiPortLocatorInterfaceEnable(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t enable)
enable or disable port locator on an interface
open_error_t openapiBoxsTempGet(openapiClientHandle_t *client_handle, uint32_t sensorNum, uint32_t *temperature)
Gets the temperature value read by the given temperature sensor.
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).
open_error_t openapiPortLocatorGlobalDisable(openapiClientHandle_t *client_handle)
Disables port locator globally.
CX4 plugin module, AX744.
open_error_t openapiBoxsPowSupplyDescripGet(openapiClientHandle_t *client_handle, uint32_t psNum, open_buffdesc *descrip)
Gets the description of a given power supply.
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.
open_error_t openapiBoxsTempSensorDescripSizeGet(openapiClientHandle_t *client_handle, uint32_t *descripSize)
Gets the maximum size for the temperature sensor description.
open_error_t openapiBoxsHwVersionGet(openapiClientHandle_t *client_handle, uint32_t *version)
Gets the board revision number on the unit.
open_error_t openapiBoxsSystemLedModeSet(openapiClientHandle_t *client_handle, OPEN_LED_CMD_t val)
Turns on/off system LEDs.
XFP, AX741, 10G plugin module.
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.
open_error_t openapiCpldVersionGet(openapiClientHandle_t *client_handle, open_buffdesc *cpldVersion)
Get the CPLD version of the system.
open_error_t openapiBoxsSfpComplianceSizeGet(openapiClientHandle_t *client_handle, uint32_t *complianceSize)
Gets the size of compliance of SFP transceiver.
open_error_t openapiBoxsFanDescripGet(openapiClientHandle_t *client_handle, uint32_t fanNum, open_buffdesc *descrip)
Gets the description of a given fan.
open_error_t openapiBoxsNumOfPowSuppliesGet(openapiClientHandle_t *client_handle, uint32_t *numPowSuplies)
Gets the maximum number of power supplies in the unit.
open_error_t openapiBoxsNumOfFansGet(openapiClientHandle_t *client_handle, uint32_t *numFans)
Gets the maximum number of FANs on the unit.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
open_error_t openapiBoxsPowSupplyDescripSizeGet(openapiClientHandle_t *client_handle, uint32_t *descripSize)
Gets the maximum size for the power supply description.
open_error_t openapiBoxsSfpVendorRevSizeGet(openapiClientHandle_t *client_handle, uint32_t *vendorRevSize)
Gets the size of vendor revision of SFP transceiver.
open_error_t openapiBoxsSfpLinkLength50umGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *linkLength50um)
Gets the Link Length(50um) of SFP transceiver.
open_error_t openapiBoxsSystemLedModeGet(openapiClientHandle_t *client_handle, OPEN_LED_STATUS_t *val)
Gets system LED status.
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Copper 10G plugin module, AX745.
open_error_t openapiBoxsSfpTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_SFP_MODULE_TYPE_t *moduleType)
Gets the SFP module type.
open_error_t openapiBoxsNumOfTempSensorsGet(openapiClientHandle_t *client_handle, uint32_t *numOfTempSemsors)
Gets the maximum number of temperature sensors in the unit.
open_error_t openapiFiberPortsTransceiverPresenceGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *present)
Get the transceiver presence status for fiber ports.
open_error_t openapiBoxsTempSensorMaxTempGet(openapiClientHandle_t *client_handle, uint32_t sensorNum, uint32_t *maxTemperature)
Gets the maximum temperature of a given temperature sensor.
open_error_t openapiBoxsSfpComplianceGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *complianceDesc)
Gets the compliance of SFP transceiver.
open_error_t openapiBoxsGeneralTempGet(openapiClientHandle_t *client_handle, uint32_t *genTemp)
Gets the general temperature of the system.
open_error_t openapiBoxsiGeneralFanSpeedGet(openapiClientHandle_t *client_handle, uint32_t *genFanSpeed)
Gets the general fan speed.
open_error_t openapiBoxsSfpVendorRevisionGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vendorRevDesc)
Gets the SFP transceiver vendor revision number.
OPEN_BOXS_ITEM_STATE_t
Item state definition - for power supplies and fans.
OPEN_BOXS_ITEM_TYPE_t
Item type definitions.
open_error_t openapiBoxsSfpVendorNameGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vendorNameDesc)
Gets the SFP transceiver vendor name.
open_error_t openapiBoxsSfpSerialNumberGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *serialNumberDesc)
Gets the SFP transceiver serial number.
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.
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.
open_error_t openapiBoxsFanSpeedGet(openapiClientHandle_t *client_handle, uint32_t fanNum, uint32_t *fanSpeed)
Gets the speed of a given fan number.