Raritan PX2/PX3 JSON-RPC API: Interfaces

Raritan PX2/PX3 JSON-RPC API

Interfaces
This is a list of IDL-defined interfaces and data structures by module:
[detail level 1234]

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