Interfaces
This is a list of IDL-defined interfaces and data structures by module:

assetmgrmodel | Asset Management Model
AssetStrip_2_0_5 | Asset Management Strip interface
DeviceInfo | Static (type, version) information for an AssetStrip
RackUnitInfo | Infos for a single rack unit
StripInfo | Dynamic (may change with a connected strip) information for an AssetStrip
TagChangeInfo | Information describing a tag change
TagInfo | Information for a single tag
AssetStripConfig_1_0_1 | Asset Strip Config interface
LEDColor | The LED color in RGB format, 8 bit per channel
RackUnitSettings | Settings for a single rack unit (LED state)
StripSettings | Settings for this Asset Strip
AssetStripLogger_1_0_6 | Asset Strip Logger interface
Info | Log information structure
Record | Log record structure
auth | Local and Remote Authentication Management
ldapsrv | LDAP server interface
ServerSettings_2_0_0 | Server settings
AuthManager | Authentication manager interface
LdapManager_2_0_0 | LDAP server configuration interface
Policy | Authentication policy
RadiusManager_2_0_0 | RADIUS server configuration interface
bulkcfg | Bulk Configuration
BulkConfiguration_1_0_2 | Bulk Configuration Interface
Filter | This structure defines a filter
FilterProfile | Filter profiles are named collections of filters
Settings | Settings
bulkrpc | Bulk RPC
BulkRequest_1_0_2 | Bulk Request Interface
Request | JSON-RPC Request
Response | JSON-RPC Response
Request | JSON-RPC Request (old format)
Response | JSON-RPC Response (old format)
cascading | Raritan JSON-RPC
CascadeManager | JSON-RPC Cascade Manager
LinkUnit | Link Unit Status
Status | Full Cascading Status
cert | TLS Certificate Management
ServerSSLCert_2_0_0 | TLS certificate management interface
CertInfo | Certificate information
CommonAttributes | Certificate issuer or subject attributes
Info | Certificate manager information
ReqInfo | Certificate signing request information
cew | Cisco EnergyWise
EnergyWiseManager | EnergyWise manager
EnergyWiseSettings | EnergyWise settings
datapush | The datapush module contains the definition of the JSON-encoded datapush messages
AssetLogPushMessage | Message for pushing one full log record for all sensors
AssetStrip |
AssetStripInfo |
AssetStripsMessage |
Device | Device information
LogRow | One full log row (one timestamp, mulitple sensors)
Sensor | Sensor information
SensorLogPushMessage | Message for pushing one full log record for all sensors
datetime | Device Date and Time Configuration
DateTime_3_0_2 | Date and time configuration methods
Cfg | Device date and time configuration
NtpCfg | Static NTP server configuration
ZoneCfg | Time zone configuration
ZoneInfo | Time zone information
devsettings | Device Settings
Modbus_2_0_0 | Modbus service settings interface
Capabilities | Device modbus capabilities
SerialSettings | Modbus/serial settings
Settings | Modbus service settings
TcpSettings | Modbus/TCP settings
Smtp_2_0_0 | SMTP settings interface
Configuration | SMTP server configuration
TestResult | Result of SMTP configuration test
Snmp_1_0_2 | SNMP agent settings interface
Configuration | SNMP agent configuration
Zeroconf_2_0_0 | Zero-config service settings interface
Settings | Zero-configservice settings
diag | Diagnostics
DiagLogSettings | Diagnostic log settings
LogLevelEntry | An entry containing a context name and its associated context
display | Front panel display interface
DisplayControl_1_0_1 | Interface to control the device's front panel display
DefaultViewItem | Representation of a possible default view
Info | Collected display meta information
emdmodel | EMD Model interfaces
Emd_2_2_8 |
MetaData | EMD metadata
Settings | EMD settings
event | Event interface
AlarmManager | AlarmManager interface
Alarm | Alarm structure
Alert | Alert structure
Channel_1_0_1 | Event Channel
EventSelect | Structure to select an Event *
DataPushService_1_0_1 | Data push service configuration interface
EntrySettings | Data Push Entry Settings
EntryStatus | Data Push Entry Status
Engine_1_0_1 | There is a single event engine instance reachable by a well known reference
Action | An action is a tuple of 'id' (unique within the scope of this event engine), 'name' which is unique as well and used by the GUI as user readable identificator, 'isSystem' which denotes the action as system action, 'type' which defines what it is, and an argument vector that vary depending on type and which is passed to the action
Condition | Condition is a logical combination of multiple events
EventDesc | An event descriptor
Rule | A Rule binds an action to a condition
Event | Event has a type: a STATE event indicates that a boolean state has been changed, i.e
KeyValue | Helper that is used wherever key/value pairs are required
Service_1_0_1 | Event Service
TimerEventManager_2_0_0 | TimerEventManager interface
Range | Range structure
Schedule | Schedule structure
TimerEvent | TimerEvent structure
firmware | Firmware Management
Firmware_2_0_1 | Firmware management methods
FirmwareUpdateStatus | Firmware update status interface
ImageInfo_1_0_1 | Firmware image information
ImageStatus | Image upload/download status
UpdateHistoryEntry | Firmware update history entry TODO: implement CR# 45668 on next interface change add comment field based on firmware tag "char tag[64];" to improve firmware update history entries without rootfs images
UpdateStatus | Firmware update status
fitness | Fitness Daemon
Fitness | Fitness Daemon interface
DataEntry | An entry in the reliability database
ErrorLogEntry | An entry in the reliability error log
HardwareHealth_1_0_1 |
Failure | Hardware Failure
hmi | Human Machine Interface
ExternalBeeper_1_0_1 | External Beeper interface
InternalBeeper_2_0_1 | Internal beeper interface
jsonrpc | Raritan JSON-RPC
NameService | RPC Object Name Service
lhx | LHX
Support | LHX Support Interface
lhxmodel | LHX Model
Config_1_0_1 | LHX Configuration Interface
ComSettings | LHX port communication settings
Lhx_3_2_4 | LHX Interface
AlertStatus | LHX alert status
Capabilities | LHX capabilities
MetaData | LHX metadata
OpState | LHX operational state
ParamCfg | Configuration parameter characteristics
Settings | LHX settings
Parameter_2_0_1 | LHX Parameter Interface
MetaData | Parameter Metadata
Status | Parameter Status
Value | Parameter Value
Sensor_4_0_3 | LHX Sensor Interface
MetaData | Sensor's self describing data
NumThresholds | Numerical sensor thresholds
Reading | Sensor reading
logging | Device Logging
DebugLog_2_0_0 | Device debug log interface
EventLog_2_0_0 | Device event log interface
LogChunk | A log chunk
LogEntry | A log entry
LogInfo | General log info
WlanLog | WLAN diagnostic log interface
luaservice | Lua-Service
Environment_2_0_0 | The struct represents two kinds of information:
Manager_2_0_1 | There is a single manager instance
ScriptOptions_2_0_0 | Some script options
ScriptState | A structure that descripts the state of a script
modbus |
Device |
DeviceID | Modbus encapsulated transport device identification (0x2B / 0x0E)
GatewayMgr |
RtuSettings | Modbus RTU settings
Settings | Modbus gateway settings (extending modb PortMux service)
net | Network Configuration
CommonInfo | Common info
CommonSettings_2_0_0 | Common settings
Diagnostics | Diagnostics interface
DnsInfo | DNS info
DnsSettings_2_0_0 | DNS settings
EapAuthSettings_3_0_0 | EAP authentication settings
EthInfo_1_0_1 | Ethernet interface info
EthLinkMode | Ethernet link mode
EthSettings_2_0_0 | Ethernet interface settings
Info_1_0_1 | Network info
InterfaceInfo | Interface specific info
InterfaceIpSettings_2_0_0 | Interface specific IP settings
InterfaceIPv4Info | Interface specific IPv4 info
InterfaceIPv6Info | Interface specific IPv6 info
InterfaceSettings_2_0_0 | Interface specific settings
IpAddrCidr | IPv4/IPv6 address and prefix len
IpRoute | IPv4/IPv6 route
IpRoutingSettings_2_0_0 | IP protocol specific routing settings
Net_5_0_0 | Network configuration interface
PortForwardingInfo | Port forwarding info
PortForwardingMasterAddrInfo | Port forwarding master address info for an interface
PortForwardingProtocolMapping | Mapping from application protocol id to name and transport protocol
PortForwardingSettings_2_0_0 | Port forwarding settings
RoutingInfo | Routing info
RoutingSettings_2_0_0 | Routing settings
Services | Network services configuration interface
ServiceSettings | Network service settings
Settings_3_0_0 | Network settings
WlanInfo | WLAN interface info
WlanSettings_3_0_0 | WLAN interface settings
pdumodel | PDU Model
Ade | Interface for ADE chips directly connected to main controller
MetaData | ADE metadata
Sample | Raw sample data for a single channel
Bcm | Branch Circuit Monitor
ChannelConfig | Channel Configuration
PhaseConfig | Phase Configuration
Circuit_1_0_3 | BCM circuit
Config | Circuit configuration
PoleSettings | Circuit pole settings
Sensors | Circuit sensors
Settings | Circuit settings
CircuitBreakerStatistic | Overcurrent protector statistics
Controller_4_0_1 | Slave controller interface
MetaData | Slave controller metadata
CtrlStatistic | Slave controller statistics
DoublePole_5_0_0 | For OCP
EDevice | Common base interface for any kind of electrical device that is used in the PDU model, such as inlets, OCPs and outlets
Inlet_2_0_4 | Inlet interface
MetaData | Inlet metadata
Sensors | Inlet sensors
Settings | Inlet settings
MemoryMapController_4_0_1 | Memory map controller
Nameplate_2_0_0 | Component nameplate information
Rating | Component ratings
Outlet_2_1_5 | Outlet interface
LedState | Outlet LED state
MetaData | Outlet metadata
Sensors | Outlet sensors
Settings | Outlet settings
State | Outlet state
OutletGroup_1_0_1 | Main PDU interface
MetaData |
Sensors |
Settings |
OutletGroupManager_1_0_1 | Main PDU interface
OutletStatistic | Outlet statistics
OverCurrentProtector_3_0_4 | Overcurrent protector interface
MetaData | Overcurrent protector metadata
Sensors | Overcurrent protector sensors
Settings | Overcurrent protector settings
OverCurrentProtectorTripSensor_1_0_5 | Overcurrent protector trip sensor interface
Panel_1_1_5 | PMC panel
PanelSettings | Panel settings
Pdu_4_1_6 | Main PDU interface
MetaData | PDU metadata
OutletSequenceState | Outlet sequencing status
Sensors | PDU sensors
Settings | PDU settings
Statistic | PDU statistics
Pole_5_0_0 | An inlet or outlet pole
PowerMeter_1_1_5 | A three-phase power meter (PMC)
Config | Power meter configuration
EnergyPulseSettings | Energy LED pulse settings
Sensors | Power meter sensors
Settings | Power meter settings
PowerMeterController_1_1_5 | Power Meter Controller (PMC) interface
ScanResult | Meter board scan result
PowerQualitySensor_2_0_3 | Power quality sensor interface
Rating_2_0_0 | Numerical usage ratings
ResidualCurrentStateSensor_2_0_3 | Residual current state sensor interface
ThrowPole_2_0_0 | A pole that can select one of multiple inputs
TransferSwitch_4_0_4 | Transfer switch interface
MetaData | Transfer switch metadata
Sensors | Transfer switch sensors
Settings | Transfer switch settings
Statistics | Transfer switch statistics
TransferLogEntry | Transfer log entry
WaveformSample | Sample of voltage and current waveform
TypeBResidualCurrentNumericSensor_1_0_2 | An RCM current sensor of type B (AC/DC) which allows degaussing the sensor
Unit_2_0_1 | Unit interface
MetaData | Unit metadata
Settings | Unit settings
peripheral | Peripheral Devices
Address_4_0_0 | Peripheral device position based address
DeviceID_4_0_0 | Peripheral device identification
DeviceManager_3_0_2 | Peripheral Device Manager
DeviceTypeInfo | Peripheral device type info
FirmwareUpdateState | Firmware update status
MetaData | Peripheral DeviceManager's metadata
Settings | Peripheral DeviceManager's s settings
Statistics | Peripheral device statistics
DeviceSlot_2_0_3 | Peripheral Device Slot
Location | User writeable location
Settings | User configurable slot attributes
DoorHandleControllerPackage_1_0_1 |
G2Production_4_0_0 |
Package_1_0_1 |
PackageInfo_2_0_1 | Peripheral device package information
FirmwareInfo |
Version |
HardwareInfo |
PosElement | Peripheral device position element, list forms position
portsmodel | Ports
Port_2_0_2 | Port interface
DetectionMode | Port detection mode
Properties | Port properties
PortFuse | Interface describing a controllable fuse for a device port
powerlogic |
Config_1_0_1 | Configuration Interface
Settings | PowerLogic port settings
PowerMeter_1_2_5 | PowerLogic Power Meter Interface
ErrorStatus | Error status flags
L2L | Structured object for line to line sensors
L2L_Avg | Structured object for line to line sensors including average
L2N | Structured object for line to neutral voltage sensors
L2N_Avg | Structured object for line to neutral sensors including average
L2N_N_Avg | Structured object for line to neutral sensors including neutral and average
L2N_plain_total | Structured object for line to neutral voltage sensors
MinMaxReading | Structured object grouping minimum, maximum and current sensor
Sensors | Sensors
Setup | PowerLogic Power Meter setup
production | Methods used during production
Production | Methods used during production
radius | RADIUS server interface
ServerSettings_2_0_0 | Server settings
rawcfg | Raw Configuration
RawConfiguration | Raw Configuration Interface
res_mon | Resource Monitor interface
Entry | ResMon Entry
ResMon | ResMon interface
security | Security Configuration
IpFw_2_0_0 | IP packet filter configuration
IpfwRule | IP packet filter rule
PasswordSettings | Password settings
RestrictedServiceAgreement | Restricted Service Agreement settings
RoleAccessControl | Role-based access control settings
RoleAccessRule | Role-based access rule
Security_3_0_2 | Security configuration interface
Settings | Security configuration This structure is deprecated and will be removed in V3.0, use concrete getters and setters instead!
ServiceAuthorization | Service Authorization Configuration
SSHHostKey | SSH host keys
SSHKeyFingerprint | Fingerprints of SSH host key
SSHSettings | SSH authentication settings
sensors | Sensors Model
AccumulatingNumericSensor_2_0_3 | A sensor which accumulates numeric readings (e.g
AlertedSensorManager_1_0_1 | A global instance keeping track of sensors in alerted state
SensorCounts | Statistics about monitored sensors
SensorData | Data about a monitored sensor
Logger_2_1_6 | Sensor logger interface
LogRow | One full log row
Record | Sensor log record
SensorSet | Set of logged sensors
Settings | Sensor logger settings
TimedRecord | Sensor log record with timestamp
NumericSensor_4_0_3 | A sensor with numeric readings
MetaData | Numeric sensor metadata
Range | Range of possible sensor readings
Reading | Numeric sensor reading
Status | Numeric sensor status
ThresholdCapabilities | Threshold capabilities
Thresholds | Numeric sensor thresholds
Sensor_4_0_3 | Sensor interface
TypeSpec | Complete sensor type specification
StateSensor_4_0_3 | Sensor with discrete readings
State | Sensor state
Switch_2_0_5 | Switch is an actuator and an extension to StateSensor
serial | Serial Ports
AnalogModem | Interface for communication with an analog modem attached to a serial port
Settings |
GsmModem_1_0_2 | Interface for communication with a GSM modem attached to a serial port
Information | Structure holding information about the modem and the SIM card
Settings | Structure for holding settings of the GSM modem and its SIM card
PortDispatcher_1_2_2 | Top-level interface of the serial port manager
SerialPort_3_0_1 | Interface describing a physical serial port and the devices which can be attached to it
MetaData | (Static) meta data containing port properties
Settings | Port settings
State | Structure holding information about the current state of the port
servermon | Server Monitor
ServerMonitor_2_0_1 | Server Monitor Interface
Server | Server Entry
ServerPowerSettings | Settings for controlling and checking power state of the server
ServerSettings | Server Reachability Settings
ServerStatus | Server Reachability Status
session | Session Management
HistoryEntry | Session history entry
Session_2_0_0 | Session information
SessionManager_2_0_0 | Session manager interface
smartcard | Card Reader
CardReader_1_0_2 | Card Reader Interface
CardInformation | Card Information
MetaData | Reader Metadata
CardReaderManager_1_0_2 | Card Reader Manager Interface
sys | Low-Level system access methods
System | System access methods
test | Test Interfaces
AuxSerial | Test routines for Raritan Aux Serial interface (RS485 on pins 3 and 6 of RJ45) Require TestMode to be ON
Control | Interface to enter and exit special test modes
Display_1_0_1 | Type-independent display test interface
Info | Collected display meta information
Ethernet | Test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist any of the settings made (TODO: this interface may be combined with a 'decent' network interface
FeatSerial | Test routines for Raritan Feature Serial interface (RS232 with some control lines and switched power) Require TestMode to be ON
Result | Convenience structure to return test or operation results
RS232Serial | Test routines for full RS232 Serial Interface
Unit_1_0_2 | Test interface for PDU components controlled by topofw
um | User Management
SnmpV3 | SNMPv3 interface
usb | USB Ports
Usb_1_0_2 | USB interface
Settings | USB interface settings
UsbDevice | USB device information
usermgmt | User Management
Account | Account information
AuxInfo | Auxiliary user information
Preferences | User preferences
Role | Role management interface
Info | Role information
Privilege | A granted privilege
RoleManager | Role manager interface
ArgumentDesc | Privilege Argument Description
Info | Full role manager information
PrivilegeDesc | Privilege Description
RoleAccount | Role information
SnmpV3Settings | SNMPv3 settings
User_1_0_2 | User interface
UserCapabilities | User Capabilities Describe if certain operations can be performed for user
UserInfo | User information
UserManager_1_0_4 | User manager interface
webcam | Webcam Management
Channel_1_0_1 | The channel interface
Controls | Controls
Format_2_0_0 | Format
Image_2_0_0 | Image
ImageMetaData | Image meta data
Information_3_0_0 | Webcam information
Location | Location
Settings_2_0_0 | Webcam settings
StorageManager_1_0_2 | The storage manager interface
Activity | Activity
ImageStorageMetaData | StorageMetaData
StorageImage | StorageImage
StorageInformation | Information
StorageMetaData | StorageMetaData
StorageSettings | Settings
WebcamStorageInfo | Webcam Storage Info
Webcam_2_0_1 | The webcam interface
WebcamManager_2_0_1 | The webcam manager interface