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

Loading...
Searching...
No Matches
Remote Access Device Management

The root object for the RADM data model is the radm.KvmManager interface which can be found at the well-known URI `/radm/kvmmanager`. The KvmManager object holds following objects and corresponding retrieved methods:

- One KVM device (KvmDevice): getKvmDevice
- A number of KVM channels (KvmChannel): getKvmChannels
- Power Supplies (PowerSupply): getPowerSupplies
- Power device manager (PowerDeviceManager): getPowerDeviceManager
- DSAM device manager (DsamDeviceManager): getDsamDeviceManager
- Port group manager (PortGroupManager): getPortGroupManager

All data models for device and port have a similar set of properties:

- Metadata: Static (immutable) data describing the object, like labels, unique identifier and index. Can be retrieved with the getMetaData method.
- Settings: User-configurable settings like custom names. Can be retrieved with getSettings and written with setSettings.

# Relationships Between Objects

Objects in the KvmManager model are associated in various ways:

- The KvmDevice holds following objects: lists of KVM ports: getKvmPorts list of local monitors: getLocalMonitors local port: getLocalPort
- The PowerDeviceManager holds list of power devices: getPowerDevices
- Each power device holds list of outlets: getOutletPorts
- The DsamDeviceManager holds list of DSAM devices: getDsamDevices
- Each DSAM device holds list of serial ports: getSerialAccessPorts

# KVM Security Settings

KVM security setting can be retrieved with getSecuritySettings via the KvmManager object.

KVM security settings controls following features or functions:

- pcShare: enable/disable PC share
- pcShareIdleTimeout: idle timeout in seconds when existing keyboard/mouse user gives control to other users
- controlPriority: set if local or remote has higher priority on keyboard/mouse operation, or no preferring
- vmShare: enable/disable Virtual Media sharing
- kvmEncryption: enable/disable encryption on KVM and virtual media transfer
- resetPinMode: set device reset mode when holding reset pin
- sshDpa: enable/disable Direct Serial Port Access via SSH
- urlDpa: enable/disable Direct Port Access via URL
- allowIFrame: enable/disable iframe embedded in other web page

# Python example: Get KVM security settings and display
from xeruskvm.rpc import radm
kvm_mgr = radm.KvmManager("/radm/kvmmanager", agent)
sec_settings = kvm_mgr.getSecuritySettings()
print(sec_settings)
radm::KvmManager
Definition KvmManager.idl:18

# Reading device state and port status

## Get device state for power device and DSAM device

# Python example: Get state for powers devices and DSAM devices
from xeruskvm.rpc import radm
kvm_mgr = radm.KvmManager("/radm/kvmmanager", agent)
power_devices = kvm_mgr.getPowerDeviceManager().getPowerDevices()
for pow_dev in power_devices.values():
print(pow_dev.getName())
print(pow_dev.getState())
dsam_devices = kvm_mgr.getDsamDeviceManager().getDsamDevices()
for dsam_dev in dsam_devices:
print(dsam_dev.getName())
print(dsam_dev.getState())