Platform Objects

This page contains descriptions of the Platform Daemon (asicd) objects.

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

The following sections describe the structure of each ASIC configuration object.

Sfp

config/Sfp

Attribute Data Type Description Permitted Values
IntfRef [Key] string Front panel port name or system assigned interface id
SfpId int32 SFP id
AdminState string Admin PORT UP/DOWN(TX OFF)

Psu

config/Psu

Attribute Data Type Description Permitted Values
PsuId [Key] int32 PSU id DEFAULT:0
AdminState string Admin UP/DOWN PSU

Led

config/Led

Attribute Data Type Description Permitted Values
LedId [Key] int32 LED id DEFAULT:0
LedAdmin string LED ON/OFF
LedSetColor string LED set color

Fan

config/Fan

Attribute Data Type Description Permitted Values
FanId [Key] int32 Fan unit id DEFAULT:0
AdminState string Fan admin ON/OFF
AdminSpeed int32 Fan set speed in rpm

FanSensor

config/FanSensor

Attribute Data Type Description Permitted Values
Name [Key] string Fan Sensor Name
AdminState string Enable/Disable SELECTION: Enable/Disable
DEFAULT: Enable
HigherAlarmThreshold int32 Higher Alarm Threshold for TCA"
HigherWarningThreshold int32 Higher Warning Threshold for TCA
LowerWarningThreshold int32 Lower Warning Threshold for TCA
LowerAlarmThreshold int32 Lower Alarm Threshold for TCA
PMClassAAdminState string PM Class-A Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassBAdminState string PM Class-B Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassCAdminState string PM Class-C Admin State SELECTION: Enable/Disable /br> DEFAULT: Enable

TemperatureSensor

config/TemperatureSensor

Attribute Data Type Description Permitted Values
Name [Key] string Temperature Sensor Name
AdminState string Enable/Disable SELECTION: Enable/Disable
DEFAULT: Enable
HigherAlarmThreshold float64 Higher Alarm Threshold for TCA
HigherWarningThreshold float64 Higher Warning Threshold for TCA
LowerWarningThreshold float64 Lower Warning Threshold for TCA
LowerAlarmThreshold float64 Lower Alarm Threshold for TCA
PMClassAAdminState string PM Class-A Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassBAdminState string PM Class-B Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassCAdminState string PM Class-C Admin State SELECTION: Enable/Disable
DEFAULT: Enable

VoltageSensor

config/VoltageSensor

Attribute Data Type Description Permitted Values
Name [Key] string Voltage Sensor Name
AdminState string Enable/Disable SELECTION: Enable/Disable
DEFAULT: Enable
HigherAlarmThreshold float64 Higher Alarm Threshold for TCA
HigherWarningThreshold float64 Higher Warning Threshold for TCA
LowerWarningThreshold float64 Lower Warning Threshold for TCA
LowerAlarmThreshold float64 Lower Alarm Threshold for TCA
PMClassAAdminState string PM Class-A Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassBAdminState string PM Class-B Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassCAdminState string PM Class-C Admin State SELECTION: Enable/Disable
DEFAULT: Enable

PowerConverterSensor

config/PowerConverterSensor

Attribute Data Type Description Permitted Values
Name [Key] string Power Converter Sensor Name
AdminState string Enable/Disable SELECTION: Enable/Disable
DEFAULT: Enable
HigherAlarmThreshold float64 Higher Alarm Threshold for TCA
HigherWarningThreshold float64 Higher Warning Threshold for TCA
LowerWarningThreshold float64 Lower Warning Threshold for TCA
LowerAlarmThreshold float64 Lower Alarm Threshold for TCA
PMClassAAdminState string PM Class-A Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassBAdminState string PM Class-B Admin State SELECTION: Enable/Disable
DEFAULT: Enable
PMClassCAdminState string PM Class-C Admin State SELECTION: Enable/Disable
DEFAULT: Enable

Qsfp

config/Qspf

Attribute Data Type Description Permitted Values
QsfpId [Key] int32 Qsfp Id
AdminState string Enable/Disable SELECTION: Enable/Disable
DEFAULT: Disable
HigherAlarmTemperature float64 Higher Alarm temperature threshold for TCA
HigherAlarmVoltage float64 Higher Alarm Voltage threshold for TCA
HigherWarningTemperature float64 Higher Warning temperature threshold for TCA
HigherWarningVoltage float64 Higher Warning Voltage threshold for TCA
LowerAlarmTemperature float64 Lower Alarm temperature threshold for TCA
LowerAlarmVoltage float64 Lower Alarm Voltage threshold for TCA
LowerWarningTemperature float64 Lower Warning temperature threshold for TCA
LowerWarningVoltage float64 Lower Warning Voltage threshold for TCA
PMClassAAdminState string PM Class-A Admin State SELECTION: Enable/Disable
DEFAULT: Disable
PMClassBAdminState string PM Class-B Admin State SELECTION: Enable/Disable
DEFAULT: Disable
PMClassCAdminState string PM Class-C Admin State SELECTION: Enable/Disable
DEFAULT: Disable

QsfpChannel

config/QsfpChannel

Attribute Data Type Description Permitted Values
QsfpId [Key] int32 Qsfp Id
ChannelNum int32 Qsfp Channel Number
AdminState string Enable/Disable SELECTION: Enable/Disable
DEFAULT: Disable
HigherAlarmRXPower float64 Higher Alarm Rx power Threshold for TCA
HigherAlarmTXPower float64 Higher Alarm Rx power for TCA
HigherAlarmTXBias float64 Higher Alarm Tx Current Bias for TCA
HigherWarningRXPower float64 Higher Warning Rx power Threshold for TCA
HigherWarningTXPower float64 Higher Warning Rx power for TCA
HigherWarningTXBias float64 Higher Warning Tx Current Bias for TCA
LowerAlarmRXPower float64 Lower Alarm Rx power Threshold for TCA
LowerAlarmTXPower float64 Lower Alarm Rx power for TCA
LowerAlarmTXBias float64 Lower Alarm Tx Current Bias for TCA
LowerWarningRXPower float64 Lower Warning Rx power Threshold for TCA
LowerWarningTXPower float64 Lower Warning Rx power for TCA
LowerWarningTXBias float64 Lower Warning Tx Current Bias for TCA
PMClassAAdminState string PM Class-A Admin State SELECTION: Enable/Disable
DEFAULT: Disable
PMClassBAdminState string PM Class-B Admin State SELECTION: Enable/Disable
DEFAULT: Disable
PMClassCAdminState string PM Class-C Admin State SELECTION: Enable/Disable
DEFAULT: Disable

State Objects

PlatformState

state/Platform

Attribute Data Type Description Permitted Values
ObjName [Key] string ObjName DEFAULT: Platform
ProductName string Product Number
SerialNum string Serial Number
Manufacturer string Manufacturer
Vendor string Vendor
Release string Relese version
PlatformName string Platform Number
Version string Platform Driver version, in case of ONLP(ONIE Version) and OpenBMC(BMC Version)

SfpState

state/Sfp

Attribute Data Type Description Permitted Values
IntfRef [Key] string Front panel port name or system assigned interface id
SfpId int32 SFP id
SfpLOS string SFP status RX LOS
SfpPresent string SFP status PRESENT/MISSING
SfpType string SFP type SFP/SFP++
SfpMediaType string SFP media type Fiber/Copper
SfpModuleType string SFP module type SR/LR/ER/etc
Vendor string SFP vendor name FINISAR/AVAGO/etc
Model string SFP model name SFP-H10GB-CU3M/etc
SerialNum string SFP SerialNum
MediaType int32 SFP media type number of Fiber/Copper
ModuleType int32 SFP module type number of SR/LR/ER/etc
ModuleCaps int32 SFP module Capabilities
CableLength int32 SFP cable length if available
EEPROM string SFP eeprom

ThermalState

state/Thermal

Attribute Data Type Description Permitted Values
ThermalId [Key] int32 Thermal sensor id DEFAULT:0
Location string Thermal sensor location CPU/PSU/Motherboard
Temperature string Temperature current
LowerWatermarkTemperature string Temperature warning
UpperWatermarkTemperature string Temperature error
ShutdownTemperature string Temperature panic

PsuState

state/PsuState

Attribute Data Type Description Permitted Values
PsuId [Key] int32 PSU id DEFAULT:0
AdminState string Admin UP/DOWN PSU
ModelNum string Model Number
SerialNum string Serial Number"
Vin int32 Voltage in
Vout int32 Voltage out
Iin int32 Current in
Iout int32 Current out
Pin int32 Power in
Pout int32 power out
Fan string Fan PRESENT/MISSING
FanId int32 Fan Info
LedId int32 LED Info

LedState

state/Led

Attribute Data Type Description Permitted Values
LedId [Key] int32 LED id DEFAULT:0
LedIdentify string LED represents FAN/PSU/RESET etc
LedState string LED State ON/OFF
LedColor string LED Color

FanState

state/Fan

Attribute Data Type Description Permitted Values
FanId [Key] int32 Fan unit id DEFAULT:0
OperMode string Operational state of Fan SELECTION: ON/OFF
OperSpeed int32 Fan operational speed in rpm
OperDirection string Air flow caused because of fan rotation SELECTION: B2F/F2B
Status string Fan status PRESENT/MISSING/FAILED/NORMAL
Model string Model of Fan
SerialNum string Serial Number
LedId int32 LED Info

FanSensorState

state/FanSensor

Attribute Data Type Description Permitted Values
Name [Key] string Fan Sensor Name
CurrentSpeed int32 Fan Current Speed

FanSensorPMDataState

state/FanSensorPMData

Attribute Data Type Description Permitted Values
Name [Key] string Fan Sensor Name
Class [Key] string Class of PM Data SELECTION: CLASS-A/CLASS-B/CLASS-B
DEFAULT: CLASS-A
Data []FanSensorPMData

TemperatureSensorState

state/TemperatureSensor

Attribute Data Type Description Permitted Values
Name [Key] string Temperature Sensor Name
CurrentTemperature float64 Current Temperature Value

TemperatureSensorPMDataState

state/TemperatureSensorPMData

Attribute Data Type Description Permitted Values
Name [Key] string Temperature Sensor Name
Class [Key} string Class of PM Data SELECTION: CLASS-A/CLASS-B/CLASS-B
DEFAULT: CLASS-A
Data []TemperatureSensorPMData

VoltageSensorState

state/VoltageSensor

Attribute Data Type Description Permitted Values
Name [Key] string Voltage Sensor Name
CurrentVoltage float64 Current Voltage Value

VoltageSensorPMDataState

state/VoltageSensorPMData

Attribute Data Type Description Permitted Values
Name [Key] string Voltage Sensor Name
Class [Key] string Class of PM Data SELECTION: CLASS-A/CLASS-B/CLASS-B
DEFAULT: CLASS-A
Data []VoltageSensorPMData

PowerConverterSensorState

state/PowerConverterSensor

Attribute Data Type Description Permitted Values
Name [Key] string Power Converter Sensor Name
CurrentPower float64 Current Output Power Value

PowerConverterSensorPMDataState

state/PowerConverterSensorPMData

Attribute Data Type Description Permitted Values
Name [Key] string Power Converter Sensor Name
Class [Key] string Class of PM Data SELECTION: CLASS-A/CLASS-B/CLASS-B
DEFAULT: CLASS-A
Data []PowerConverterSensorPMData

QsfpState

state/Qsfp

Attribute Data Type Description Permitted Values
QsfpId [Key] int32 QSFP Id
Present bool Present or Not Value: true if present and false if not present
VendorName string Vendor Name
VendorOUI string Vendor OUI
VendorPartNumber string Vendor Part Number
VendorRevision string Vendor Revision
VendorSerialNumber string Vendor Serial Number
DataCode string Data Code
Temperature float64 Current temperature
Voltage float64 Current Voltage
CurrBER float64 Current BER
AccBER float64 Accumulated BER
MinBER float64 Minimum BER
MaxBER float64 Maximum BER
UDF0 float64 User defined field 0
UDF1 float64 User defined field 1
UDF2 float64 User defined field 2
UDF3 float64 User defined field 3

QsfpPMDataState

state/QsfpPMData

Attribute Data Type Description Permitted Values
QsfpId [Key] int32 QSFP Id
Resource string QSFP PM Resource Name
Class string Class of PM Data SELECTION: CLASS-A/CLASS-B/CLASS-B
DEFAULT: CLASS-A
Data []QsfpPMData

QsfpChannelState

state/QsfpChannelS

Attribute Data Type Description Permitted Values
QsfpId [Key] int32 QSFP Id
ChannelNum [Key] int32 Qsfp Channel Number
Present bool Present or Not Value: true if present and false if not present
RXPower float64 Rx power on channel 1
TXPower float64 Rx power on channel 1
TXBias float64 Tx Current Bias on channel 1

QsfpChannelPMDataState

state/QsfpChannelPMData

Attribute Data Type Description Permitted Values
QsfpId [Key] int32 QSFP Id
ChannelNum [Key] int32 Qsfp Channel Number
Resource [Key] string QSFP PM Resource Name
Class [Key] string Class of PM Data" SELECTION: CLASS-A/CLASS-B/CLASS-B
DEFAULT: CLASS-A
Data []QsfpChannelPMData

PlatformMgmtDeviceState

state/PlatformMgmtDevice

Attribute Data Type Description Permitted Values
DeviceName [Key] string Device Name DEFAULT: BMC
Uptime string Uptime and load description
Description string Platform Description
ResetReason string Reset Reason
MemoryUsage string Memory Usage
Version string Version
CPUUsage string CPU Usage

Structures

The following structure is used by one or more of the objects above.

FanSensorPMData

Field Data Type Description
TimeStamp string Timestamp at which data is collected
Value int32 Fan PM Data Value in RPM

TemperatureSensorPMData

Field Data Type Description
TimeStamp string Timestamp at which data is collected
Value float64 Temperature Sensor PM Data Value in Degree Celsius

VoltageSensorPMData

Field Data Type Description
TimeStamp string Timestamp at which data is collected
Value float64 Voltage Sensor PM Data Value in Volts

PowerConverterSensorPMData

Field Data Type Description
TimeStamp string Timestamp at which data is collected
Value float64 Power Converter Sensor PM Data Value in Watts"

QsfpPMData

Field Data Type Description
TimeStamp string Timestamp at which data is collected
Value float64 Qsfp PM Data Value

QsfpChannelPMData

Field Data Type Description
TimeStamp string Timestamp at which data is collected
Value float64 Qsfp PM Data Value