Raritan PX2/PX3 JSON-RPC API: pdu-json-rpc-api/idl/Net.idl Source File

Raritan PX2/PX3 JSON-RPC API

Net.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2016 Raritan Inc. All rights reserved.
4 */
5
6 #include <Event.idl>
7
8 /**
9 * Network Configuration
10 */
11 module net {
12
13 /** IPv4/IPv6 address and prefix len */
14 structure IpAddrCidr {
15 string addr; // IP address
16 int prefixLen; // Length of network prefix in the IP address
17 };
18
19 /** IPv4/IPv6 route */
20 structure IpRoute {
21 IpAddrCidr destNetAddrCidr; // Destination network address (CIDR)
22 string nextHopAddr; // Address of the next hop (empty when ifName is set)
23 string ifName; // Destination interface (empty if nextHopAddr is set)
24 };
25
26 /** Role of the node when port forwarding is enabled */
27 enumeration PortForwardingRole {
28 MASTER, ///< Node is the port forwarding master
29 SLAVE ///< Node is a port forwarding slave
30 };
31
32 /** Port forwarding settings */
33 structure PortForwardingSettings_2_0_0 {
34 boolean enabled; ///< Controls if port forwarding is enabled
35 PortForwardingRole role; ///< The role of the node (master or slave)
36 string masterDownstreamIfName; ///< Master downstream interface (usb: any USB iface)
37 };
38
39 /** DNS settings */
40 structure DnsSettings_2_0_0 {
41 vector<string> serverAddrs; ///< List of domain name servers addresses (IPv4/IPv6)
42 vector<string> searchSuffixes; ///< List of domain search suffixes
43 boolean resolverPrefersIPv6; ///< Resolver should prefer IPv6 addresses
44 };
45
46 /** IP protocol specific routing settings */
47 structure IpRoutingSettings_2_0_0 {
48 string defaultGatewayAddr; ///< Default gateway address
49 vector<IpRoute> staticRoutes; ///< List of static routes
50 };
51
52 /** Routing settings */
53 structure RoutingSettings_2_0_0 {
54 IpRoutingSettings_2_0_0 ipv4; ///< IPv4 routing settings
55 IpRoutingSettings_2_0_0 ipv6; ///< IPv6 routing settings
56 };
57
58 /** Common settings */
59 structure CommonSettings_2_0_0 {
60 DnsSettings_2_0_0 dns; ///< DNS settings
61 RoutingSettings_2_0_0 routing; ///< Routing settings
62 PortForwardingSettings_2_0_0 portForwarding; ///< Port forwarding settings
63 };
64
65 /** Port forwarding master address info for an interface */
66 structure PortForwardingMasterAddrInfo {
67 string ifName; ///< interface name on master
68 string addr; ///< IPv4/IPv6 address on the interface
69 };
70
71 /** Port forwarding info */
72 structure PortForwardingInfo {
73 boolean enabled; ///< \c true if port forwarding is enabled
74 boolean nodeIndexValid; ///< \c true if nodeIndex is valid
75 int nodeIndex; ///< Index of the node in the port forwarding cascade
76 boolean slaveConnected; ///< \c true if this node has a slave connected
77 string masterDownstreamIfName; ///< Master downstream interface (usb: any USB iface)
78 ///< the first entry of each vector has the default route set (if default route is set at all)
79 vector<PortForwardingMasterAddrInfo> masterIPv4AddrInfos; ///< Master address info for IPv4
80 vector<PortForwardingMasterAddrInfo> masterIPv6AddrInfos; ///< Master address info for IPv6
81 };
82
83 /** DNS info */
84 structure DnsInfo {
85 vector<string> serverAddrs; ///< List of active domain name server addresses
86 vector<string> searchSuffixes; ///< List of active domain search suffixes
87 boolean resolverPrefersIPv6; ///< Resolver should prefer IPv6 addresses
88 };
89
90 /** Routing info */
91 structure RoutingInfo {
92 vector<IpRoute> ipv4Routes; ///< List of active IPv4 routes
93 vector<IpRoute> ipv6Routes; ///< List of active IPv6 routes
94 };
95
96 /** Common info */
97 structure CommonInfo {
98 DnsInfo dns; ///< DNS info
99 RoutingInfo routing; ///< Routing info
100 PortForwardingInfo portForwarding; ///< Port forwarding info
101 };
102
103 /** IP configuration method */
104 enumeration IpConfigMethod {
105 STATIC, ///< No automatic configuration
106 DHCP, ///< Use DHCP for automatic configuration (IPv4 only)
107 AUTO ///< Use automatic configuration (IPv6 only)
108 };
109
110 /** Interface specific IP settings */
111 structure InterfaceIpSettings_2_0_0 {
112 boolean enabled; ///< Controls if IPv4/IPv6 is enabled
113 IpConfigMethod configMethod; ///< Interface configuration method
114 IpAddrCidr staticAddrCidr; ///< Statically assigned IPv4/IPv6 address (CIDR)
115 string dhcpPreferredHostname; ///< Preferred hostname (only used with DHCP)
116 };
117
118 /** Interface specific IPv4 info */
119 structure InterfaceIPv4Info {
120 boolean enabled; ///< \c true if IPv4 is enabled
121 IpConfigMethod configMethod; ///< Interface configuration method
122 vector<IpAddrCidr> addrsCidr; ///< List of active IPv4 addresses with prefix length
123 string dhcpServerAddr; ///< IPv4 address of DHCP server or empty
124 string dhcpPreferredHostname; ///< Preferred hostname (only used with DHCP)
125 };
126
127 /** Interface specific IPv6 info */
128 structure InterfaceIPv6Info {
129 boolean enabled; ///< \c true if IPv6 is enabled
130 IpConfigMethod configMethod; ///< Interface configuration method
131 vector<IpAddrCidr> addrsCidr; ///< List of active IPv6 addresses with prefix length
132 string dhcpServerId; ///< DHCPv6 server id or empty
133 string dhcpPreferredHostname; ///< Preferred hostname (only used with DHCP)
134 boolean raManaged; ///< "Managed" flag set in router announcements
135 boolean raOtherConf; ///< "OtherConf" flag set in router announcements
136 };
137
138 /** Interface specific settings */
139 structure InterfaceSettings_2_0_0 {
140 boolean enabled; ///< Controls if interface is enabled
141 InterfaceIpSettings_2_0_0 ipv4; ///< Interface specific IPv4 settings
142 InterfaceIpSettings_2_0_0 ipv6; ///< Interface specific IPv6 settings
143 };
144
145 /** The interface type */
146 enumeration InterfaceType {
147 ETHERNET, ///< Ethernet interface
148 WLAN, ///< WLAN interface
149 BRIDGE ///< Bride interface
150 };
151
152 /** Interface operational state */
153 enumeration InterfaceOpState {
154 NOT_PRESENT, ///< Interface is not present
155 DOWN, ///< Interface is down
156 NO_LINK, ///< Interface has no link
157 UP ///< Interface is up and running
158 };
159
160 /** Interface specific info */
161 structure InterfaceInfo {
162 string name; ///< Internal interface name
163 string label; ///< Interface label (used in user interfaces)
164 InterfaceType type; ///< Interface type
165 boolean enabled; ///< The dynamic enabled state
166 string masterIfName; ///< Master interface (set for bridged interfaces)
167 InterfaceOpState state; ///< Operational state of the interface
168 string macAddr; ///< MAC address of the interface
169 InterfaceIPv4Info ipv4; ///< Interface specific IPv4 info
170 InterfaceIPv6Info ipv6; ///< Interface specific IPv6 info
171 };
172
173 /** EAP outer authentication method */
174 enumeration EapOuterAuthMethod_2_0_0 {
175 EAP_PEAP, ///< PEAP authentication
176 EAP_TLS ///< TLS authentication
177 };
178
179 /** EAP inner authentication method */
180 enumeration EapInnerAuthMethod_2_0_0 {
181 INNER_EAP_MSCHAPv2, ///< MSCHAPv2 authentication
182 INNER_EAP_TLS ///< TLS authentication
183 };
184
185 /** EAP authentication status */
186 enumeration EapStatus {
187 EAP_STATUS_DISABLED, ///< EAP authentication disabled
188 EAP_STATUS_PENDING, ///< EAP authentication pending
189 EAP_STATUS_FAILED, ///< EAP authentication failed
190 EAP_STATUS_SUCCESS ///< EAP authentication succeeded
191 };
192
193 /** EAP authentication settings */
194 structure EapAuthSettings_3_0_0 {
195 string identity; ///< EAP identity
196 string password; ///< EAP password (always empty on retrieval!)
197 boolean clearPassword; ///< Set to \c true when password should be cleared
198 string clientCertChain; ///< client certificate chain
199 string clientPrivKey; ///< client private key (always empty on retrieval!)
200 boolean clearClientPrivKey; ///< Set to \c true to clear the client private key
201 string clientPrivKeyPassword; ///< password of client private key
202 EapOuterAuthMethod_2_0_0 outerMethod; ///< Outer authentication method
203 EapInnerAuthMethod_2_0_0 innerMethod; ///< Inner authentication method
204 string caCertChain; ///< CA certificate chain
205 boolean forceTrustedCert; ///< Enforce trusted certificates
206 boolean allowOffTimeRangeCerts; ///< allow expired and not yet valid TLS certs
207 boolean allowNotYetValidCertsIfTimeBeforeBuild; ///< allow not yet valid TLS certs if
208 ///< the system time is before the build time
209 string authServerName; ///< Name of the RADIUS server (used to verify cert)
210 };
211
212 /** Ethernet speed */
213 enumeration EthSpeed {
214 SPEED_AUTO, ///< Use auto-negotiation to set speed
215 SPEED_MBIT_10, ///< 10 MBit/s
216 SPEED_MBIT_100, ///< 100 MBit/s
217 SPEED_MBIT_1000 ///< 1000 MBit/s (1 GBit/s)
218 };
219
220 /** Ethernet duplex mode */
221 enumeration EthDuplexMode {
222 DUPLEX_MODE_AUTO, ///< Use auto-negotiation to set duplex mode
223 DUPLEX_MODE_HALF, ///< Half duplex
224 DUPLEX_MODE_FULL ///< Full duplex
225 };
226
227 /** Ethernet authentication type */
228 enumeration EthAuthType {
229 ETH_AUTH_NONE, ///< No authentication
230 ETH_AUTH_EAP ///< 802.1x (EAP) authentication
231 };
232
233 /** Ethernet link mode */
234 structure EthLinkMode {
235 EthSpeed speed; ///< Interface speed
236 EthDuplexMode duplexMode; ///< Interface duplex mode
237 };
238
239 /** Ethernet interface settings */
240 structure EthSettings_2_0_0 {
241 EthLinkMode linkMode; ///< Link mode
242 EthAuthType authType; ///< Authentication type
243 EapAuthSettings_3_0_0 eap; ///< EAP Settings for 802.1x authentication
244 };
245
246 /** Ethernet interface info */
247 structure EthInfo_1_0_1 {
248 EapStatus eapStatus; ///< \c status of EAP authentication
249 EthLinkMode linkMode; ///< Current link mode
250 boolean linkModeValid; ///< \c true if linkMode is valid
251 boolean autonegEnabled; ///< \c true if auto-negotiation is enabled
252 boolean linkDetected; ///< \c true if a link is detected
253 vector<EthLinkMode> supportedLinkModes; ///< Supported link modes
254 };
255
256 /** WLAN security protocol */
257 enumeration WlanSecProtocol {
258 WPA2 ///< WPA2 security protocol
259 };
260
261 /** WLAN authentication type */
262 enumeration WlanAuthType_2_0_0 {
263 WLAN_AUTH_NONE, ///< No authentication
264 WLAN_AUTH_PSK, ///< Pre-shared key authentication
265 WLAN_AUTH_EAP ///< 802.1x (EAP) authentication
266 };
267
268 /** WLAN interface settings */
269 structure WlanSettings_3_0_0 {
270 boolean enableHT; ///< Enable high throughput features (802.11n)
271 string ssid; ///< SSID of the wireless network
272 string bssid; ///< BSSID (empty for automatic AP selection)
273 WlanSecProtocol secProtocol; ///< Security protocol (WPA2)
274 WlanAuthType_2_0_0 authType; ///< Authentication type
275 string psk; ///< Pre-shared key (always empty on retrieval!)
276 boolean clearPsk; ///< Set to \c true when PSK should be cleared
277 EapAuthSettings_3_0_0 eap; ///< EAP Settings for 802.1x authentication
278 };
279
280 /** WLAN channel width */
281 enumeration WlanChannelWidth {
282 CHANNEL_WIDTH_UNKNOWN,
283 CHANNEL_WIDTH_20_NO_HT,
284 CHANNEL_WIDTH_20,
285 CHANNEL_WIDTH_40,
286 CHANNEL_WIDTH_80,
287 CHANNEL_WIDTH_80P80,
288 CHANNEL_WIDTH_160
289 };
290
291 /** WLAN interface info */
292 structure WlanInfo {
293 boolean associated; ///< \c true if assoiated to an access point
294 string ssid; ///< SSID of the wireless network
295 string bssid; ///< BSSID of associated access point
296 int channel; ///< Channel number
297 WlanChannelWidth channelWidth; ///< Channel width (this is an id and no frequency!)
298 };
299
300 /** Network settings */
301 structure Settings_3_0_0 {
302 CommonSettings_2_0_0 common; ///< Common network settings
303 map<string, InterfaceSettings_2_0_0> ifMap; ///< Common interface settings
304 map<string, EthSettings_2_0_0> ethMap; ///< Ethernet specific interface settings
305 map<string, WlanSettings_3_0_0> wlanMap;///< WLAN specific interface settings
306 };
307
308 /** Network info */
309 structure Info_1_0_1 {
310 CommonInfo common; ///< Common network info
311 map<string, InterfaceInfo> ifMap; ///< Common interface info
312 map<string, EthInfo_1_0_1> ethMap; ///< Ethernet specific interface info
313 map<string, WlanInfo> wlanMap; ///< WLAN specific interface info
314 };
315
316 /** Mapping from application protocol id to name and transport protocol */
317 structure PortForwardingProtocolMapping {
318 int appProtoId; ///< Application protocol id
319 string appProtoName; ///< Application protocol name
320 string transportProtoName; ///< Transport protocol name
321 };
322
323 /* ---- event definitions ---- */
324
325 /** Event that is send when common network info has changed */
326 valueobject CommonInfoChangedEvent extends idl.Event {
327 CommonInfo commonInfo; ///< Current common network info
328 };
329
330 /** Event that is send when common interface specific network info has changed */
331 valueobject InterfaceInfoChangedEvent extends idl.Event {
332 InterfaceInfo ifInfo; ///< Current common interface specific info
333 };
334
335 /** Event that is send when ethernet interface specific network info has changed */
336 valueobject EthInfoChangedEvent_1_0_1 extends idl.Event {
337 string ifName; ///< Ethernet interface name
338 string ifLabel; ///< interface label
339 EthInfo_1_0_1 ethInfo; ///< Current ethernet interface specific info
340 };
341
342 /** Event that is send when WLAN interface specific network info has changed */
343 valueobject WlanInfoChangedEvent extends idl.Event {
344 string ifName; ///< WLAN interface name
345 WlanInfo wlanInfo; ///< Current WLAN interface specific info
346 };
347
348 /** Event that is send when the operational state of an interface changed */
349 valueobject LinkStateChangedEvent extends idl.Event {
350 string ifName; ///< interface name
351 string ifLabel; ///< interface label
352 InterfaceType ifType; ///< interface type
353 InterfaceOpState ifState; ///< Current operational interface state
354 };
355
356 /** Event that is send when the presence state of a downstream port forwarding slave changes */
357 valueobject PortForwardingSlavePresenceStateChangedEvent extends idl.Event {
358 boolean slavePresent; ///< \c true when a slave is present
359 };
360
361 /** Network configuration interface */
362 interface Net_5_0_0 {
363
364 /** Success code */
365 constant int SUCCESS = 0;
366
367 /** DNS parameter errors */
368 constant int ERR_DNS_TOO_MANY_SERVERS = 100;
369 constant int ERR_DNS_INVALID_SERVER = 101;
370 constant int ERR_DNS_TOO_MANY_SEARCH_SUFFIXES = 102;
371 constant int ERR_DNS_INVALID_SEARCH_SUFFIX = 103;
372
373 /** routing parameter errors */
374 constant int ERR_ROUTING_IPV4_INVALID_DFLT_GATEWAY_ADDR = 200;
375 constant int ERR_ROUTING_IPV6_INVALID_DFLT_GATEWAY_ADDR = 201;
376 constant int ERR_ROUTING_IPV4_INVALID_DEST_ADDR = 202;
377 constant int ERR_ROUTING_IPV6_INVALID_DEST_ADDR = 203;
378 constant int ERR_ROUTING_IPV4_INVALID_DEST_PREFIX_LEN = 204;
379 constant int ERR_ROUTING_IPV6_INVALID_DEST_PREFIX_LEN = 205;
380 constant int ERR_ROUTING_IPV4_INVALID_NEXTHOP_ADDR = 206;
381 constant int ERR_ROUTING_IPV6_INVALID_NEXTHOP_ADDR = 207;
382 constant int ERR_ROUTING_IPV4_INVALID_INTERFACE = 208;
383 constant int ERR_ROUTING_IPV6_INVALID_INTERFACE = 209;
384 constant int ERR_ROUTING_IPV4_DEST_IS_NO_NETWORK_ADDR = 210;
385 constant int ERR_ROUTING_IPV6_DEST_IS_NO_NETWORK_ADDR = 211;
386 constant int ERR_ROUTING_IPV4_DEST_IS_DUPLICATE = 212;
387 constant int ERR_ROUTING_IPV6_DEST_IS_DUPLICATE = 213;
388 constant int ERR_ROUTING_IPV4_NO_NEXTHOP_OR_INTERFACE = 214;
389 constant int ERR_ROUTING_IPV6_NO_NEXTHOP_OR_INTERFACE = 215;
390 constant int ERR_ROUTING_IPV4_NEXTHOP_AND_INTERFACE_SET = 216;
391 constant int ERR_ROUTING_IPV6_NEXTHOP_AND_INTERFACE_SET = 217;
392
393 /** port forwarding parameter errors */
394 constant int ERR_PF_INVALID_MASTER_DOWNSTREAM_INTERFACE = 300;
395 constant int ERR_PF_NO_WORKING_MASTER_UPSTREAM_INTERFACE= 301;
396
397 /** interface common parameter errors */
398 constant int ERR_IF_IPV4_INVALID_CONFIG_METHOD = 400;
399 constant int ERR_IF_IPV6_INVALID_CONFIG_METHOD = 401;
400 constant int ERR_IF_IPV4_INVALID_STATIC_ADDR = 402;
401 constant int ERR_IF_IPV6_INVALID_STATIC_ADDR = 403;
402 constant int ERR_IF_IPV4_INVALID_STATIC_PREFIX_LEN = 404;
403 constant int ERR_IF_IPV6_INVALID_STATIC_PREFIX_LEN = 405;
404 constant int ERR_IF_IPV4_INVALID_DHCP_PREF_HOSTNAME = 406;
405 constant int ERR_IF_IPV6_INVALID_DHCP_PREF_HOSTNAME = 407;
406 constant int ERR_IF_EAP_INVALID_IDENTITY = 408;
407 constant int ERR_IF_EAP_INVALID_PASSWORD = 409;
408 constant int ERR_IF_EAP_INVALID_CLIENT_CERT = 410;
409 constant int ERR_IF_EAP_INVALID_CLIENT_PRIV_KEY_OR_PWD = 411;
410 constant int ERR_IF_EAP_CLIENT_CERT_PRIV_KEY_MISMATCH = 412;
411 constant int ERR_IF_EAP_INVALID_CA_CERT = 413;
412 constant int ERR_IF_EAP_CA_CERT_VERIFY_FAILED = 414; /* not used anymore */
413 constant int ERR_IF_EAP_INVALID_AUTH_SERVER_NAME = 415;
414
415 /** Ethernet interface parameter errors */
416 constant int ERR_ETH_IF_UNSUPPORTED_LINKMODE = 500;
417
418 /** WLAN interface parameter errors */
419 constant int ERR_WLAN_IF_INVALID_SSID = 600;
420 constant int ERR_WLAN_IF_INVALID_BSSID = 601;
421 constant int ERR_WLAN_IF_INVALID_PSK = 602;
422
423 /**
424 * Retrieve information about all network interfaces.
425 *
426 * @return Current network information
427 */
428 Info_1_0_1 getInfo();
429
430 /**
431 * Retrieve the current network interface settings.
432 *
433 * @return Settings for all supported network interfaces
434 */
435 Settings_3_0_0 getSettings();
436
437 /**
438 * Update the network interface settings.
439 *
440 * @param settings New network settings
441 *
442 * @return 0 if OK
443 * @return non-zero in case of error (see error constants above)
444 */
445 int setSettings(in Settings_3_0_0 settings);
446
447 /**
448 * Retrieve the list of port forwarding protocol mappings.
449 *
450 * @return Port forwarding protocol mappings
451 */
452 vector<PortForwardingProtocolMapping> getPortForwardingProtocolMappings();
453
454 };
455
456 }
net::CommonInfo::portForwarding
PortForwardingInfo portForwarding
Port forwarding info.
Definition: Net.idl:100
net::ifState
InterfaceOpState ifState
Current operational interface state.
Definition: Net.idl:353
net::WlanSettings_3_0_0::authType
WlanAuthType_2_0_0 authType
Authentication type.
Definition: Net.idl:274
net::EAP_STATUS_FAILED
EAP authentication failed.
Definition: Net.idl:189
net::Settings_3_0_0::common
CommonSettings_2_0_0 common
Common network settings.
Definition: Net.idl:302
net::DnsInfo::resolverPrefersIPv6
boolean resolverPrefersIPv6
Resolver should prefer IPv6 addresses.
Definition: Net.idl:87
net::DnsSettings_2_0_0::searchSuffixes
vector< string > searchSuffixes
List of domain search suffixes.
Definition: Net.idl:42
net::EapAuthSettings_3_0_0::clientPrivKey
string clientPrivKey
client private key (always empty on retrieval!)
Definition: Net.idl:199
net::PortForwardingSettings_2_0_0::role
PortForwardingRole role
The role of the node (master or slave)
Definition: Net.idl:35
net::UP
Interface is up and running.
Definition: Net.idl:157
net::SPEED_AUTO
Use auto-negotiation to set speed.
Definition: Net.idl:214
net::DUPLEX_MODE_HALF
Half duplex.
Definition: Net.idl:223
net::INNER_EAP_MSCHAPv2
MSCHAPv2 authentication.
Definition: Net.idl:181
net::ETHERNET
Ethernet interface.
Definition: Net.idl:147
net::WlanSettings_3_0_0::clearPsk
boolean clearPsk
Set to true when PSK should be cleared.
Definition: Net.idl:276
net::ETH_AUTH_NONE
No authentication.
Definition: Net.idl:229
net::InterfaceIpSettings_2_0_0
Interface specific IP settings.
Definition: Net.idl:111
net::EapAuthSettings_3_0_0::password
string password
EAP password (always empty on retrieval!)
Definition: Net.idl:196
net::EapAuthSettings_3_0_0::outerMethod
EapOuterAuthMethod_2_0_0 outerMethod
Outer authentication method.
Definition: Net.idl:202
net::InterfaceIPv4Info::addrsCidr
vector< IpAddrCidr > addrsCidr
List of active IPv4 addresses with prefix length.
Definition: Net.idl:122
net::EapAuthSettings_3_0_0::identity
string identity
EAP identity.
Definition: Net.idl:195
net::EthSettings_2_0_0
Ethernet interface settings.
Definition: Net.idl:240
net::Info_1_0_1
Network info.
Definition: Net.idl:309
net::WlanInfo::bssid
string bssid
BSSID of associated access point.
Definition: Net.idl:295
net::wlanInfo
WlanInfo wlanInfo
Current WLAN interface specific info.
Definition: Net.idl:345
net::EapAuthSettings_3_0_0::forceTrustedCert
boolean forceTrustedCert
Enforce trusted certificates.
Definition: Net.idl:205
net::PortForwardingMasterAddrInfo::ifName
string ifName
interface name on master
Definition: Net.idl:67
net::PortForwardingProtocolMapping::transportProtoName
string transportProtoName
Transport protocol name.
Definition: Net.idl:320
net::WlanSettings_3_0_0::psk
string psk
Pre-shared key (always empty on retrieval!)
Definition: Net.idl:275
net::InterfaceSettings_2_0_0
Interface specific settings.
Definition: Net.idl:139
net::InterfaceIpSettings_2_0_0::staticAddrCidr
IpAddrCidr staticAddrCidr
Statically assigned IPv4/IPv6 address (CIDR)
Definition: Net.idl:114
net::InterfaceIPv6Info::configMethod
IpConfigMethod configMethod
Interface configuration method.
Definition: Net.idl:130
net::InterfaceIpSettings_2_0_0::configMethod
IpConfigMethod configMethod
Interface configuration method.
Definition: Net.idl:113
net::EapAuthSettings_3_0_0::caCertChain
string caCertChain
CA certificate chain.
Definition: Net.idl:204
net::EAP_STATUS_SUCCESS
EAP authentication succeeded.
Definition: Net.idl:190
net::InterfaceIPv6Info::dhcpPreferredHostname
string dhcpPreferredHostname
Preferred hostname (only used with DHCP)
Definition: Net.idl:133
net::InterfaceIpSettings_2_0_0::dhcpPreferredHostname
string dhcpPreferredHostname
Preferred hostname (only used with DHCP)
Definition: Net.idl:115
net::DUPLEX_MODE_AUTO
Use auto-negotiation to set duplex mode.
Definition: Net.idl:222
net::PortForwardingInfo
Port forwarding info.
Definition: Net.idl:72
net::EthLinkMode::duplexMode
EthDuplexMode duplexMode
Interface duplex mode.
Definition: Net.idl:236
net::EthLinkMode
Ethernet link mode.
Definition: Net.idl:234
net::InterfaceSettings_2_0_0::ipv4
InterfaceIpSettings_2_0_0 ipv4
Interface specific IPv4 settings.
Definition: Net.idl:141
net::Info_1_0_1::wlanMap
map< string, WlanInfo > wlanMap
WLAN specific interface info.
Definition: Net.idl:313
net::IpRoute
IPv4/IPv6 route.
Definition: Net.idl:20
net::Settings_3_0_0
Network settings.
Definition: Net.idl:301
net::DUPLEX_MODE_FULL
Full duplex.
Definition: Net.idl:224
net::InterfaceInfo::macAddr
string macAddr
MAC address of the interface.
Definition: Net.idl:168
net::WlanInfo::ssid
string ssid
SSID of the wireless network.
Definition: Net.idl:294
net::EthInfo_1_0_1::linkMode
EthLinkMode linkMode
Current link mode.
Definition: Net.idl:249
net::DnsInfo
DNS info.
Definition: Net.idl:84
net::PortForwardingInfo::nodeIndex
int nodeIndex
Index of the node in the port forwarding cascade.
Definition: Net.idl:75
net::InterfaceIPv4Info::configMethod
IpConfigMethod configMethod
Interface configuration method.
Definition: Net.idl:121
net::PortForwardingProtocolMapping::appProtoId
int appProtoId
Application protocol id.
Definition: Net.idl:318
net::RoutingSettings_2_0_0
Routing settings.
Definition: Net.idl:53
net::DnsSettings_2_0_0::resolverPrefersIPv6
boolean resolverPrefersIPv6
Resolver should prefer IPv6 addresses.
Definition: Net.idl:43
net::EthSettings_2_0_0::eap
EapAuthSettings_3_0_0 eap
EAP Settings for 802::1x authentication.
Definition: Net.idl:243
net::InterfaceIPv6Info
Interface specific IPv6 info.
Definition: Net.idl:128
net::EAP_TLS
TLS authentication.
Definition: Net.idl:176
net::WLAN_AUTH_EAP
802::1x (EAP) authentication
Definition: Net.idl:265
net::EapAuthSettings_3_0_0::allowOffTimeRangeCerts
boolean allowOffTimeRangeCerts
allow expired and not yet valid TLS certs
Definition: Net.idl:206
net::WlanSettings_3_0_0::bssid
string bssid
BSSID (empty for automatic AP selection)
Definition: Net.idl:272
net::SPEED_MBIT_1000
1000 MBit/s (1 GBit/s)
Definition: Net.idl:217
net::EapAuthSettings_3_0_0::authServerName
string authServerName
Name of the RADIUS server (used to verify cert)
Definition: Net.idl:209
net::CommonInfo::dns
DnsInfo dns
DNS info.
Definition: Net.idl:98
net::WLAN
WLAN interface.
Definition: Net.idl:148
net::InterfaceType
InterfaceType
The interface type.
Definition: Net.idl:146
net::BRIDGE
Bride interface.
Definition: Net.idl:149
net::EthInfo_1_0_1::linkDetected
boolean linkDetected
true if a link is detected
Definition: Net.idl:252
net::InterfaceIPv6Info::dhcpServerId
string dhcpServerId
DHCPv6 server id or empty.
Definition: Net.idl:132
net::PortForwardingProtocolMapping::appProtoName
string appProtoName
Application protocol name.
Definition: Net.idl:319
net::WlanInfo::associated
boolean associated
true if assoiated to an access point
Definition: Net.idl:293
net::CommonSettings_2_0_0::dns
DnsSettings_2_0_0 dns
DNS settings.
Definition: Net.idl:60
net::InterfaceInfo::type
InterfaceType type
Interface type.
Definition: Net.idl:164
net::PortForwardingInfo::nodeIndexValid
boolean nodeIndexValid
true if nodeIndex is valid
Definition: Net.idl:74
net::RoutingSettings_2_0_0::ipv6
IpRoutingSettings_2_0_0 ipv6
IPv6 routing settings.
Definition: Net.idl:55
net::WlanSecProtocol
WlanSecProtocol
WLAN security protocol.
Definition: Net.idl:257
net::InterfaceInfo::enabled
boolean enabled
The dynamic enabled state.
Definition: Net.idl:165
net::EAP_STATUS_PENDING
EAP authentication pending.
Definition: Net.idl:188
net::EapAuthSettings_3_0_0::clientCertChain
string clientCertChain
client certificate chain
Definition: Net.idl:198
net::Info_1_0_1::ifMap
map< string, InterfaceInfo > ifMap
Common interface info.
Definition: Net.idl:311
net::STATIC
No automatic configuration.
Definition: Net.idl:105
net::WlanChannelWidth
WlanChannelWidth
WLAN channel width.
Definition: Net.idl:281
net::IpRoutingSettings_2_0_0
IP protocol specific routing settings.
Definition: Net.idl:47
net::CommonInfo::routing
RoutingInfo routing
Routing info.
Definition: Net.idl:99
net::PortForwardingInfo::slaveConnected
boolean slaveConnected
true if this node has a slave connected
Definition: Net.idl:76
net::DnsSettings_2_0_0::serverAddrs
vector< string > serverAddrs
List of domain name servers addresses (IPv4/IPv6)
Definition: Net.idl:41
net::EapAuthSettings_3_0_0
EAP authentication settings.
Definition: Net.idl:194
idl
Basic IDL definitions.
Definition: Event.idl:10
net::InterfaceIPv6Info::raOtherConf
boolean raOtherConf
"OtherConf" flag set in router announcements
Definition: Net.idl:135
net::NOT_PRESENT
Interface is not present.
Definition: Net.idl:154
net::WlanInfo::channel
int channel
Channel number.
Definition: Net.idl:296
net::WlanSettings_3_0_0::eap
EapAuthSettings_3_0_0 eap
EAP Settings for 802::1x authentication.
Definition: Net.idl:277
net::Info_1_0_1::ethMap
map< string, EthInfo_1_0_1 > ethMap
Ethernet specific interface info.
Definition: Net.idl:312
net::InterfaceIPv4Info::dhcpPreferredHostname
string dhcpPreferredHostname
Preferred hostname (only used with DHCP)
Definition: Net.idl:124
net::IpRoutingSettings_2_0_0::defaultGatewayAddr
string defaultGatewayAddr
Default gateway address.
Definition: Net.idl:48
net::InterfaceIPv4Info
Interface specific IPv4 info.
Definition: Net.idl:119
net::InterfaceIPv6Info::raManaged
boolean raManaged
"Managed" flag set in router announcements
Definition: Net.idl:134
net
Network Configuration.
Definition: Diagnostics.idl:9
net::EthSettings_2_0_0::linkMode
EthLinkMode linkMode
Link mode.
Definition: Net.idl:241
net::RoutingInfo
Routing info.
Definition: Net.idl:91
net::ETH_AUTH_EAP
802::1x (EAP) authentication
Definition: Net.idl:230
net::RoutingSettings_2_0_0::ipv4
IpRoutingSettings_2_0_0 ipv4
IPv4 routing settings.
Definition: Net.idl:54
net::EthInfo_1_0_1::eapStatus
EapStatus eapStatus
status of EAP authentication
Definition: Net.idl:248
net::PortForwardingSettings_2_0_0
Port forwarding settings.
Definition: Net.idl:33
net::WlanSettings_3_0_0
WLAN interface settings.
Definition: Net.idl:269
net::EAP_STATUS_DISABLED
EAP authentication disabled.
Definition: Net.idl:187
net::InterfaceSettings_2_0_0::ipv6
InterfaceIpSettings_2_0_0 ipv6
Interface specific IPv6 settings.
Definition: Net.idl:142
net::EthSpeed
EthSpeed
Ethernet speed.
Definition: Net.idl:213
net::PortForwardingInfo::enabled
boolean enabled
true if port forwarding is enabled
Definition: Net.idl:73
net::WlanInfo
WLAN interface info.
Definition: Net.idl:292
net::RoutingInfo::ipv4Routes
vector< IpRoute > ipv4Routes
List of active IPv4 routes.
Definition: Net.idl:92
net::WlanSettings_3_0_0::enableHT
boolean enableHT
Enable high throughput features (802::11n)
Definition: Net.idl:270
net::EthInfo_1_0_1::autonegEnabled
boolean autonegEnabled
true if auto-negotiation is enabled
Definition: Net.idl:251
net::EapStatus
EapStatus
EAP authentication status.
Definition: Net.idl:186
net::MASTER
Node is the port forwarding master.
Definition: Net.idl:28
net::PortForwardingInfo::masterIPv4AddrInfos
vector< PortForwardingMasterAddrInfo > masterIPv4AddrInfos
Master address info for IPv4.
Definition: Net.idl:79
net::InterfaceIPv4Info::dhcpServerAddr
string dhcpServerAddr
IPv4 address of DHCP server or empty.
Definition: Net.idl:123
net::WlanAuthType_2_0_0
WlanAuthType_2_0_0
WLAN authentication type.
Definition: Net.idl:262
net::ethInfo
EthInfo_1_0_1 ethInfo
Current ethernet interface specific info.
Definition: Net.idl:339
net::WlanSettings_3_0_0::ssid
string ssid
SSID of the wireless network.
Definition: Net.idl:271
net::SPEED_MBIT_10
10 MBit/s
Definition: Net.idl:215
net::WLAN_AUTH_NONE
No authentication.
Definition: Net.idl:263
net::EthLinkMode::speed
EthSpeed speed
Interface speed.
Definition: Net.idl:235
net::EthInfo_1_0_1::supportedLinkModes
vector< EthLinkMode > supportedLinkModes
Supported link modes.
Definition: Net.idl:253
net::PortForwardingRole
PortForwardingRole
Role of the node when port forwarding is enabled.
Definition: Net.idl:27
net::Info_1_0_1::common
CommonInfo common
Common network info.
Definition: Net.idl:310
net::DHCP
Use DHCP for automatic configuration (IPv4 only)
Definition: Net.idl:106
net::PortForwardingInfo::masterDownstreamIfName
string masterDownstreamIfName
Master downstream interface (usb: any USB iface)
Definition: Net.idl:77
net::NO_LINK
Interface has no link.
Definition: Net.idl:156
net::ifType
InterfaceType ifType
interface type
Definition: Net.idl:352
net::EAP_PEAP
PEAP authentication.
Definition: Net.idl:175
net::EapInnerAuthMethod_2_0_0
EapInnerAuthMethod_2_0_0
EAP inner authentication method.
Definition: Net.idl:180
net::EthAuthType
EthAuthType
Ethernet authentication type.
Definition: Net.idl:228
net::InterfaceInfo::masterIfName
string masterIfName
Master interface (set for bridged interfaces)
Definition: Net.idl:166
net::Settings_3_0_0::wlanMap
map< string, WlanSettings_3_0_0 > wlanMap
WLAN specific interface settings.
Definition: Net.idl:305
net::DnsInfo::searchSuffixes
vector< string > searchSuffixes
List of active domain search suffixes.
Definition: Net.idl:86
net::SLAVE
Node is a port forwarding slave.
Definition: Net.idl:29
net::WLAN_AUTH_PSK
Pre-shared key authentication.
Definition: Net.idl:264
net::InterfaceInfo::state
InterfaceOpState state
Operational state of the interface.
Definition: Net.idl:167
net::InterfaceIPv6Info::addrsCidr
vector< IpAddrCidr > addrsCidr
List of active IPv6 addresses with prefix length.
Definition: Net.idl:131
net::PortForwardingSettings_2_0_0::enabled
boolean enabled
Controls if port forwarding is enabled.
Definition: Net.idl:34
net::WlanInfo::channelWidth
WlanChannelWidth channelWidth
Channel width (this is an id and no frequency!)
Definition: Net.idl:297
net::CommonSettings_2_0_0
Common settings.
Definition: Net.idl:59
net::InterfaceInfo::label
string label
Interface label (used in user interfaces)
Definition: Net.idl:163
net::EthSettings_2_0_0::authType
EthAuthType authType
Authentication type.
Definition: Net.idl:242
net::InterfaceInfo::name
string name
Internal interface name.
Definition: Net.idl:162
net::PortForwardingProtocolMapping
Mapping from application protocol id to name and transport protocol.
Definition: Net.idl:317
net::EapAuthSettings_3_0_0::clearClientPrivKey
boolean clearClientPrivKey
Set to true to clear the client private key.
Definition: Net.idl:200
net::InterfaceSettings_2_0_0::enabled
boolean enabled
Controls if interface is enabled.
Definition: Net.idl:140
net::EthDuplexMode
EthDuplexMode
Ethernet duplex mode.
Definition: Net.idl:221
net::WlanSettings_3_0_0::secProtocol
WlanSecProtocol secProtocol
Security protocol (WPA2)
Definition: Net.idl:273
net::EapAuthSettings_3_0_0::innerMethod
EapInnerAuthMethod_2_0_0 innerMethod
Inner authentication method.
Definition: Net.idl:203
net::CommonInfoChangedEvent
valueobject CommonInfoChangedEvent
Event that is send when common network info has changed.
Definition: Net.idl:327
net::Net_5_0_0
Network configuration interface.
Definition: Net.idl:362
net::InterfaceIPv6Info::enabled
boolean enabled
true if IPv6 is enabled
Definition: Net.idl:129
net::EapAuthSettings_3_0_0::clearPassword
boolean clearPassword
Set to true when password should be cleared.
Definition: Net.idl:197
net::InterfaceInfo::ipv4
InterfaceIPv4Info ipv4
Interface specific IPv4 info.
Definition: Net.idl:169
net::CommonInfo
Common info.
Definition: Net.idl:97
net::InterfaceInfo
Interface specific info.
Definition: Net.idl:161
net::IpAddrCidr
IPv4/IPv6 address and prefix len.
Definition: Net.idl:14
net::PortForwardingMasterAddrInfo
Port forwarding master address info for an interface.
Definition: Net.idl:66
net::DnsInfo::serverAddrs
vector< string > serverAddrs
List of active domain name server addresses.
Definition: Net.idl:85
net::EapOuterAuthMethod_2_0_0
EapOuterAuthMethod_2_0_0
EAP outer authentication method.
Definition: Net.idl:174
net::Settings_3_0_0::ifMap
map< string, InterfaceSettings_2_0_0 > ifMap
Common interface settings.
Definition: Net.idl:303
net::InterfaceIPv4Info::enabled
boolean enabled
true if IPv4 is enabled
Definition: Net.idl:120
net::InterfaceOpState
InterfaceOpState
Interface operational state.
Definition: Net.idl:153
net::IpRoutingSettings_2_0_0::staticRoutes
vector< IpRoute > staticRoutes
List of static routes.
Definition: Net.idl:49
net::EapAuthSettings_3_0_0::clientPrivKeyPassword
string clientPrivKeyPassword
password of client private key
Definition: Net.idl:201
net::AUTO
Use automatic configuration (IPv6 only)
Definition: Net.idl:107
net::INNER_EAP_TLS
TLS authentication.
Definition: Net.idl:182
net::InterfaceInfo::ipv6
InterfaceIPv6Info ipv6
Interface specific IPv6 info.
Definition: Net.idl:170
net::CommonSettings_2_0_0::routing
RoutingSettings_2_0_0 routing
Routing settings.
Definition: Net.idl:61
net::PortForwardingMasterAddrInfo::addr
string addr
IPv4/IPv6 address on the interface.
Definition: Net.idl:68
net::PortForwardingInfo::masterIPv6AddrInfos
vector< PortForwardingMasterAddrInfo > masterIPv6AddrInfos
Master address info for IPv6.
Definition: Net.idl:80
net::DOWN
Interface is down.
Definition: Net.idl:155
net::IpConfigMethod
IpConfigMethod
IP configuration method.
Definition: Net.idl:104
net::DnsSettings_2_0_0
DNS settings.
Definition: Net.idl:40
net::Settings_3_0_0::ethMap
map< string, EthSettings_2_0_0 > ethMap
Ethernet specific interface settings.
Definition: Net.idl:304
net::RoutingInfo::ipv6Routes
vector< IpRoute > ipv6Routes
List of active IPv6 routes.
Definition: Net.idl:93
net::InterfaceIpSettings_2_0_0::enabled
boolean enabled
Controls if IPv4/IPv6 is enabled.
Definition: Net.idl:112
net::EthInfo_1_0_1::linkModeValid
boolean linkModeValid
true if linkMode is valid
Definition: Net.idl:250
net::EthInfo_1_0_1
Ethernet interface info.
Definition: Net.idl:247
net::PortForwardingSettings_2_0_0::masterDownstreamIfName
string masterDownstreamIfName
Master downstream interface (usb: any USB iface)
Definition: Net.idl:36
net::EapAuthSettings_3_0_0::allowNotYetValidCertsIfTimeBeforeBuild
boolean allowNotYetValidCertsIfTimeBeforeBuild
allow not yet valid TLS certs if
Definition: Net.idl:207
net::WPA2
WPA2 security protocol.
Definition: Net.idl:258
net::ifLabel
string ifLabel
interface label
Definition: Net.idl:338
net::CommonSettings_2_0_0::portForwarding
PortForwardingSettings_2_0_0 portForwarding
Port forwarding settings.
Definition: Net.idl:62
net::SPEED_MBIT_100
100 MBit/s
Definition: Net.idl:216