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

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

Detailed Description

Enumeration Type Documentation

Enumerator
OPEN_MODULE_NONE 

None.

OPEN_MODULE_SFP 

SFP.

OPEN_MODULE_SFPPLUS 

SFP+.

OPEN_MODULE_QSFP 

QSFP.

OPEN_MODULE_DAC 

Direct Attach Cable.

OPEN_MODULE_AX741 

XFP, AX741, 10G plugin module.

OPEN_MODULE_AX742 

Stacking module, AX742.

OPEN_MODULE_AX743 

SFP+ plugin module, AX743.

OPEN_MODULE_AX744 

CX4 plugin module, AX744.

OPEN_MODULE_AX745 

Copper 10G plugin module, AX745.

Definition at line 77 of file openapi_boxs.h.

Function Documentation

open_error_t openapiBoxsFanDescripGet ( openapiClientHandle_t client_handle,
uint32_t  fanNum,
open_buffdesc descrip 
)

Gets the description of a given fan.

Parameters
[in]client_handleClient handle from registration API
[in]fanNumFan number, ZERO to maximum.
[out]descripDescription of the temperature sensor. Use "openapiBoxsFanDescripSizeGet()" to get the size of the description.
Return values
OPEN_E_NONEReturned size of fan description.
OPEN_E_FAILFailed to get fan description size.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
open_error_t openapiBoxsFanDescripSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  descripSize 
)

Gets the maximum size for the fan description.

Parameters
[in]client_handleclient handle from registration API
[out]descripSizesize for the fan description.
Return values
OPEN_E_NONEReturned fan description size.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
open_error_t openapiBoxsFanDutyCycleGet ( openapiClientHandle_t client_handle,
uint32_t  fanNum,
uint32_t *  fanDuty 
)

Gets the duty-cycle of a given fan number.

Parameters
[in]client_handleclient handle from registration API
[in]fanNumfan number, ZERO to maximum.
[out]fanDutyduty-cycle of the fan.
Return values
OPEN_E_NONEduty-cycle of the fan returned.
OPEN_E_FAILFailed to get the duty-cycle of the fan.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsFanSpeedGet ( openapiClientHandle_t client_handle,
uint32_t  fanNum,
uint32_t *  fanSpeed 
)

Gets the speed of a given fan number.

Parameters
[in]client_handleclient handle from registration API
[in]fanNumfan number, ZERO to maximum.
[out]fanSpeedspeed of the fan.
Return values
OPEN_E_NONEspeed of the fan get successfully.
OPEN_E_FAILFailed to get the speed of the fan.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]fanNumfan number, ZERO to maximum.
[out]fanStatestate of the fan.
Return values
OPEN_E_NONEstate of the fan returned.
OPEN_E_FAILFailed to get the state of the fan.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]fanNumfan number, ZERO to maximum.
[out]fanTypetype of the fan.
Return values
OPEN_E_NONEtype of the fan returned.
OPEN_E_FAILFailed to get the type of the fan.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsGeneralTempGet ( openapiClientHandle_t client_handle,
uint32_t *  genTemp 
)

Gets the general temperature of the system.

Parameters
[in]client_handleclient handle from registration API
[out]genTempgeneral temperature read from system.
Return values
OPEN_E_NONEReturned general temperature value.
OPEN_E_FAILFailed to get general temperature.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
open_error_t openapiBoxsHwVersionGet ( openapiClientHandle_t client_handle,
uint32_t *  version 
)

Gets the board revision number on the unit.

Parameters
[in]client_handleclient handle from registration API
[out]versionBoard version on the unit.
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILFailed to get board revision.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.19

Examples:
boxs_example.c.
open_error_t openapiBoxsiGeneralFanDutyLevelGet ( openapiClientHandle_t client_handle,
uint32_t *  genFanDutyLevel 
)

Gets the general fan duty-level.

Parameters
[in]client_handleclient handle from registration API
[out]genFanDutyLevelGeneral fan duty-level.
Return values
OPEN_E_NONEReturned general duty-level of the fan.
OPEN_E_FAILFailed to get general fan duty-cycle.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
open_error_t openapiBoxsiGeneralFanSpeedGet ( openapiClientHandle_t client_handle,
uint32_t *  genFanSpeed 
)

Gets the general fan speed.

Parameters
[in]client_handleclient handle from registration API
[out]genFanSpeedgeneral speed of the fans.
Return values
OPEN_E_NONEReturned general fan speed.
OPEN_E_FAILFailed to get the general fan speed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
open_error_t openapiBoxsNumOfFansGet ( openapiClientHandle_t client_handle,
uint32_t *  numFans 
)

Gets the maximum number of FANs on the unit.

Parameters
[in]client_handleclient handle from registration API
[out]numFansmaximum number of fans.
Return values
OPEN_E_NONEmaximum number of fans supported returned.
OPEN_E_FAILFailed to get the maximum number of fans .
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsNumOfPowSuppliesGet ( openapiClientHandle_t client_handle,
uint32_t *  numPowSuplies 
)

Gets the maximum number of power supplies in the unit.

Parameters
[in]client_handleclient handle from registration API
[out]numPowSupliesmaximum number of power supplies.
Return values
OPEN_E_NONEmaximum number of power supplies get successfully.
OPEN_E_FAILFailed to get the maximum number of power supplies.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsNumOfTempSensorsGet ( openapiClientHandle_t client_handle,
uint32_t *  numOfTempSemsors 
)

Gets the maximum number of temperature sensors in the unit.

Parameters
[in]client_handleclient handle from registration API
[out]numOfTempSemsorsmaximum number of temperature sensors.
Return values
OPEN_E_NONEmaximum number of temperature sensors get successfully.
OPEN_E_FAILFailed to get the maximum number of temperature sensors.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsPortLedsModeGet ( openapiClientHandle_t client_handle,
OPEN_LED_STATUS_t *  val 
)

Gets port and PoE LED status on the given interface(s).

Parameters
[in]client_handleclient handle from registration API
[out]valLED status
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILIf feature is not supported.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.19

Examples:
boxs_example.c.
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).

Parameters
[in]client_handleclient handle from registration API
[in]valTurn on/off the LED
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_EXISTSAlready configured.
OPEN_E_UNAVAILIf feature is not supported.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.19

Examples:
boxs_example.c.
open_error_t openapiBoxsPowSupplyDescripGet ( openapiClientHandle_t client_handle,
uint32_t  psNum,
open_buffdesc descrip 
)

Gets the description of a given power supply.

Parameters
[in]client_handleClient handle from registration API
[in]psNumPower supply number, ZERO to maximum.
[out]descripDescription of the power supply. Use "openapiBoxsPowSupplyDescripSizeGet()" to get size of the description.
Return values
OPEN_E_NONEReturned size of power supply description.
OPEN_E_FAILFailed to get power supply description size.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
open_error_t openapiBoxsPowSupplyDescripSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  descripSize 
)

Gets the maximum size for the power supply description.

Parameters
[in]client_handleclient handle from registration API
[out]descripSizesize for the power supply description.
Return values
OPEN_E_NONEReturned power supply description size.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]psNopower supply number, ZERO to maximum.
[out]psStatestate of the power supply.
Return values
OPEN_E_NONEstate of the power supply returned.
OPEN_E_FAILFailed to get the state of the power supply.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]psNopower supply number, ZERO to maximum.
[out]psTypetype of the power supply.
Return values
OPEN_E_NONEtype of the power supply returned.
OPEN_E_FAILFailed to get the type of the power supply.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpComplianceGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
open_buffdesc complianceDesc 
)

Gets the compliance of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve the SFP compliance.
[out]complianceDescbuff descriptor to get compliance of the SFP transceiver.
Return values
OPEN_E_NONECompliance returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.
Note
Initialize complianceDesc pstart and size with the char buffer of size returned by openapiBoxsSfpComplianceSizeGet().

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpComplianceSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  complianceSize 
)

Gets the size of compliance of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[out]complianceSizesize of SFP compliance.
Return values
OPEN_E_NONEsize of SFP compliance returned successfully.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpLinkLength50umGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  linkLength50um 
)

Gets the Link Length(50um) of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve the link length (50um) of SFP transceiver.
[out]linkLength50umLink length(50um) of the SFP transceiver.
Return values
OPEN_E_NONELink Length(50um) returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
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.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve the link length (62_5um) of SFP transceiver.
[out]linkLength62_5umLink length(62.5um) of the SFP transceiver.
Return values
OPEN_E_NONELink Length(62.5um) returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpNominalSignalRate ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  nominalSigRate 
)

Gets the Nominal Signal Rate of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve the Nominal Signal Rate of SFP transceiver.
[out]nominalSigRatebuff descriptor to get Nominal Signal Rate of the SFP transceiver.
Return values
OPEN_E_NONENominal Signal Rate returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpPartNumberGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
open_buffdesc partNumberDesc 
)

Gets the SFP transceiver part number.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve SFP part number.
[out]partNumberDescbuff descriptor to get part number of the SFP transceiver.
Return values
OPEN_E_NONESerial number returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.
Note
Initialize partNumberDesc pstart and size with the char buffer of size returned by openapiBoxsSfpPartNumberSizeGet().

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpPartNumberSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  partNumberSize 
)

Gets the size of part number of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[out]partNumberSizesize of SFP part number.
Return values
OPEN_E_NONEsize of SFP part number returned successfully.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpSerialNumberGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
open_buffdesc serialNumberDesc 
)

Gets the SFP transceiver serial number.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve SFP serial number.
[out]serialNumberDescbuff descriptor to get serial number of the SFP transceiver.
Return values
OPEN_E_NONESerial number returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.
Note
Initialize serialNumberDesc pstart and size with the char buffer of size returned by openapiBoxsSfpSerialNumberSizeGet().

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpSerialNumberSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  serialNumberSize 
)

Gets the size of serial number of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[out]serialNumberSizesize of SFP serial number.
Return values
OPEN_E_NONEsize of SFP serial number returned successfully.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpTypeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_SFP_MODULE_TYPE_t moduleType 
)

Gets the SFP module type.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to get the type.
[out]moduleTypetype of module.
Return values
OPEN_E_NONEInterface type returned successfully.
OPEN_E_FAILFailed to get the interface type.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c, and interface_example.c.
open_error_t openapiBoxsSfpVendorNameGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
open_buffdesc vendorNameDesc 
)

Gets the SFP transceiver vendor name.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve SFP vendor name.
[out]vendorNameDescbuff descriptor to get vendor name of the SFP transceiver.
Return values
OPEN_E_NONEVendor name returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.
Note
Initialize vendorNameDesc pstart and size with the char buffer of size returned by openapiBoxsSfpVendorNameSizeGet().

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpVendorNameSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  vendorNameSize 
)

Gets the size if vendor name of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[out]vendorNameSizesize of SFP vendor name.
Return values
OPEN_E_NONEsize of SFP vendor name returned successfully.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpVendorRevisionGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
open_buffdesc vendorRevDesc 
)

Gets the SFP transceiver vendor revision number.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNuminterface ID to retrieve SFP vendor revision.
[out]vendorRevDescbuff descriptor to get vendor revision.
Return values
OPEN_E_NONESerial number returned successfully.
OPEN_E_FAILFailed to get the transceiver data.
OPEN_E_PARAMError in parameter passed.
Note
Initialize vendorRevDesc pstart and size with the char buffer of size returned by openapiBoxsSfpVendorRevSizeGet().

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSfpVendorRevSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  vendorRevSize 
)

Gets the size of vendor revision of SFP transceiver.

Parameters
[in]client_handleclient handle from registration API.
[out]vendorRevSizesize of SFP vendor revision.
Return values
OPEN_E_NONEsize of SFP vendor revision returned successfully.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsSystemLedModeGet ( openapiClientHandle_t client_handle,
OPEN_LED_STATUS_t *  val 
)

Gets system LED status.

Parameters
[in]client_handleclient handle from registration API
[out]valLED status
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILIf feature is not supported.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.19

Examples:
boxs_example.c.
open_error_t openapiBoxsSystemLedModeSet ( openapiClientHandle_t client_handle,
OPEN_LED_CMD_t  val 
)

Turns on/off system LEDs.

Parameters
[in]client_handleclient handle from registration API
[in]valTurn on/off the LED
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_EXISTSAlready configured.
OPEN_E_UNAVAILIf feature is not supported.
OPEN_E_INTERNALInternal error.

OpEN API Version: 1.19

Examples:
boxs_example.c.
open_error_t openapiBoxsTempGet ( openapiClientHandle_t client_handle,
uint32_t  sensorNum,
uint32_t *  temperature 
)

Gets the temperature value read by the given temperature sensor.

Parameters
[in]client_handleclient handle from registration API
[in]sensorNumtemperature sensor number, ZERO to maximum.
[out]temperaturetemperature value read by the sensor.
Return values
OPEN_E_NONEReturned sensor temperature successfully.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsTempRangeGet ( openapiClientHandle_t client_handle,
uint32_t *  minTemp,
uint32_t *  maxTemp 
)

Gets allowed temperature range for normal operation.

Parameters
[in]client_handleclient handle from registration API
[out]minTempMinimum value in range
[out]maxTempMaximum value in range
Return values
OPEN_E_NONEReturned allowed temperature range.
OPEN_E_FAILFailed to get temperature range.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.15

Examples:
boxs_example.c.
open_error_t openapiBoxsTempSensorDescripGet ( openapiClientHandle_t client_handle,
uint32_t  sensorNum,
open_buffdesc descrip 
)

Gets the description of a given temperature sensor.

Parameters
[in]client_handleclient handle from registration API
[in]sensorNumtemperature sensor number, ZERO to maximum.
[out]descripdescription of the temperature sensor. use "openapiBoxsTempSensorDescripSizeGet()" to get the size of the description.
Return values
OPEN_E_NONEThe description of the temperature sensor returned.
OPEN_E_FAILFailed to get the description of the temperature sensor.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsTempSensorDescripSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  descripSize 
)

Gets the maximum size for the temperature sensor description.

Parameters
[in]client_handleclient handle from registration API
[out]descripSizesize for the temperature sensor description.
Return values
OPEN_E_NONEsize for the temperature sensor description returned.
OPEN_E_FAILFailed to get the size for the temperature sensor description.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiBoxsTempSensorMaxTempGet ( openapiClientHandle_t client_handle,
uint32_t  sensorNum,
uint32_t *  maxTemperature 
)

Gets the maximum temperature of a given temperature sensor.

Parameters
[in]client_handleclient handle from registration API
[in]sensorNumtemperature sensor number, ZERO to maximum.
[out]maxTemperaturemaximum temperature of the given sensor.
Return values
OPEN_E_NONEReturned Maximum temperature of the sensor.
OPEN_E_FAILFailed to get maximum temperature of the sensor.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILFeature 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.

Parameters
[in]client_handleclient handle from registration API
[in]sensorNumtemperature sensor number, ZERO to maximum.
[out]statestate of the temperature sensorNum.
Return values
OPEN_E_NONEState of the temperature sensor returned.
OPEN_E_FAILFailed to get the state of the temperature sensor.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiCpldVersionGet ( openapiClientHandle_t client_handle,
open_buffdesc cpldVersion 
)

Get the CPLD version of the system.

Parameters
[in]client_handleClient handle from registration API
[out]cpldVersionPointer to CPLD version string storage
  • Buffer allocated size must be at least
  • OPENAPI_VER_BUFF_MAX_SIZE
Return values
OPEN_E_NONEif operation is successful
OPEN_E_FAILif operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif no device exist or not supported

OpEN API Version: 1.15

Examples:
boxs_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumInterface number
-Minimum value 1
-Maximum value openapiMaxInterfaceCountGet()
[in]laneLane number Can be determined using openapiIfExpPortOperModeLaneCountGet()
[out]temperatureTemperature (degrees C)
[out]voltageVoltage (milliVolts)
[out]currentCurrent (milliAmps)
[out]powerInPower Input (microWatts)
[out]powerOutPower output (microWatts)
[out]txFaultTransmit Fault
[out]losLoss of signal
Return values
OPEN_E_NONEFiber ports diagnostic data obtained successfully.
OPEN_E_INTERNALFailed to accommadate output string.
OPEN_E_NOT_FOUNDFiber ports diagnostic data not found.
OPEN_E_ERRORFailed to fetch the fiber port diagnostic data or the interface does not exist
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.
Note
Only valid for fiber ports. 'powerIn' and 'powerOut' are 64-bit signed floating numbers so for simplicity they are provided in string format.

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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumInterface number
-Minimum value 1
-Maximum value openapiMaxInterfaceCountGet()
[out]localFaultStatuslocal fault status (non-zero value indicates fault.)
[out]remoteFaultStatusremote fault status (non-zero value indicates fault.)
Return values
OPEN_E_NONEStatus obtained successfully.
OPEN_E_ERRORFailed to fetch the fiber port fault status or the interface does not exist
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.
Note
Only valid for fiber ports.

OpEN API Version: 1.14

Examples:
boxs_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumInterface number
-Minimum value 1
-Maximum value openapiMaxInterfaceCountGet()
[out]temperatureTemperature (degrees C)
[out]voltageVoltage (milliVolts)
[out]currentCurrent (milliAmps)
[out]powerInPower Input (microWatts)
[out]powerOutPower output (microWatts)
[out]txFaultTransmit Fault
[out]losLoss of signal
Return values
OPEN_E_NONEFiber ports diagnostic data obtained successfully.
OPEN_E_NOT_FOUNDFiber ports diagnostic data not found.
OPEN_E_ERRORFailed to fetch the fiber port diagnostic data or the interface does not exist
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.
Note
Only valid for fiber ports.

OpEN API Version: 1.14

Examples:
boxs_example.c.
open_error_t openapiFiberPortsTransceiverPresenceGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t present 
)

Get the transceiver presence status for fiber ports.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumInterface number
-Minimum value 1
-Maximum value openapiMaxInterfaceCountGet()
[out]presentTransceiver presence status
Return values
OPEN_E_NONEPresence status obtained successfully.
OPEN_E_ERRORCould not determine status. Possibly due to an invalid interface number or not a fiber port.
OPEN_E_PARAMError in parameter passed.
OPEN_E_UNAVAILNot supported for this platform.
Note
Only valid for fiber ports.

OpEN API Version: 1.15

open_error_t openapiPortLocatorGlobalDisable ( openapiClientHandle_t client_handle)

Disables port locator globally.

Parameters
[in]client_handleclient handle from registration API.
Return values
OPEN_E_NONE
OPEN_E_UNAVAILNot supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.
open_error_t openapiPortLocatorInterfaceEnable ( openapiClientHandle_t client_handle,
uint32_t  interface,
OPEN_CONTROL_t  enable 
)

enable or disable port locator on an interface

Parameters
[in]client_handleclient handle from registration API.
[in]interfaceinterface to enable or disable.
[in]enableport operation mode.
Return values
OPEN_E_NONE
OPEN_E_UNAVAILNot supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
boxs_example.c.