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

Loading...
Searching...
No Matches
LocalPort.idl
1#ifndef __RADM_LOCALPORT_IDL__
2#define __RADM_LOCALPORT_IDL__
3
4#include <Event.idl>
5#include <KeyboardLayout.idl>
6#include <KvmPort.idl>
7#include <LocalMonitor.idl>
8
9module radm {
10
11 /** Interface for local user interface */
12 interface LocalPort {
13 constant int ERR_INVALID_ARGUMENT = 1; ///< Invalid parameters
14 constant int ERR_ACCESS_DENIED = 2; ///< Port access denied
15
16 /** Key combinations for switching from KVM port to local UI */
17 enumeration HotKey {
18 DOUBLE_SCROLL_LOCK,
19 DOUBLE_NUM_LOCK,
20 DOUBLE_CAPS_LOCK,
21 DOUBLE_LEFT_ALT_KEY,
22 DOUBLE_LEFT_SHIFT_KEY,
23 DOUBLE_LEFT_CTRL_KEY
24 };
25
26 /** Keys for switching from local UI to KVM port */
27 enumeration ConnectKey {
28 DISABLED,
29 LEFT_ALT_KEY,
30 LEFT_SHIFT_KEY,
31 LEFT_CTRL_KEY
32 };
33
34 /** Authentication modes for local UI */
35 enumeration LocalUserAuthMode {
36 COMMON, ///< Use authentication as configured (local/LDAP/Radius)
37 NONE ///< Do not use authentication
38 };
39
40 /** Local port settings */
41 structure Settings {
42 boolean enabled; ///< Whether local port UI is enabled or not
43 KeyboardLayout keyboardLayout; ///< Keyboard language to use
44 HotKey hotkey; ///< Key combination to use for going back from KVM port to UI
45 ConnectKey connectkey; ///< Key to use to trigger switch to KVM port
46 LocalUserAuthMode authMode; ///< Authentication mode for local UI
47 boolean ignoreCCManagedMode; ///< Whether to allow local UI login under CC-SG management
48 };
49
50 /**
51 * Get monitor attached to local port
52 *
53 * @return Local monitor instance
54 */
55 LocalMonitor getMonitor();
56
57 /**
58 * Get local port settings
59 *
60 * @return Port settings
61 */
62 Settings getSettings();
63
64 /**
65 * Set local port settings
66 *
67 * @param settings New settings
68 *
69 * @return 0 if OK
70 * @return 1 if any setting was invalid
71 */
72 int setSettings(in Settings settings);
73
74 /**
75 * Switch local port to show given KVM port
76 *
77 * @param sessionId ID of the session under which to execute the switch
78 * @param port Port to switch to
79 *
80 * @return 0 if OK
81 * @return 1 if session ID was invalid
82 * @return 2 if session is not allowed to access the given port
83 */
84 int switchToPort(in int sessionId, in KvmPort port);
85
86 /** Event: Local port settings have changed */
87 valueobject SettingsChangedEvent extends event.UserEvent {
88 Settings oldSettings; ///< Settings before change
89 Settings newSettings; ///< Settings after change
90 };
91 };
92
93}
94
95#endif //__RADM_LOCALMONITOR_IDL__
radm::KvmPort
Definition KvmPort.idl:11
radm::LocalMonitor
Definition LocalMonitor.idl:9
radm::LocalPort
Interface for local user interface.
Definition LocalPort.idl:12
radm::LocalPort::LocalUserAuthMode
LocalUserAuthMode
Authentication modes for local UI.
Definition LocalPort.idl:35
radm::LocalPort::COMMON
@ COMMON
Use authentication as configured (local/LDAP/Radius)
Definition LocalPort.idl:36
radm::LocalPort::NONE
@ NONE
Do not use authentication.
Definition LocalPort.idl:37
radm::LocalPort::setSettings
int setSettings(in Settings settings)
Set local port settings.
radm::LocalPort::getSettings
Settings getSettings()
Get local port settings.
radm::LocalPort::ERR_ACCESS_DENIED
constant int ERR_ACCESS_DENIED
Port access denied.
Definition LocalPort.idl:14
radm::LocalPort::switchToPort
int switchToPort(in int sessionId, in KvmPort port)
Switch local port to show given KVM port.
radm::LocalPort::ERR_INVALID_ARGUMENT
constant int ERR_INVALID_ARGUMENT
Invalid parameters.
Definition LocalPort.idl:13
radm::LocalPort::HotKey
HotKey
Key combinations for switching from KVM port to local UI.
Definition LocalPort.idl:17
radm::LocalPort::getMonitor
LocalMonitor getMonitor()
Get monitor attached to local port.
radm::LocalPort::ConnectKey
ConnectKey
Keys for switching from local UI to KVM port.
Definition LocalPort.idl:27
radm
Radm Model.
Definition AccessPort.idl:8
radm::KeyboardLayout
KeyboardLayout
Available keyboard languages.
Definition KeyboardLayout.idl:7
radm::LocalPort::SettingsChangedEvent
Event: Local port settings have changed.
Definition LocalPort.idl:87
radm::LocalPort::SettingsChangedEvent::oldSettings
Settings oldSettings
Settings before change.
Definition LocalPort.idl:88
radm::LocalPort::SettingsChangedEvent::newSettings
Settings newSettings
Settings after change.
Definition LocalPort.idl:89
radm::LocalPort::Settings
Local port settings.
Definition LocalPort.idl:41
radm::LocalPort::Settings::ignoreCCManagedMode
boolean ignoreCCManagedMode
Whether to allow local UI login under CC-SG management.
Definition LocalPort.idl:47
radm::LocalPort::Settings::keyboardLayout
KeyboardLayout keyboardLayout
Keyboard language to use.
Definition LocalPort.idl:43
radm::LocalPort::Settings::authMode
LocalUserAuthMode authMode
Authentication mode for local UI.
Definition LocalPort.idl:46
radm::LocalPort::Settings::connectkey
ConnectKey connectkey
Key to use to trigger switch to KVM port.
Definition LocalPort.idl:45
radm::LocalPort::Settings::enabled
boolean enabled
Whether local port UI is enabled or not.
Definition LocalPort.idl:42
radm::LocalPort::Settings::hotkey
HotKey hotkey
Key combination to use for going back from KVM port to UI.
Definition LocalPort.idl:44