Loading...
Searching...
No Matches
Net.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2016 Raritan Inc. All rights reserved.
*/
#include <Event.idl>
/**
* Network Configuration
*/
module net {
/** IPv4/IPv6 address and prefix len */
structure IpAddrCidr {
string addr; // IP address
int prefixLen; // Length of network prefix in the IP address
};
/** IPv4/IPv6 route */
structure IpRoute {
IpAddrCidr destNetAddrCidr; // Destination network address (CIDR)
string nextHopAddr; // Address of the next hop (empty when ifName is set)
string ifName; // Destination interface (empty if nextHopAddr is set)
};
/** Role of the node when port forwarding is enabled */
enumeration PortForwardingRole {
PRIMARY_UNIT, ///< Node is a port forwarding primary unit
EXPANSION_UNIT ///< Node is a port forwarding expansion unit
};
/** Port forwarding settings */
structure PortForwardingSettings {
boolean enabled; ///< Controls if port forwarding is enabled
PortForwardingRole role; ///< The role of the node (primary unit or expansion unit)
string primaryUnitDownstreamIfName; ///< Primary unit downstream interface (usb: any USB iface)
};
/** DNS settings */
structure DnsSettings {
vector<string> serverAddrs; ///< List of domain name servers addresses (IPv4/IPv6)
vector<string> searchSuffixes; ///< List of domain search suffixes
boolean resolverPrefersIPv6; ///< Resolver should prefer IPv6 addresses
};
/** IP protocol specific routing settings */
structure IpRoutingSettings {
vector<IpRoute> staticRoutes; ///< List of static routes
};
/** Routing settings */
structure RoutingSettings {
IpRoutingSettings ipv4; ///< IPv4 routing settings
IpRoutingSettings ipv6; ///< IPv6 routing settings
};
/** Common settings */
structure CommonSettings {
DnsSettings dns; ///< DNS settings
RoutingSettings routing; ///< Routing settings
PortForwardingSettings portForwarding; ///< Port forwarding settings
};
/** Port forwarding primary unit address info for an interface */
structure PortForwardingPrimaryUnitAddrInfo {
string ifName; ///< interface name on primary unit
string addr; ///< IPv4/IPv6 address on the interface
};
/** Port forwarding info */
structure PortForwardingInfo {
boolean enabled; ///< \c true if port forwarding is enabled
boolean nodeIndexValid; ///< \c true if nodeIndex is valid
int nodeIndex; ///< Index of the node in the port forwarding cascade
boolean expansionUnitConnected; ///< \c true if this node has an expansion unit connected
string primaryUnitDownstreamIfName; ///< Primary unit downstream interface (usb: any USB iface)
///< the first entry of each vector has the default route set (if default route is set at all)
vector<PortForwardingPrimaryUnitAddrInfo> primaryUnitIPv4AddrInfos; ///< Primary unit address info for IPv4
vector<PortForwardingPrimaryUnitAddrInfo> primaryUnitIPv6AddrInfos; ///< Primary unit address info for IPv6
string linkLocalIPv6Address; ///< link-local address of port forwarding interface
};
/** DNS info */
structure DnsInfo {
vector<string> serverAddrs; ///< List of active domain name server addresses
vector<string> searchSuffixes; ///< List of active domain search suffixes
boolean resolverPrefersIPv6; ///< Resolver should prefer IPv6 addresses
};
/** Routing info */
structure RoutingInfo {
vector<IpRoute> ipv4Routes; ///< List of active IPv4 routes
vector<IpRoute> ipv6Routes; ///< List of active IPv6 routes
};
/** Common info */
structure CommonInfo {
DnsInfo dns; ///< DNS info
RoutingInfo routing; ///< Routing info
PortForwardingInfo portForwarding; ///< Port forwarding info
};
/** IP configuration method */
enumeration IpConfigMethod {
STATIC, ///< No automatic configuration
DHCP, ///< Use DHCP for automatic configuration (IPv4 only)
AUTO ///< Use automatic configuration (IPv6 only)
};
/** Interface specific IP settings */
structure InterfaceIpSettings {
boolean enabled; ///< Controls if IPv4/IPv6 is enabled
IpConfigMethod configMethod; ///< Interface configuration method
IpAddrCidr staticAddrCidr; ///< Statically assigned IPv4/IPv6 address (CIDR)
string staticDefaultGatewayAddr; ///< Statically assigned default gateway address
string dhcpPreferredHostname; ///< Preferred hostname (only used with DHCP)
};
/** Interface specific IPv4 info */
structure InterfaceIPv4Info {
boolean enabled; ///< \c true if IPv4 is enabled
IpConfigMethod configMethod; ///< Interface configuration method
vector<IpAddrCidr> addrsCidr; ///< List of active IPv4 addresses with prefix length
string dhcpServerAddr; ///< IPv4 address of DHCP server or empty
string dhcpPreferredHostname; ///< Preferred hostname (only used with DHCP)
};
/** Interface specific IPv6 info */
structure InterfaceIPv6Info {
boolean enabled; ///< \c true if IPv6 is enabled
IpConfigMethod configMethod; ///< Interface configuration method
vector<IpAddrCidr> addrsCidr; ///< List of active IPv6 addresses with prefix length
string dhcpServerId; ///< DHCPv6 server id or empty
string dhcpPreferredHostname; ///< Preferred hostname (only used with DHCP)
boolean raManaged; ///< "Managed" flag set in router announcements
boolean raOtherConf; ///< "OtherConf" flag set in router announcements
};
/** Interface specific settings */
structure InterfaceSettings {
boolean enabled; ///< Controls if interface is enabled
InterfaceIpSettings ipv4; ///< Interface specific IPv4 settings
InterfaceIpSettings ipv6; ///< Interface specific IPv6 settings
};
/** The interface type */
enumeration InterfaceType {
ETHERNET, ///< Ethernet interface
WLAN, ///< WLAN interface
BRIDGE ///< Bridge interface
};
/** Interface operational state */
enumeration InterfaceOpState {
NOT_PRESENT, ///< Interface is not present
DOWN, ///< Interface is down
NO_LINK, ///< Interface has no link
UP ///< Interface is up and running
};
/** Interface specific info */
structure InterfaceInfo {
string name; ///< Internal interface name
string label; ///< Interface label (used in user interfaces)
InterfaceType type; ///< Interface type
boolean enabled; ///< The dynamic enabled state
string controllingIfName; ///< Controlling interface (set for bridged interfaces)
InterfaceOpState state; ///< Operational state of the interface
string macAddr; ///< MAC address of the interface
int mtu; ///< Maximum Transfer Unit (MTU)
InterfaceIPv4Info ipv4; ///< Interface specific IPv4 info
InterfaceIPv6Info ipv6; ///< Interface specific IPv6 info
};
/** EAP outer authentication method */
enumeration EapOuterAuthMethod {
EAP_PEAP, ///< PEAP authentication
EAP_TLS ///< TLS authentication
};
/** EAP inner authentication method */
enumeration EapInnerAuthMethod {
INNER_EAP_MSCHAPv2, ///< MSCHAPv2 authentication
INNER_EAP_TLS ///< TLS authentication
};
/** EAP authentication status */
enumeration EapStatus {
EAP_STATUS_DISABLED, ///< EAP authentication disabled
EAP_STATUS_PENDING, ///< EAP authentication pending
EAP_STATUS_FAILED, ///< EAP authentication failed
EAP_STATUS_SUCCESS ///< EAP authentication succeeded
};
/** EAP authentication settings */
structure EapAuthSettings {
string identity; ///< EAP identity
string password; ///< EAP password (always empty on retrieval!)
boolean clearPassword; ///< Set to \c true when password should be cleared
string clientCertChain; ///< client certificate chain
string clientPrivKey; ///< client private key (always empty on retrieval!)
boolean clearClientPrivKey; ///< Set to \c true to clear the client private key
string clientPrivKeyPassword; ///< password of client private key
EapOuterAuthMethod outerMethod; ///< Outer authentication method
EapInnerAuthMethod innerMethod; ///< Inner authentication method
string caCertChain; ///< CA certificate chain
boolean forceTrustedCert; ///< Enforce trusted certificates
boolean allowOffTimeRangeCerts; ///< allow expired and not yet valid TLS certs
boolean allowNotYetValidCertsIfTimeBeforeBuild; ///< allow not yet valid TLS certs if
///< the system time is before the build time
string authServerName; ///< Name of the RADIUS server (used to verify cert)
};
/** Ethernet speed */
enumeration EthSpeed {
SPEED_AUTO, ///< Use auto-negotiation to set speed
SPEED_MBIT_10, ///< 10 MBit/s
SPEED_MBIT_100, ///< 100 MBit/s
SPEED_MBIT_1000 ///< 1000 MBit/s (1 GBit/s)
};
/** Ethernet duplex mode */
enumeration EthDuplexMode {
DUPLEX_MODE_AUTO, ///< Use auto-negotiation to set duplex mode
DUPLEX_MODE_HALF, ///< Half duplex
DUPLEX_MODE_FULL ///< Full duplex
};
/** Ethernet authentication type */
enumeration EthAuthType {
ETH_AUTH_NONE, ///< No authentication
ETH_AUTH_EAP ///< 802.1x (EAP) authentication
};
/** Ethernet link mode */
structure EthLinkMode {
EthSpeed speed; ///< Interface speed
EthDuplexMode duplexMode; ///< Interface duplex mode
};
/** Ethernet interface settings */
structure EthSettings {
EthLinkMode linkMode; ///< Link mode
int mtu; ///< Maximum Transfer Unit (MTU)
EthAuthType authType; ///< Authentication type
EapAuthSettings eap; ///< EAP Settings for 802.1x authentication
boolean lldpEnabled; ///< \c true if LLDP is enabled
};
/** Ethernet interface info */
structure EthInfo {
EapStatus eapStatus; ///< \c status of EAP authentication
EthLinkMode linkMode; ///< Current link mode
boolean linkModeValid; ///< \c true if linkMode is valid
boolean autonegEnabled; ///< \c true if auto-negotiation is enabled
boolean linkDetected; ///< \c true if a link is detected
vector<EthLinkMode> supportedLinkModes; ///< Supported link modes
};
/** WLAN security protocol */
enumeration WlanSecProtocol {
WPA2 ///< WPA2 security protocol
};
/** WLAN authentication type */
enumeration WlanAuthType {
WLAN_AUTH_NONE, ///< No authentication
WLAN_AUTH_PSK, ///< Pre-shared key authentication
WLAN_AUTH_EAP ///< 802.1x (EAP) authentication
};
/** WLAN interface settings */
structure WlanSettings {
boolean enableHT; ///< Enable high throughput features (802.11n)
string ssid; ///< SSID of the wireless network
string bssid; ///< BSSID (empty for automatic AP selection)
int mtu; ///< Maximum Transfer Unit (MTU)
WlanSecProtocol secProtocol; ///< Security protocol (WPA2)
WlanAuthType authType; ///< Authentication type
string psk; ///< Pre-shared key (always empty on retrieval!)
boolean clearPsk; ///< Set to \c true when PSK should be cleared
EapAuthSettings eap; ///< EAP Settings for 802.1x authentication
};
/** WLAN channel width */
enumeration WlanChannelWidth {
CHANNEL_WIDTH_UNKNOWN,
CHANNEL_WIDTH_20_NO_HT,
CHANNEL_WIDTH_20,
CHANNEL_WIDTH_40,
CHANNEL_WIDTH_80,
CHANNEL_WIDTH_80P80,
CHANNEL_WIDTH_160
};
/** WLAN interface info */
structure WlanInfo {
boolean associated; ///< \c true if assoiated to an access point
string ssid; ///< SSID of the wireless network
string bssid; ///< BSSID of associated access point
int channel; ///< Channel number
WlanChannelWidth channelWidth; ///< Channel width (this is an id and no frequency!)
};
/** Network settings */
structure Settings {
CommonSettings common; ///< Common network settings
map<string, InterfaceSettings> ifMap; ///< Common interface settings
map<string, EthSettings> ethMap; ///< Ethernet specific interface settings
map<string, WlanSettings> wlanMap;///< WLAN specific interface settings
};
/** Network info */
structure Info {
CommonInfo common; ///< Common network info
map<string, InterfaceInfo> ifMap; ///< Common interface info
map<string, EthInfo> ethMap; ///< Ethernet specific interface info
map<string, WlanInfo> wlanMap;///< WLAN specific interface info
};
/** Mapping from application protocol id to name and transport protocol */
structure PortForwardingProtocolMapping {
int appProtoId; ///< Application protocol id
string appProtoName; ///< Application protocol name
string transportProtoName; ///< Transport protocol name
};
/* ---- event definitions ---- */
/** Event that is send when common network info has changed */
valueobject CommonInfoChangedEvent extends idl.Event {
CommonInfo commonInfo; ///< Current common network info
};
/** Event that is send when common interface specific network info has changed */
valueobject InterfaceInfoChangedEvent extends idl.Event {
InterfaceInfo ifInfo; ///< Current common interface specific info
};
/** Event that is send when ethernet interface specific network info has changed */
valueobject EthInfoChangedEvent extends idl.Event {
string ifName; ///< Ethernet interface name
string ifLabel; ///< interface label
EthInfo ethInfo; ///< Current ethernet interface specific info
};
/** Event that is send when WLAN interface specific network info has changed */
valueobject WlanInfoChangedEvent extends idl.Event {
string ifName; ///< WLAN interface name
WlanInfo wlanInfo; ///< Current WLAN interface specific info
};
/** Event that is send when the operational state of an interface changed */
valueobject LinkStateChangedEvent extends idl.Event {
string ifName; ///< interface name
string ifLabel; ///< interface label
InterfaceType ifType; ///< interface type
InterfaceOpState ifState; ///< Current operational interface state
};
/** Event that is send when the presence state of a downstream port forwarding expansion unit changes */
valueobject PortForwardingExpansionUnitPresenceStateChangedEvent extends idl.Event {
boolean expansionUnitPresent; ///< \c true when an expansion unit is present
};
/** Network configuration interface */
interface Net {
/** Success code */
constant int SUCCESS = 0;
/** DNS parameter errors */
constant int ERR_DNS_TOO_MANY_SERVERS = 100;
constant int ERR_DNS_INVALID_SERVER = 101;
constant int ERR_DNS_TOO_MANY_SEARCH_SUFFIXES = 102;
constant int ERR_DNS_INVALID_SEARCH_SUFFIX = 103;
/** routing parameter errors */
constant int ERR_ROUTING_IPV4_INVALID_DFLT_GATEWAY_ADDR = 200;
constant int ERR_ROUTING_IPV6_INVALID_DFLT_GATEWAY_ADDR = 201;
constant int ERR_ROUTING_IPV4_INVALID_DEST_ADDR = 202;
constant int ERR_ROUTING_IPV6_INVALID_DEST_ADDR = 203;
constant int ERR_ROUTING_IPV4_INVALID_DEST_PREFIX_LEN = 204;
constant int ERR_ROUTING_IPV6_INVALID_DEST_PREFIX_LEN = 205;
constant int ERR_ROUTING_IPV4_INVALID_NEXTHOP_ADDR = 206;
constant int ERR_ROUTING_IPV6_INVALID_NEXTHOP_ADDR = 207;
constant int ERR_ROUTING_IPV4_INVALID_INTERFACE = 208;
constant int ERR_ROUTING_IPV6_INVALID_INTERFACE = 209;
constant int ERR_ROUTING_IPV4_DEST_IS_NO_NETWORK_ADDR = 210;
constant int ERR_ROUTING_IPV6_DEST_IS_NO_NETWORK_ADDR = 211;
constant int ERR_ROUTING_IPV4_DEST_IS_DUPLICATE = 212;
constant int ERR_ROUTING_IPV6_DEST_IS_DUPLICATE = 213;
constant int ERR_ROUTING_IPV4_NO_NEXTHOP_OR_INTERFACE = 214;
constant int ERR_ROUTING_IPV6_NO_NEXTHOP_OR_INTERFACE = 215;
constant int ERR_ROUTING_IPV4_NEXTHOP_AND_INTERFACE_SET = 216;
constant int ERR_ROUTING_IPV6_NEXTHOP_AND_INTERFACE_SET = 217;
/** port forwarding parameter errors */
constant int ERR_PF_INVALID_PRIMARY_UNIT_DOWNSTREAM_INTERFACE = 300;
constant int ERR_PF_NO_WORKING_PRIMARY_UNIT_UPSTREAM_INTERFACE= 301;
constant int ERR_PF_NOT_SUPPORTED = 302;
/** interface common parameter errors */
constant int ERR_IF_IPV4_INVALID_CONFIG_METHOD = 400;
constant int ERR_IF_IPV6_INVALID_CONFIG_METHOD = 401;
constant int ERR_IF_IPV4_INVALID_STATIC_ADDR = 402;
constant int ERR_IF_IPV6_INVALID_STATIC_ADDR = 403;
constant int ERR_IF_IPV4_INVALID_STATIC_PREFIX_LEN = 404;
constant int ERR_IF_IPV6_INVALID_STATIC_PREFIX_LEN = 405;
constant int ERR_IF_IPV4_INVALID_DHCP_PREF_HOSTNAME = 406;
constant int ERR_IF_IPV6_INVALID_DHCP_PREF_HOSTNAME = 407;
constant int ERR_IF_EAP_INVALID_IDENTITY = 408;
constant int ERR_IF_EAP_INVALID_PASSWORD = 409;
constant int ERR_IF_EAP_INVALID_CLIENT_CERT = 410;
constant int ERR_IF_EAP_INVALID_CLIENT_PRIV_KEY_OR_PWD = 411;
constant int ERR_IF_EAP_CLIENT_CERT_PRIV_KEY_MISMATCH = 412;
constant int ERR_IF_EAP_INVALID_CA_CERT = 413;
constant int ERR_IF_EAP_CA_CERT_VERIFY_FAILED = 414; /* not used anymore */
constant int ERR_IF_EAP_INVALID_AUTH_SERVER_NAME = 415;
/** Ethernet interface parameter errors */
constant int ERR_ETH_IF_UNSUPPORTED_LINKMODE = 500;
constant int ERR_ETH_IF_INVALID_MTU = 501;
/** WLAN interface parameter errors */
constant int ERR_WLAN_IF_INVALID_SSID = 600;
constant int ERR_WLAN_IF_INVALID_BSSID = 601;
constant int ERR_WLAN_IF_INVALID_PSK = 602;
constant int ERR_WLAN_IF_INVALID_MTU = 603;
constant int ERR_WLAN_IF_NOT_SUPPORTED = 604;
/** BRIDGE interface parameter errors */
constant int ERR_BRIDGE_IF_NOT_SUPPORTED = 700;
/**
* Retrieve information about all network interfaces.
*
* @return Current network information
*/
Info getInfo();
/**
* Retrieve the current network interface settings.
*
* @return Settings for all supported network interfaces
*/
Settings getSettings();
/**
* Update the network interface settings.
*
* @param settings New network settings
*
* @return 0 if OK
* @return non-zero in case of error (see error constants above)
*/
int setSettings(in Settings settings);
/**
* Retrieve the list of port forwarding protocol mappings.
*
* @return Port forwarding protocol mappings
*/
vector<PortForwardingProtocolMapping> getPortForwardingProtocolMappings();
};
}
net::Net
Network configuration interface.
Definition Net.idl:367
net::Net::getSettings
Settings getSettings()
Retrieve the current network interface settings.
net::Net::ERR_WLAN_IF_INVALID_SSID
constant int ERR_WLAN_IF_INVALID_SSID
WLAN interface parameter errors.
Definition Net.idl:426
net::Net::SUCCESS
constant int SUCCESS
Success code.
Definition Net.idl:370
net::Net::ERR_BRIDGE_IF_NOT_SUPPORTED
constant int ERR_BRIDGE_IF_NOT_SUPPORTED
BRIDGE interface parameter errors.
Definition Net.idl:433
net::Net::getPortForwardingProtocolMappings
vector< PortForwardingProtocolMapping > getPortForwardingProtocolMappings()
Retrieve the list of port forwarding protocol mappings.
net::Net::ERR_ETH_IF_UNSUPPORTED_LINKMODE
constant int ERR_ETH_IF_UNSUPPORTED_LINKMODE
Ethernet interface parameter errors.
Definition Net.idl:422
net::Net::ERR_ROUTING_IPV4_INVALID_DFLT_GATEWAY_ADDR
constant int ERR_ROUTING_IPV4_INVALID_DFLT_GATEWAY_ADDR
routing parameter errors
Definition Net.idl:379
net::Net::ERR_IF_IPV4_INVALID_CONFIG_METHOD
constant int ERR_IF_IPV4_INVALID_CONFIG_METHOD
interface common parameter errors
Definition Net.idl:404
net::Net::ERR_DNS_TOO_MANY_SERVERS
constant int ERR_DNS_TOO_MANY_SERVERS
DNS parameter errors.
Definition Net.idl:373
net::Net::setSettings
int setSettings(in Settings settings)
Update the network interface settings.
net::Net::ERR_PF_INVALID_PRIMARY_UNIT_DOWNSTREAM_INTERFACE
constant int ERR_PF_INVALID_PRIMARY_UNIT_DOWNSTREAM_INTERFACE
port forwarding parameter errors
Definition Net.idl:399
net::Net::getInfo
Info getInfo()
Retrieve information about all network interfaces.
idl
Basic IDL definitions.
Definition Event.idl:10
net
Network Configuration.
Definition Diagnostics.idl:9
net::EthAuthType
EthAuthType
Ethernet authentication type.
Definition Net.idl:230
net::ETH_AUTH_NONE
@ ETH_AUTH_NONE
No authentication.
Definition Net.idl:231
net::ETH_AUTH_EAP
@ ETH_AUTH_EAP
802::1x (EAP) authentication
Definition Net.idl:232
net::EapStatus
EapStatus
EAP authentication status.
Definition Net.idl:188
net::EAP_STATUS_FAILED
@ EAP_STATUS_FAILED
EAP authentication failed.
Definition Net.idl:191
net::EAP_STATUS_PENDING
@ EAP_STATUS_PENDING
EAP authentication pending.
Definition Net.idl:190
net::EAP_STATUS_SUCCESS
@ EAP_STATUS_SUCCESS
EAP authentication succeeded.
Definition Net.idl:192
net::EAP_STATUS_DISABLED
@ EAP_STATUS_DISABLED
EAP authentication disabled.
Definition Net.idl:189
net::IpConfigMethod
IpConfigMethod
IP configuration method.
Definition Net.idl:104
net::STATIC
@ STATIC
No automatic configuration.
Definition Net.idl:105
net::DHCP
@ DHCP
Use DHCP for automatic configuration (IPv4 only)
Definition Net.idl:106
net::AUTO
@ AUTO
Use automatic configuration (IPv6 only)
Definition Net.idl:107
net::EthDuplexMode
EthDuplexMode
Ethernet duplex mode.
Definition Net.idl:223
net::DUPLEX_MODE_AUTO
@ DUPLEX_MODE_AUTO
Use auto-negotiation to set duplex mode.
Definition Net.idl:224
net::DUPLEX_MODE_FULL
@ DUPLEX_MODE_FULL
Full duplex.
Definition Net.idl:226
net::DUPLEX_MODE_HALF
@ DUPLEX_MODE_HALF
Half duplex.
Definition Net.idl:225
net::WlanSecProtocol
WlanSecProtocol
WLAN security protocol.
Definition Net.idl:261
net::WPA2
@ WPA2
WPA2 security protocol.
Definition Net.idl:262
net::EthSpeed
EthSpeed
Ethernet speed.
Definition Net.idl:215
net::SPEED_MBIT_10
@ SPEED_MBIT_10
10 MBit/s
Definition Net.idl:217
net::SPEED_MBIT_100
@ SPEED_MBIT_100
100 MBit/s
Definition Net.idl:218
net::SPEED_AUTO
@ SPEED_AUTO
Use auto-negotiation to set speed.
Definition Net.idl:216
net::SPEED_MBIT_1000
@ SPEED_MBIT_1000
1000 MBit/s (1 GBit/s)
Definition Net.idl:219
net::PortForwardingRole
PortForwardingRole
Role of the node when port forwarding is enabled.
Definition Net.idl:27
net::PRIMARY_UNIT
@ PRIMARY_UNIT
Node is a port forwarding primary unit.
Definition Net.idl:28
net::EXPANSION_UNIT
@ EXPANSION_UNIT
Node is a port forwarding expansion unit.
Definition Net.idl:29
net::WlanChannelWidth
WlanChannelWidth
WLAN channel width.
Definition Net.idl:286
net::WlanAuthType
WlanAuthType
WLAN authentication type.
Definition Net.idl:266
net::WLAN_AUTH_NONE
@ WLAN_AUTH_NONE
No authentication.
Definition Net.idl:267
net::WLAN_AUTH_EAP
@ WLAN_AUTH_EAP
802::1x (EAP) authentication
Definition Net.idl:269
net::WLAN_AUTH_PSK
@ WLAN_AUTH_PSK
Pre-shared key authentication.
Definition Net.idl:268
net::InterfaceOpState
InterfaceOpState
Interface operational state.
Definition Net.idl:154
net::UP
@ UP
Interface is up and running.
Definition Net.idl:158
net::NO_LINK
@ NO_LINK
Interface has no link.
Definition Net.idl:157
net::NOT_PRESENT
@ NOT_PRESENT
Interface is not present.
Definition Net.idl:155
net::DOWN
@ DOWN
Interface is down.
Definition Net.idl:156
net::EapInnerAuthMethod
EapInnerAuthMethod
EAP inner authentication method.
Definition Net.idl:182
net::INNER_EAP_TLS
@ INNER_EAP_TLS
TLS authentication.
Definition Net.idl:184
net::INNER_EAP_MSCHAPv2
@ INNER_EAP_MSCHAPv2
MSCHAPv2 authentication.
Definition Net.idl:183
net::InterfaceType
InterfaceType
The interface type.
Definition Net.idl:147
net::BRIDGE
@ BRIDGE
Bridge interface.
Definition Net.idl:150
net::ETHERNET
@ ETHERNET
Ethernet interface.
Definition Net.idl:148
net::WLAN
@ WLAN
WLAN interface.
Definition Net.idl:149
net::EapOuterAuthMethod
EapOuterAuthMethod
EAP outer authentication method.
Definition Net.idl:176
net::EAP_PEAP
@ EAP_PEAP
PEAP authentication.
Definition Net.idl:177
net::EAP_TLS
@ EAP_TLS
TLS authentication.
Definition Net.idl:178
idl::Event
Common base for all events.
Definition Event.idl:13
net::CommonInfoChangedEvent
Event that is send when common network info has changed.
Definition Net.idl:331
net::CommonInfoChangedEvent::commonInfo
CommonInfo commonInfo
Current common network info.
Definition Net.idl:332
net::CommonInfo
Common info.
Definition Net.idl:97
net::CommonInfo::portForwarding
PortForwardingInfo portForwarding
Port forwarding info.
Definition Net.idl:100
net::CommonInfo::routing
RoutingInfo routing
Routing info.
Definition Net.idl:99
net::CommonInfo::dns
DnsInfo dns
DNS info.
Definition Net.idl:98
net::CommonSettings
Common settings.
Definition Net.idl:58
net::CommonSettings::dns
DnsSettings dns
DNS settings.
Definition Net.idl:59
net::CommonSettings::portForwarding
PortForwardingSettings portForwarding
Port forwarding settings.
Definition Net.idl:61
net::CommonSettings::routing
RoutingSettings routing
Routing settings.
Definition Net.idl:60
net::DnsInfo
DNS info.
Definition Net.idl:84
net::DnsInfo::serverAddrs
vector< string > serverAddrs
List of active domain name server addresses.
Definition Net.idl:85
net::DnsInfo::searchSuffixes
vector< string > searchSuffixes
List of active domain search suffixes.
Definition Net.idl:86
net::DnsInfo::resolverPrefersIPv6
boolean resolverPrefersIPv6
Resolver should prefer IPv6 addresses.
Definition Net.idl:87
net::DnsSettings
DNS settings.
Definition Net.idl:40
net::DnsSettings::resolverPrefersIPv6
boolean resolverPrefersIPv6
Resolver should prefer IPv6 addresses.
Definition Net.idl:43
net::DnsSettings::serverAddrs
vector< string > serverAddrs
List of domain name servers addresses (IPv4/IPv6)
Definition Net.idl:41
net::DnsSettings::searchSuffixes
vector< string > searchSuffixes
List of domain search suffixes.
Definition Net.idl:42
net::EapAuthSettings
EAP authentication settings.
Definition Net.idl:196
net::EapAuthSettings::authServerName
string authServerName
Name of the RADIUS server (used to verify cert)
Definition Net.idl:211
net::EapAuthSettings::clientPrivKeyPassword
string clientPrivKeyPassword
password of client private key
Definition Net.idl:203
net::EapAuthSettings::clientCertChain
string clientCertChain
client certificate chain
Definition Net.idl:200
net::EapAuthSettings::allowOffTimeRangeCerts
boolean allowOffTimeRangeCerts
allow expired and not yet valid TLS certs
Definition Net.idl:208
net::EapAuthSettings::allowNotYetValidCertsIfTimeBeforeBuild
boolean allowNotYetValidCertsIfTimeBeforeBuild
allow not yet valid TLS certs if
Definition Net.idl:209
net::EapAuthSettings::innerMethod
EapInnerAuthMethod innerMethod
Inner authentication method.
Definition Net.idl:205
net::EapAuthSettings::password
string password
EAP password (always empty on retrieval!)
Definition Net.idl:198
net::EapAuthSettings::identity
string identity
EAP identity.
Definition Net.idl:197
net::EapAuthSettings::clearClientPrivKey
boolean clearClientPrivKey
Set to true to clear the client private key.
Definition Net.idl:202
net::EapAuthSettings::outerMethod
EapOuterAuthMethod outerMethod
Outer authentication method.
Definition Net.idl:204
net::EapAuthSettings::clearPassword
boolean clearPassword
Set to true when password should be cleared.
Definition Net.idl:199
net::EapAuthSettings::caCertChain
string caCertChain
CA certificate chain.
Definition Net.idl:206
net::EapAuthSettings::forceTrustedCert
boolean forceTrustedCert
Enforce trusted certificates.
Definition Net.idl:207
net::EapAuthSettings::clientPrivKey
string clientPrivKey
client private key (always empty on retrieval!)
Definition Net.idl:201
net::EthInfoChangedEvent
Event that is send when ethernet interface specific network info has changed.
Definition Net.idl:341
net::EthInfoChangedEvent::ifName
string ifName
Ethernet interface name.
Definition Net.idl:342
net::EthInfoChangedEvent::ifLabel
string ifLabel
interface label
Definition Net.idl:343
net::EthInfoChangedEvent::ethInfo
EthInfo ethInfo
Current ethernet interface specific info.
Definition Net.idl:344
net::EthInfo
Ethernet interface info.
Definition Net.idl:251
net::EthInfo::autonegEnabled
boolean autonegEnabled
true if auto-negotiation is enabled
Definition Net.idl:255
net::EthInfo::linkMode
EthLinkMode linkMode
Current link mode.
Definition Net.idl:253
net::EthInfo::linkModeValid
boolean linkModeValid
true if linkMode is valid
Definition Net.idl:254
net::EthInfo::linkDetected
boolean linkDetected
true if a link is detected
Definition Net.idl:256
net::EthInfo::supportedLinkModes
vector< EthLinkMode > supportedLinkModes
Supported link modes.
Definition Net.idl:257
net::EthInfo::eapStatus
EapStatus eapStatus
status of EAP authentication
Definition Net.idl:252
net::EthLinkMode
Ethernet link mode.
Definition Net.idl:236
net::EthLinkMode::duplexMode
EthDuplexMode duplexMode
Interface duplex mode.
Definition Net.idl:238
net::EthLinkMode::speed
EthSpeed speed
Interface speed.
Definition Net.idl:237
net::EthSettings
Ethernet interface settings.
Definition Net.idl:242
net::EthSettings::lldpEnabled
boolean lldpEnabled
true if LLDP is enabled
Definition Net.idl:247
net::EthSettings::eap
EapAuthSettings eap
EAP Settings for 802::1x authentication.
Definition Net.idl:246
net::EthSettings::linkMode
EthLinkMode linkMode
Link mode.
Definition Net.idl:243
net::EthSettings::mtu
int mtu
Maximum Transfer Unit (MTU)
Definition Net.idl:244
net::EthSettings::authType
EthAuthType authType
Authentication type.
Definition Net.idl:245
net::Info
Network info.
Definition Net.idl:314
net::Info::common
CommonInfo common
Common network info.
Definition Net.idl:315
net::Info::ethMap
map< string, EthInfo > ethMap
Ethernet specific interface info.
Definition Net.idl:317
net::Info::ifMap
map< string, InterfaceInfo > ifMap
Common interface info.
Definition Net.idl:316
net::Info::wlanMap
map< string, WlanInfo > wlanMap
WLAN specific interface info.
Definition Net.idl:318
net::InterfaceIPv4Info
Interface specific IPv4 info.
Definition Net.idl:120
net::InterfaceIPv4Info::enabled
boolean enabled
true if IPv4 is enabled
Definition Net.idl:121
net::InterfaceIPv4Info::dhcpServerAddr
string dhcpServerAddr
IPv4 address of DHCP server or empty.
Definition Net.idl:124
net::InterfaceIPv4Info::dhcpPreferredHostname
string dhcpPreferredHostname
Preferred hostname (only used with DHCP)
Definition Net.idl:125
net::InterfaceIPv4Info::configMethod
IpConfigMethod configMethod
Interface configuration method.
Definition Net.idl:122
net::InterfaceIPv4Info::addrsCidr
vector< IpAddrCidr > addrsCidr
List of active IPv4 addresses with prefix length.
Definition Net.idl:123
net::InterfaceIPv6Info
Interface specific IPv6 info.
Definition Net.idl:129
net::InterfaceIPv6Info::configMethod
IpConfigMethod configMethod
Interface configuration method.
Definition Net.idl:131
net::InterfaceIPv6Info::dhcpServerId
string dhcpServerId
DHCPv6 server id or empty.
Definition Net.idl:133
net::InterfaceIPv6Info::raManaged
boolean raManaged
"Managed" flag set in router announcements
Definition Net.idl:135
net::InterfaceIPv6Info::addrsCidr
vector< IpAddrCidr > addrsCidr
List of active IPv6 addresses with prefix length.
Definition Net.idl:132
net::InterfaceIPv6Info::dhcpPreferredHostname
string dhcpPreferredHostname
Preferred hostname (only used with DHCP)
Definition Net.idl:134
net::InterfaceIPv6Info::enabled
boolean enabled
true if IPv6 is enabled
Definition Net.idl:130
net::InterfaceIPv6Info::raOtherConf
boolean raOtherConf
"OtherConf" flag set in router announcements
Definition Net.idl:136
net::InterfaceInfoChangedEvent
Event that is send when common interface specific network info has changed.
Definition Net.idl:336
net::InterfaceInfoChangedEvent::ifInfo
InterfaceInfo ifInfo
Current common interface specific info.
Definition Net.idl:337
net::InterfaceInfo
Interface specific info.
Definition Net.idl:162
net::InterfaceInfo::name
string name
Internal interface name.
Definition Net.idl:163
net::InterfaceInfo::type
InterfaceType type
Interface type.
Definition Net.idl:165
net::InterfaceInfo::label
string label
Interface label (used in user interfaces)
Definition Net.idl:164
net::InterfaceInfo::macAddr
string macAddr
MAC address of the interface.
Definition Net.idl:169
net::InterfaceInfo::controllingIfName
string controllingIfName
Controlling interface (set for bridged interfaces)
Definition Net.idl:167
net::InterfaceInfo::ipv6
InterfaceIPv6Info ipv6
Interface specific IPv6 info.
Definition Net.idl:172
net::InterfaceInfo::mtu
int mtu
Maximum Transfer Unit (MTU)
Definition Net.idl:170
net::InterfaceInfo::state
InterfaceOpState state
Operational state of the interface.
Definition Net.idl:168
net::InterfaceInfo::ipv4
InterfaceIPv4Info ipv4
Interface specific IPv4 info.
Definition Net.idl:171
net::InterfaceInfo::enabled
boolean enabled
The dynamic enabled state.
Definition Net.idl:166
net::InterfaceIpSettings
Interface specific IP settings.
Definition Net.idl:111
net::InterfaceIpSettings::dhcpPreferredHostname
string dhcpPreferredHostname
Preferred hostname (only used with DHCP)
Definition Net.idl:116
net::InterfaceIpSettings::enabled
boolean enabled
Controls if IPv4/IPv6 is enabled.
Definition Net.idl:112
net::InterfaceIpSettings::configMethod
IpConfigMethod configMethod
Interface configuration method.
Definition Net.idl:113
net::InterfaceIpSettings::staticDefaultGatewayAddr
string staticDefaultGatewayAddr
Statically assigned default gateway address.
Definition Net.idl:115
net::InterfaceIpSettings::staticAddrCidr
IpAddrCidr staticAddrCidr
Statically assigned IPv4/IPv6 address (CIDR)
Definition Net.idl:114
net::InterfaceSettings
Interface specific settings.
Definition Net.idl:140
net::InterfaceSettings::enabled
boolean enabled
Controls if interface is enabled.
Definition Net.idl:141
net::InterfaceSettings::ipv6
InterfaceIpSettings ipv6
Interface specific IPv6 settings.
Definition Net.idl:143
net::InterfaceSettings::ipv4
InterfaceIpSettings ipv4
Interface specific IPv4 settings.
Definition Net.idl:142
net::IpAddrCidr
IPv4/IPv6 address and prefix len.
Definition Net.idl:14
net::IpRoute
IPv4/IPv6 route.
Definition Net.idl:20
net::IpRoutingSettings
IP protocol specific routing settings.
Definition Net.idl:47
net::IpRoutingSettings::staticRoutes
vector< IpRoute > staticRoutes
List of static routes.
Definition Net.idl:48
net::LinkStateChangedEvent
Event that is send when the operational state of an interface changed.
Definition Net.idl:354
net::LinkStateChangedEvent::ifLabel
string ifLabel
interface label
Definition Net.idl:356
net::LinkStateChangedEvent::ifState
InterfaceOpState ifState
Current operational interface state.
Definition Net.idl:358
net::LinkStateChangedEvent::ifName
string ifName
interface name
Definition Net.idl:355
net::LinkStateChangedEvent::ifType
InterfaceType ifType
interface type
Definition Net.idl:357
net::PortForwardingExpansionUnitPresenceStateChangedEvent
Event that is send when the presence state of a downstream port forwarding expansion unit changes.
Definition Net.idl:362
net::PortForwardingExpansionUnitPresenceStateChangedEvent::expansionUnitPresent
boolean expansionUnitPresent
true when an expansion unit is present
Definition Net.idl:363
net::PortForwardingInfo
Port forwarding info.
Definition Net.idl:71
net::PortForwardingInfo::primaryUnitDownstreamIfName
string primaryUnitDownstreamIfName
Primary unit downstream interface (usb: any USB iface)
Definition Net.idl:76
net::PortForwardingInfo::primaryUnitIPv6AddrInfos
vector< PortForwardingPrimaryUnitAddrInfo > primaryUnitIPv6AddrInfos
Primary unit address info for IPv6.
Definition Net.idl:79
net::PortForwardingInfo::nodeIndexValid
boolean nodeIndexValid
true if nodeIndex is valid
Definition Net.idl:73
net::PortForwardingInfo::primaryUnitIPv4AddrInfos
vector< PortForwardingPrimaryUnitAddrInfo > primaryUnitIPv4AddrInfos
Primary unit address info for IPv4.
Definition Net.idl:78
net::PortForwardingInfo::linkLocalIPv6Address
string linkLocalIPv6Address
link-local address of port forwarding interface
Definition Net.idl:80
net::PortForwardingInfo::enabled
boolean enabled
true if port forwarding is enabled
Definition Net.idl:72
net::PortForwardingInfo::expansionUnitConnected
boolean expansionUnitConnected
true if this node has an expansion unit connected
Definition Net.idl:75
net::PortForwardingInfo::nodeIndex
int nodeIndex
Index of the node in the port forwarding cascade.
Definition Net.idl:74
net::PortForwardingPrimaryUnitAddrInfo
Port forwarding primary unit address info for an interface.
Definition Net.idl:65
net::PortForwardingPrimaryUnitAddrInfo::addr
string addr
IPv4/IPv6 address on the interface.
Definition Net.idl:67
net::PortForwardingPrimaryUnitAddrInfo::ifName
string ifName
interface name on primary unit
Definition Net.idl:66
net::PortForwardingProtocolMapping
Mapping from application protocol id to name and transport protocol.
Definition Net.idl:322
net::PortForwardingProtocolMapping::transportProtoName
string transportProtoName
Transport protocol name.
Definition Net.idl:325
net::PortForwardingProtocolMapping::appProtoName
string appProtoName
Application protocol name.
Definition Net.idl:324
net::PortForwardingProtocolMapping::appProtoId
int appProtoId
Application protocol id.
Definition Net.idl:323
net::PortForwardingSettings
Port forwarding settings.
Definition Net.idl:33
net::PortForwardingSettings::enabled
boolean enabled
Controls if port forwarding is enabled.
Definition Net.idl:34
net::PortForwardingSettings::role
PortForwardingRole role
The role of the node (primary unit or expansion unit)
Definition Net.idl:35
net::PortForwardingSettings::primaryUnitDownstreamIfName
string primaryUnitDownstreamIfName
Primary unit downstream interface (usb: any USB iface)
Definition Net.idl:36
net::RoutingInfo
Routing info.
Definition Net.idl:91
net::RoutingInfo::ipv6Routes
vector< IpRoute > ipv6Routes
List of active IPv6 routes.
Definition Net.idl:93
net::RoutingInfo::ipv4Routes
vector< IpRoute > ipv4Routes
List of active IPv4 routes.
Definition Net.idl:92
net::RoutingSettings
Routing settings.
Definition Net.idl:52
net::RoutingSettings::ipv4
IpRoutingSettings ipv4
IPv4 routing settings.
Definition Net.idl:53
net::RoutingSettings::ipv6
IpRoutingSettings ipv6
IPv6 routing settings.
Definition Net.idl:54
net::Settings
Network settings.
Definition Net.idl:306
net::Settings::wlanMap
map< string, WlanSettings > wlanMap
WLAN specific interface settings.
Definition Net.idl:310
net::Settings::ifMap
map< string, InterfaceSettings > ifMap
Common interface settings.
Definition Net.idl:308
net::Settings::ethMap
map< string, EthSettings > ethMap
Ethernet specific interface settings.
Definition Net.idl:309
net::Settings::common
CommonSettings common
Common network settings.
Definition Net.idl:307
net::WlanInfoChangedEvent
Event that is send when WLAN interface specific network info has changed.
Definition Net.idl:348
net::WlanInfoChangedEvent::wlanInfo
WlanInfo wlanInfo
Current WLAN interface specific info.
Definition Net.idl:350
net::WlanInfoChangedEvent::ifName
string ifName
WLAN interface name.
Definition Net.idl:349
net::WlanInfo
WLAN interface info.
Definition Net.idl:297
net::WlanInfo::associated
boolean associated
true if assoiated to an access point
Definition Net.idl:298
net::WlanInfo::ssid
string ssid
SSID of the wireless network.
Definition Net.idl:299
net::WlanInfo::channel
int channel
Channel number.
Definition Net.idl:301
net::WlanInfo::channelWidth
WlanChannelWidth channelWidth
Channel width (this is an id and no frequency!)
Definition Net.idl:302
net::WlanInfo::bssid
string bssid
BSSID of associated access point.
Definition Net.idl:300
net::WlanSettings
WLAN interface settings.
Definition Net.idl:273
net::WlanSettings::secProtocol
WlanSecProtocol secProtocol
Security protocol (WPA2)
Definition Net.idl:278
net::WlanSettings::psk
string psk
Pre-shared key (always empty on retrieval!)
Definition Net.idl:280
net::WlanSettings::ssid
string ssid
SSID of the wireless network.
Definition Net.idl:275
net::WlanSettings::eap
EapAuthSettings eap
EAP Settings for 802::1x authentication.
Definition Net.idl:282
net::WlanSettings::mtu
int mtu
Maximum Transfer Unit (MTU)
Definition Net.idl:277
net::WlanSettings::authType
WlanAuthType authType
Authentication type.
Definition Net.idl:279
net::WlanSettings::bssid
string bssid
BSSID (empty for automatic AP selection)
Definition Net.idl:276
net::WlanSettings::enableHT
boolean enableHT
Enable high throughput features (802::11n)
Definition Net.idl:274
net::WlanSettings::clearPsk
boolean clearPsk
Set to true when PSK should be cleared.
Definition Net.idl:281