Raritan PX2/PX3 JSON-RPC API
Net.idl
1 
4 module net {
5 
7  enumeration AutoConfigs {
9  DHCP,
11  };
12 
14  structure NetworkConfigIP {
15  boolean gai_prefer_ipv6;
16  };
17 
19  structure IPv4RoutingEntry {
20  string dest;
21  string nexthop;
22  string intf;
23  };
24 
26  structure NetworkConfigIPv4 {
27  boolean enabled;
29  string ipaddr;
30  string netmask;
31  string gateway;
32  string hostname;
33  vector<string> dns_suffixes;
34  boolean override_dns;
35  string dns_ip_1;
36  string dns_ip_2;
37  string domain_name;
38  };
39 
41  structure NetworkConfigIPv6 {
42  boolean enabled;
44  string ipaddr;
45  string gateway;
46  string hostname;
47  vector<string> dns_suffixes;
48  boolean override_dns;
49  string dns_ip_1;
50  string dns_ip_2;
51  string domain_name;
52  };
53 
55  structure IPv6RoutingEntry {
56  string dest;
57  string nexthop;
58  string intf;
59  };
60 
63  boolean enabled;
65  vector<string> ipaddrs;
66  vector<IPv6RoutingEntry> routes;
67  boolean ra_managed;
68  boolean ra_otherconf;
69  vector<string> dns_suffixes;
70  string dns_ip_1;
71  string dns_ip_2;
72  };
73 
75  structure ServiceConfig {
76  string service;
77  boolean enable;
78  int port;
79  };
80 
82  enumeration LanSpeed {
88  };
89 
91  enumeration LanDuplex {
96  };
97 
99  structure LanLinkMode {
102  };
103 
105  enumeration InterfaceMode_2_0_0 {
109  };
110 
116  };
117 
122  };
123 
128  boolean autonegotiation;
129  boolean link;
130  vector<LanLinkMode> supportedModes;
131  };
132 
134  enumeration AuthenticationMode {
138  };
139 
141  enumeration EapOuterMethod {
143  };
144 
146  enumeration EapInnerMethod {
148  };
149 
151  structure EapSettings_2_0_0 {
152  string identity;
153  string password;
156  string caCertificate;
160  };
162 
165  string ssid;
167  string psk;
169  string bssid;
170  };
171 
173  interface Net_3_0_0 {
174 
175  constant int ERR_INVALID_PARAMS = 1;
176 
185  int setNetworkConfigIP(in NetworkConfigIP cfg);
186 
192  void getNetworkConfigIP(out NetworkConfigIP cfg);
193 
202  int setNetworkConfigIPv4(in NetworkConfigIPv4 cfg4);
203 
210  void getNetworkConfigIPv4(out NetworkConfigIPv4 cfg4, out NetworkConfigIPv4 cfg4current);
211 
212  void getNetworkConfigRoutesIPv4(out vector<IPv4RoutingEntry> static_routes, out vector<IPv4RoutingEntry> active_routes);
213  int setNetworkConfigRoutesIPv4(in vector<IPv4RoutingEntry> static_routes);
214 
215  void getNetworkConfigRoutesIPv6(out vector<IPv6RoutingEntry> static_routes, out vector<IPv6RoutingEntry> active_routes);
216  int setNetworkConfigRoutesIPv6(in vector<IPv6RoutingEntry> static_routes);
225  int setNetworkConfigIPv6(in NetworkConfigIPv6 cfg6);
226 
233  void getNetworkConfigIPv6(out NetworkConfigIPv6 cfg6, out NetworkActiveValuesIPv6 ipv6current);
234 
248  int setNetworkConfigServices(in vector<ServiceConfig> services);
249 
255  void getNetworkConfigServices(out vector<ServiceConfig> services);
256 
265  void getNetworkConfigInterface(out InterfaceState_2_0_0 state,
266  out LanInterfaceSettings lan,
267  out LanInterfaceParameters_2_0_0 lancurrent,
269 
274  void getMACs(out InterfaceState_2_0_0 state,
275  out string ethmac, out string wlanmac);
276 
277 
286  int setNetworkConfigLan(in LanInterfaceSettings lancfg);
287 
296  int setNetworkConfigWLan(in WirelessInterfaceSettings_2_0_0 wlancfg);
297 
304  int getBridgeSlaveCount();
305 
306  };
307 
308 }
string dest
Destination address.
Definition: Net.idl:56
vector< string > dns_suffixes
List of DNS domain suffixes.
Definition: Net.idl:47
No authentication.
Definition: Net.idl:135
string ipaddr
Device IP address.
Definition: Net.idl:29
boolean forceTrustedCert
Enforce trusted certificates.
Definition: Net.idl:157
Wireless interface settings.
Definition: Net.idl:164
10 MBit/s
Definition: Net.idl:84
string dns_ip_1
Primary nameserver IP.
Definition: Net.idl:70
string nexthop
Next hop address / Router.
Definition: Net.idl:21
LanDuplex
LAN interface duplex mode.
Definition: Net.idl:91
Device IPv4 configuration.
Definition: Net.idl:26
Network service configuration.
Definition: Net.idl:75
string netmask
Network mask.
Definition: Net.idl:30
boolean enable
true if the service is enabled
Definition: Net.idl:77
vector< string > dns_suffixes
List of DNS domain suffixes.
Definition: Net.idl:69
AuthenticationMode authentication
Authentication mode.
Definition: Net.idl:166
boolean override_dns
Override nameserver information from DHCP.
Definition: Net.idl:34
LanDuplex duplex
Current duplex mode.
Definition: Net.idl:127
LanSpeed
LAN interface speed.
Definition: Net.idl:82
boolean wirelessSupported
if a wireless interface is available
Definition: Net.idl:115
AutoConfigs autocfg
Automatic configuration protocol.
Definition: Net.idl:43
InterfaceMode_2_0_0
LAN interface mode.
Definition: Net.idl:105
string dest
Destination address.
Definition: Net.idl:20
Unknown speed.
Definition: Net.idl:87
boolean allowNotYetValidCertsIfTimeBeforeBuild
allow not yet valid TLS certificates if the system time is before the build time
Definition: Net.idl:159
IPv4 Routing entry.
Definition: Net.idl:19
Device IPv6 active values.
Definition: Net.idl:62
string dns_ip_2
Secondary nameserver IP.
Definition: Net.idl:50
LAN interface settings.
Definition: Net.idl:119
Unknown duplex mode.
Definition: Net.idl:95
LAN interface state.
Definition: Net.idl:112
vector< IPv6RoutingEntry > routes
List of active IPv6 routes.
Definition: Net.idl:66
EapInnerMethod innerMethod
Inner authentication method.
Definition: Net.idl:155
boolean gai_prefer_ipv6
getaddrinfo prefers IPv6 addresses
Definition: Net.idl:15
Network configuration interface.
Definition: Net.idl:173
string domain_name
Domain name.
Definition: Net.idl:37
LanSpeed speed
Speed.
Definition: Net.idl:120
int port
Service TCP port.
Definition: Net.idl:78
string password
EAP password.
Definition: Net.idl:153
boolean autonegotiation
true if auto-negotiation is enabled
Definition: Net.idl:128
string hostname
Device hostname.
Definition: Net.idl:46
boolean link
true if a link is detected
Definition: Net.idl:129
string caCertificate
CA certificate.
Definition: Net.idl:156
string psk
Pre-shared key (for PSK authentication)
Definition: Net.idl:167
string service
Service name.
Definition: Net.idl:76
InterfaceMode_2_0_0 activeMode
Currently used interface type.
Definition: Net.idl:114
Use ethernet gadget on USB device port.
Definition: Net.idl:108
boolean ra_otherconf
Otherconf flag set in RAs.
Definition: Net.idl:68
AutoConfigs autocfg
Automatic configuration protocol.
Definition: Net.idl:64
EapSettings_2_0_0 eap
EAP settings (for EAP authentication)
Definition: Net.idl:168
Full duplex.
Definition: Net.idl:94
Network Configuration.
Definition: Diagnostics.idl:4
string ssid
SSID.
Definition: Net.idl:165
No automatic configuration.
Definition: Net.idl:8
Half duplex.
Definition: Net.idl:93
LanDuplex duplex
Interface duplex mode.
Definition: Net.idl:101
string hostname
Device hostname.
Definition: Net.idl:32
100 MBit/s
Definition: Net.idl:85
EapInnerMethod
EAP inner authentication method.
Definition: Net.idl:146
string ipaddr
Device IPv6 address / Prefix Length.
Definition: Net.idl:44
Use wireless network interface.
Definition: Net.idl:107
Device IPv6 configuration.
Definition: Net.idl:41
EapOuterMethod outerMethod
Outer authentication method.
Definition: Net.idl:154
boolean override_dns
Override nameserver information from DHCP.
Definition: Net.idl:48
Use auto-negotiation to set speed.
Definition: Net.idl:83
string nexthop
Next hop address.
Definition: Net.idl:57
EapOuterMethod
EAP outer authentication method.
Definition: Net.idl:141
LanSpeed speed
Interface speed.
Definition: Net.idl:100
InterfaceMode_2_0_0 mode
Wired or wireless interface configured?
Definition: Net.idl:113
EAP authentication settings.
Definition: Net.idl:151
string gateway
Gateway IP address.
Definition: Net.idl:45
boolean ra_managed
Managed flag set in RAs.
Definition: Net.idl:67
LAN interface link mode.
Definition: Net.idl:99
Use wired network interface.
Definition: Net.idl:106
boolean enabled
IPv6 enabled.
Definition: Net.idl:42
IPv6 Routing entry.
Definition: Net.idl:55
Device IP configuration.
Definition: Net.idl:14
AutoConfigs autocfg
Automatic configuration protocol.
Definition: Net.idl:28
vector< string > dns_suffixes
List of DNS domain suffixes.
Definition: Net.idl:33
boolean enabled
IPv4 enabled.
Definition: Net.idl:27
string identity
EAP identity.
Definition: Net.idl:152
MSCHAPv2 authentication.
Definition: Net.idl:147
Pre-shared key authentication.
Definition: Net.idl:136
1 GBit/s
Definition: Net.idl:86
string dns_ip_1
Primary nameserver IP.
Definition: Net.idl:49
LanSpeed speed
Current speed.
Definition: Net.idl:126
string intf
Network interface.
Definition: Net.idl:58
vector< LanLinkMode > supportedModes
Supported link modes.
Definition: Net.idl:130
string bssid
BSSID, leave empty for automatic access point selection.
Definition: Net.idl:169
PEAP authentication.
Definition: Net.idl:142
AuthenticationMode
WLAN authentication mode.
Definition: Net.idl:134
boolean enabled
IPv6 enabled.
Definition: Net.idl:63
string intf
Network interface.
Definition: Net.idl:22
LanDuplex duplex
Duplex mode.
Definition: Net.idl:121
AutoConfigs
Automatic network configuration protocols.
Definition: Net.idl:7
Use automatic configuration (used for IPv6)
Definition: Net.idl:10
string domain_name
Domain name.
Definition: Net.idl:51
EAP authentication.
Definition: Net.idl:137
string gateway
Gateway IP address.
Definition: Net.idl:31
Current LAN interface parameters.
Definition: Net.idl:125
string dns_ip_2
Secondary nameserver IP.
Definition: Net.idl:36
vector< string > ipaddrs
List of active IPv6 addresses / Prefix Length.
Definition: Net.idl:65
string dns_ip_1
Primary nameserver IP.
Definition: Net.idl:35
Use DHCP for automatic configuration (used for IPv4)
Definition: Net.idl:9
boolean allowOffTimeRangeCerts
allow expired and not yet valid TLS certificates
Definition: Net.idl:158
string dns_ip_2
Secondary nameserver IP.
Definition: Net.idl:71
Use auto-negotiation to set duplex mode.
Definition: Net.idl:92