Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2

Loading...
Searching...
No Matches
Interfaces
This is a list of IDL-defined interfaces and data structures by module:
[detail level 123]

►N auth | Local and Remote Authentication Management
C AuthManager | Authentication manager interface
►C ClientCertAuthManager | Configuration interface
C CACertInfo | Information about a single CA certificate
C ClientCertAuthSettings |
C OcspSettings |
►C LdapManager | LDAP server configuration interface
C ServerSettings | Server settings
C Policy | Authentication policy
►C RadiusManager | RADIUS server configuration interface
C ServerSettings | Server settings
►N bulkcfg | Bulk Configuration
►C BulkConfiguration | Bulk Configuration Interface
C Filter | This structure defines a filter
C FilterProfile | Filter profiles are named collections of filters
C RestoredEvent | Event: Bulk configuration restored (also used for restoring config backup)
C SavedEvent | Event: Bulk configuration saved (also used for saving config backup)
C Settings | Settings
C SettingsChangedEvent | Event: Bulk configuration settings changed
►N bulkrpc | Bulk RPC
►C BulkRequest | 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 cert | TLS Certificate Management
►C ServerSSLCert | TLS certificate management interface
C CertInfo | Certificate information
C CommonAttributes | Certificate issuer or subject attributes
C Info | Certificate manager information
C KeyInfo | Public key information
C ReqInfo | Certificate signing request information
►N datetime | Device Date and Time Configuration
►C DateTime | Date and time configuration methods
C Cfg | Device date and time configuration
C ClockChangedEvent | Event that is sent when the device time is changed
C ConfigurationChangedEvent | Event that is sent when the configuration changes
C NtpCfg | Static NTP server configuration
C ZoneCfg | Time zone configuration
C ZoneInfo | Time zone information (see also ZoneCfg)
►N devsettings | Device Settings
►C Smtp | SMTP settings interface
C Configuration | SMTP server configuration
C TestResult | Result of SMTP configuration test
►C Snmp | SNMP agent settings interface
C Configuration | SNMP agent configuration
C ConfigurationChangedEvent |
►C Zeroconf | Zero-config service settings interface
C Settings | Zero-configservice settings
C SettingsChangedEvent |
►N diag | Diagnostics
►C DiagLogSettings | Diagnostic log settings
C LogLevelEntry | An entry containing a context name and its associated context
►N event | Event interface
►C Channel | Event Channel
C EventSelect | Structure to select an Event *
►C Engine | 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 | Event Service
C UserEvent | This UserEvent may be used as base valueobject for all concrete events that are triggered because of user interaction
►N firmware | Firmware Management
C CimFirmwareUpdateStatus | CimFirmware update status interface
►C Firmware | Firmware management methods
C Info | Firmware information
C FirmwareUpdateCompletedEvent | Event: Firmware updated successfully
C FirmwareUpdateEvent | Event: Firmware update base event
C FirmwareUpdateFailedEvent | Event: Firmware update failed
C FirmwareUpdateStartedEvent | Event: Firmware update started
C FirmwareUpdateStatus | Firmware update status interface
C FirmwareValidationFailedEvent | Event: Firmware validation failed
C ImageInfo | Firmware image information
C ImageStatus | Image upload/download status
C SystemShutdownEvent | Event: System shutdown started
C SystemStartupEvent | Event: System startup finished
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 |
C Failure | Hardware Failure
C FailureStatusChangedEvent | Event that is send when the hardware failure status changes
►N idl | Basic IDL definitions
C Event | Common base for all events
►N jsonrpc | Raritan JSON-RPC
C NameService | RPC Object Name Service
►N logging | Device Logging
C DebugLog | Device debug log interface
C EventLog | Device event log interface
C EventLogClearedEvent | Event log cleared event
C LogChunk | A log chunk
C LogEntry | A log entry
C LogInfo | General log info
►N luaservice | Lua-Service
C Environment | The struct represents two kinds of information:
C Manager | There is a single manager instance
C ScriptOptions | Some script options
C ScriptState | A structure that descripts the state of a script
►N net | Network Configuration
C CommonInfo | Common info
C CommonInfoChangedEvent | Event that is send when common network info has changed
C CommonSettings | Common settings
C Diagnostics | Diagnostics interface
C DnsInfo | DNS info
C DnsSettings | DNS settings
C EapAuthSettings | EAP authentication settings
C EthernetFailoverEvent | Event that is sent when a failover between ethernet ports takes place
C EthInfo | Ethernet interface info
C EthInfoChangedEvent | Event that is send when ethernet interface specific network info has changed
C EthLinkMode | Ethernet link mode
C EthSettings | Ethernet interface settings
C Info | Network info
C InterfaceInfo | Interface specific info
C InterfaceInfoChangedEvent | Event that is send when common interface specific network info has changed
C InterfaceIpSettings | Interface specific IP settings
C InterfaceIPv4Info | Interface specific IPv4 info
C InterfaceIPv6Info | Interface specific IPv6 info
C InterfaceSettings | Interface specific settings
C IpAddrCidr | IPv4/IPv6 address and prefix len
C IpRoute | IPv4/IPv6 route
C IpRoutingSettings | IP protocol specific routing settings
C LinkStateChangedEvent | Event that is send when the operational state of an interface changed
C Net | Network configuration interface
C PortForwardingExpansionUnitPresenceStateChangedEvent | Event that is send when the presence state of a downstream port forwarding expansion unit changes
C PortForwardingInfo | Port forwarding info
C PortForwardingPrimaryUnitAddrInfo | Port forwarding primary unit address info for an interface
C PortForwardingProtocolMapping | Mapping from application protocol id to name and transport protocol
C PortForwardingSettings | Port forwarding settings
C RoutingInfo | Routing info
C RoutingSettings | Routing settings
C Services | Network services configuration interface
C ServiceSettings | Network service settings
C Settings | Network settings
C WlanInfo | WLAN interface info
C WlanInfoChangedEvent | Event that is send when WLAN interface specific network info has changed
C WlanSettings | WLAN interface settings
►N production | Methods used during production
C Production | Methods used during production
►N radm | Radm Model
►C AccessPort |
C AssociatedOutletsChangedEvent | Event: The outlet association has changed
C Status |
C StatusChangedEvent | Event: The port status have changed
►C AutoScan |
C NfsStatusChangedEvent | Event: NFS server status has changed
C Settings |
C SettingsChangedEvent | Event: Settings have changed
►C BasePort |
C Metadata |
C NameChangedEvent | Event: Port name has changed
►C Device |
C Metadata |
C NameChangedEvent | Event: The device name has changed
C StateChangedEvent | Event: The device state has changed
C DsamDevice |
►C DsamDeviceManager |
C DeviceAttachedEvent | Event: A DSAM device was connected
C DeviceChangedEvent | Event: Connected DSAM devices list has changed
C DeviceRemovedEvent | Event: A DSAM device was disconnected
C KeywordMappingChangedEvent | Event: The keyword mapping was changed
C UpdateHistoryEntry | DSAM firmware update history entry
►C KeySetManager |
C KeySet | Structure representing a key set (a named group of keyboard key codes)
C KeySetsChangedEvent | Event: List of configured key sets has changed
►C KvmChannel |
C AttachedKvmPortChangedEvent |
C KvmSwitchEvent |
C Metadata |
C VideoResolutionChangedEvent |
►C KvmDevice |
C CustomEdidDataChangedEvent | Event: Custom EDID data changed
C CustomEdidLimits |
C EdidData | EDID data for a given resolution
C TemperatureChangedEvent | Event: Device temperature has changed
C TemperatureReading | Device temperature reading
C UsbProfile | An uploaded USB profile
C UsbProfileAddedEvent | Event: A USB profile was added
C UsbProfileDeletedEvent | Event: A USB profile was deleted
C UsbProfilesChangedEvent | Event: The list of available USB profiles changed
►C KvmManager |
C CimFirmwareInfo |
C CimFirmwareUpdateCompletedEvent | Event: CIM firmware updated successfully
C CimFirmwareUpdateEvent | Event: Firmware update base event
C CimFirmwareUpdateStartedEvent | Event: CIM firmware update started
C CimUpdateHistoryEntry |
C KvmAccessFlags |
C KvmAccessModeChangedEvent | Event: Access mode flags have changed
C KvmSecuritySettingsChangedEvent | Event: The KVM security settings have changed
C SecuritySettings |
C VirtualMediaShare | Data structure for a preconfigured virtual media ISO file on an SMB share
C VirtualMediaSharesChangedEvent | Event: The list of configured virtual media shares has changed
►C KvmPort |
C ActiveUsbProfileChangedEvent | Event: Active USB profile has changed
C Capabilities |
C CapabilitiesChangedEvent | Event: The port capabilities have changed
C CimInfo | Information about a CIM connected to a port
C CimInfoChangedEvent | Event: The port ciminfo have changed
C CimPortSettings | Settings for CIM-based ports
C DigitalPortSettings | Settings for digital (non-CIM) ports
C GroupInfo | Information about group membership of this port
C GroupInfoChangedEvent | Event: The port group has changed
C IntelligentMouseSettings |
C MultiMonitorGroupInfo | Information about group membership in case this port is part of a multi-monitor group
C Settings |
C SettingsChangedEvent | Event: The port settings have changed
C UsbSettings | USB settings for devices without usbProfiles capability
►C LocalMonitor |
C Metadata |
C Status |
C StatusChangeEvent | Event: Status has changed
►C LocalPort | Interface for local user interface
C Settings | Local port settings
C SettingsChangedEvent | Event: Local port settings have changed
►C OutletPort |
C AssociatedAccessPortChangedEvent | Event: The associated port has changed
C PowerOperationEvent | Event: A power operation was started
C PowerStateChangedEvent | Event: The outlet power state has changed
►C PortGroup |
C GroupConfig | Configuration object for a plain port group
C Metadata | Group meta data
C MultiMonitorConfig | Configuration object for a multi-monitor group
C Settings |
C SettingsChangedEvent | Event: Group settings have been changed
►C PortGroupManager |
C PortGroupCreatedEvent | Event: A port group was created
C PortGroupDeletedEvent | Event: A port group was deleted
C PortGroupListChangedEvent | Event: The group list has changed (group was added or removed)
►C PowerDevice |
C Settings |
C SettingsChangedEvent | Event: Device settings have changed
►C PowerDeviceManager |
C PowerDeviceAddedEvent | Event: A power device was added
C PowerDeviceChangedEvent | Event: A power device was added or removed
C PowerDeviceRemovedEvent | Event: A power device was removed
C Settings |
C SettingsChangedEvent | Event: Manager settings changed
►C PowerSupply |
C MetaData |
C Settings |
C SettingsChangedEvent | Event: Power Supply settings has changed
C StatusChangedEvent | Event: PowerSupply status has changed
►C SerialAccessPort |
C DetectedInterfaceTypeChangedEvent | Event: The detected type has changed
C ExitCommandItem |
C Settings |
C SettingsChangedEvent | Event: The port settings have changed
►C TerminalBlock | TerminalBlock interface
C Settings |
C SettingsChangedEvent | Event: The terminal block settings have changed
C Status | Terminal Block Status including input and output
C StatusChangedEvent | Event: The terminal block status have changed
C UsbProfileSettings |
C VideoResolution |
C VirtualMediaChannel |
►N rawcfg | Raw Configuration
►C RawConfiguration | Raw Configuration Interface
C RawConfigDownloadedEvent | Event: Raw configuration downloaded
C RawConfigUpdatedEvent | Event: Raw configuration updated
►N rdm | Rdm Model
►C Rdm |
C ManagementStoppedEvent | Event: CC-SG management was stopped
C Settings | CC-SG management settings
C SettingsChangedEvent | Event: CC-SG management settings have changed
C State | CC-SG management state
C StateChangedEvent | Event: CC-SG management state has changed
►N res_mon | Resource Monitor interface
C Entry | ResMon Entry
C ResMon | ResMon interface
►N security | Security Configuration
C BlockSettings | User blocking settings
C FipsSettings | FIPS settings
C FrontPanelPrivilegesChanged | Front panel privileges have been changed
C IpFw | IP packet filter configuration
C IpfwRule | IP packet filter rule
C PasswordSettings | Password settings
C PasswordSettingsChanged | This Event is emitted after any of the password-settings has been changed
C RestrictedServiceAgreement | Restricted Service Agreement settings
C RestrictedServiceAgreementChanged | Event: The RestrictedServiceAgreement has changed
C RoleAccessControl | Role-based access control settings
C RoleAccessRule | Role-based access rule
C Security | Security configuration interface
C SSHHostKey | SSH host keys
C SSHKeyFingerprint | Fingerprints of SSH host key
C SSHSettings | SSH authentication settings
C TpmInfo | Information about an installed Secure Element
►N serial | Serial Ports
►C AnalogModem | Interface for communication with an analog modem attached to a serial port
C CallEndedEvent | An event that's emitted when a dial-in call was hung up
C CallReceivedEvent | An event that's emitted when a dial-in call was answered
C DialInEvent | Dial-in event
C Settings |
►C GsmModem | 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 SimPinUpdatedEvent | Sim pin updated event
C SimSecurityStatusChangedEvent | Sim card security status changed event
C PortDispatcher | Top-level interface of the serial port manager
►C SerialPort | Interface describing a physical serial port and the devices which can be attached to it
C MetaData | (Static) meta data containing port properties
C ModemAddedEvent | Event emitted when a modem is connected
C ModemEvent | Event emitted when the modem connection state changes
C ModemRemovedEvent | Event emitted when a modem is disconnected
C Settings | Port settings
C State | Structure holding information about the current state of the port
►N session | Session Management
C HistoryEntry | Session history entry
C Session | Session information
►C SessionManager | Session manager interface
C SessionClosedEvent | Event: Session was closed
C SessionCreatedEvent | Event: Session was created
►N sys | Low-Level system access methods
C System | System access methods
►N usb | USB Ports
►C Usb | USB interface
C Settings | USB interface settings
C SettingsChangedEvent | Event: Settings have changed
C UsbDevice | USB device information
►N usermgmt | User Management
C Account | Account information
C AccountAdded | This event is emitted after a new account with the provided username was added
C AccountChanged | This event is emitted if the settings of an account as defined in usermgmt::UserInfo have changed
C AccountEvent | Base type of all account event
C AccountRemoved | This event is emitted after the account with the provided username has been removed
C AccountRenamed | This event is emitted after an account has been renamed
C AuxInfo | Auxiliary user information
C PasswordChanged | This event is emitted after the password for an account was changed
C Preferences | User preferences
►C Role | Role management interface
C Info | Role information
C Privilege | A granted privilege
C Restriction | A restriction
C RoleAdded |
C RoleChanged |
C RoleEvent | Base type of all account event
►C RoleManager | Role manager interface
C ArgumentDesc | Privilege Argument Description
C Info | Full role manager information
C PrivilegeDesc | Privilege Description
C RestrictionDesc | Restriction Description
C RoleAccount | Role information
C RoleRemoved |
C SnmpV3Settings | SNMPv3 settings
C User | User interface
C UserCapabilities | User Capabilities Describe if certain operations can be performed for user
C UserInfo | User information
C UserManager | User manager interface