Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_boxs.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

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...