Raritan / Server Technology Xerus™ PDU JSON-RPC API
Classes | Enumerations | Variables
net Module Reference

Network Configuration. More...

Classes

interface  Diagnostics
 Diagnostics interface. More...
 
struct  IpAddrCidr
 IPv4/IPv6 address and prefix len. More...
 
struct  IpRoute
 IPv4/IPv6 route. More...
 
struct  PortForwardingSettings
 Port forwarding settings. More...
 
struct  DnsSettings
 DNS settings. More...
 
struct  IpRoutingSettings
 IP protocol specific routing settings. More...
 
struct  RoutingSettings
 Routing settings. More...
 
struct  CommonSettings
 Common settings. More...
 
struct  PortForwardingPrimaryUnitAddrInfo
 Port forwarding primary unit address info for an interface. More...
 
struct  PortForwardingInfo
 Port forwarding info. More...
 
struct  DnsInfo
 DNS info. More...
 
struct  RoutingInfo
 Routing info. More...
 
struct  CommonInfo
 Common info. More...
 
struct  InterfaceIpSettings
 Interface specific IP settings. More...
 
struct  InterfaceIPv4Info
 Interface specific IPv4 info. More...
 
struct  InterfaceIPv6Info
 Interface specific IPv6 info. More...
 
struct  InterfaceSettings
 Interface specific settings. More...
 
struct  InterfaceInfo
 Interface specific info. More...
 
struct  EapAuthSettings
 EAP authentication settings. More...
 
struct  EthLinkMode
 Ethernet link mode. More...
 
struct  EthSettings
 Ethernet interface settings. More...
 
struct  EthInfo
 Ethernet interface info. More...
 
struct  WlanSettings
 WLAN interface settings. More...
 
struct  WlanInfo
 WLAN interface info. More...
 
struct  Settings
 Network settings. More...
 
struct  Info
 Network info. More...
 
struct  PortForwardingProtocolMapping
 Mapping from application protocol id to name and transport protocol. More...
 
interface  Net
 Network configuration interface. More...
 
struct  ServiceSettings
 Network service settings. More...
 
interface  Services
 Network services configuration interface. More...
 

Enumerations

enum  PortForwardingRole { PRIMARY_UNIT , EXPANSION_UNIT }
 Role of the node when port forwarding is enabled. More...
 
enum  IpConfigMethod { STATIC , DHCP , AUTO }
 IP configuration method. More...
 
enum  InterfaceType { ETHERNET , WLAN , BRIDGE }
 The interface type. More...
 
enum  InterfaceOpState { NOT_PRESENT , DOWN , NO_LINK , UP }
 Interface operational state. More...
 
enum  EapOuterAuthMethod { EAP_PEAP , EAP_TLS }
 EAP outer authentication method. More...
 
enum  EapInnerAuthMethod { INNER_EAP_MSCHAPv2 , INNER_EAP_TLS }
 EAP inner authentication method. More...
 
enum  EapStatus { EAP_STATUS_DISABLED , EAP_STATUS_PENDING , EAP_STATUS_FAILED , EAP_STATUS_SUCCESS }
 EAP authentication status. More...
 
enum  EthSpeed { SPEED_AUTO , SPEED_MBIT_10 , SPEED_MBIT_100 , SPEED_MBIT_1000 }
 Ethernet speed. More...
 
enum  EthDuplexMode { DUPLEX_MODE_AUTO , DUPLEX_MODE_HALF , DUPLEX_MODE_FULL }
 Ethernet duplex mode. More...
 
enum  EthAuthType { ETH_AUTH_NONE , ETH_AUTH_EAP }
 Ethernet authentication type. More...
 
enum  WlanSecProtocol { WPA2 }
 WLAN security protocol. More...
 
enum  WlanAuthType { WLAN_AUTH_NONE , WLAN_AUTH_PSK , WLAN_AUTH_EAP }
 WLAN authentication type. More...
 
enum  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 channel width.
 

Variables

valueobject CommonInfoChangedEvent
 Event that is send when common network info has changed. More...
 
valueobject InterfaceInfoChangedEvent
 Event that is send when common interface specific network info has changed. More...
 
valueobject EthInfoChangedEvent
 Event that is send when ethernet interface specific network info has changed. More...
 
string ifLabel
 interface label
 
EthInfo ethInfo
 Current ethernet interface specific info.
 
valueobject WlanInfoChangedEvent
 Event that is send when WLAN interface specific network info has changed. More...
 
WlanInfo wlanInfo
 Current WLAN interface specific info.
 
valueobject LinkStateChangedEvent
 Event that is send when the operational state of an interface changed. More...
 
InterfaceType ifType
 interface type
 
InterfaceOpState ifState
 Current operational interface state.
 
valueobject PortForwardingExpansionUnitPresenceStateChangedEvent
 Event that is send when the presence state of a downstream port forwarding expansion unit changes. More...
 

Detailed Description

Network Configuration.

Network services configuration.

Enumeration Type Documentation

◆ EapInnerAuthMethod

EAP inner authentication method.

Enumerator
INNER_EAP_MSCHAPv2 

MSCHAPv2 authentication.

INNER_EAP_TLS 

TLS authentication.

◆ EapOuterAuthMethod

EAP outer authentication method.

Enumerator
EAP_PEAP 

PEAP authentication.

EAP_TLS 

TLS authentication.

◆ EapStatus

EAP authentication status.

Enumerator
EAP_STATUS_DISABLED 

EAP authentication disabled.

EAP_STATUS_PENDING 

EAP authentication pending.

EAP_STATUS_FAILED 

EAP authentication failed.

EAP_STATUS_SUCCESS 

EAP authentication succeeded.

◆ EthAuthType

Ethernet authentication type.

Enumerator
ETH_AUTH_NONE 

No authentication.

ETH_AUTH_EAP 

802::1x (EAP) authentication

◆ EthDuplexMode

Ethernet duplex mode.

Enumerator
DUPLEX_MODE_AUTO 

Use auto-negotiation to set duplex mode.

DUPLEX_MODE_HALF 

Half duplex.

DUPLEX_MODE_FULL 

Full duplex.

◆ EthSpeed

Ethernet speed.

Enumerator
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)

◆ InterfaceOpState

Interface operational state.

Enumerator
NOT_PRESENT 

Interface is not present.

DOWN 

Interface is down.

NO_LINK 

Interface has no link.

UP 

Interface is up and running.

◆ InterfaceType

The interface type.

Enumerator
ETHERNET 

Ethernet interface.

WLAN 

WLAN interface.

BRIDGE 

Bridge interface.

◆ IpConfigMethod

IP configuration method.

Enumerator
STATIC 

No automatic configuration.

DHCP 

Use DHCP for automatic configuration (IPv4 only)

AUTO 

Use automatic configuration (IPv6 only)

◆ PortForwardingRole

Role of the node when port forwarding is enabled.

Enumerator
PRIMARY_UNIT 

Node is a port forwarding primary unit.

EXPANSION_UNIT 

Node is a port forwarding expansion unit.

◆ WlanAuthType

WLAN authentication type.

Enumerator
WLAN_AUTH_NONE 

No authentication.

WLAN_AUTH_PSK 

Pre-shared key authentication.

WLAN_AUTH_EAP 

802::1x (EAP) authentication

◆ WlanSecProtocol

WLAN security protocol.

Enumerator
WPA2 

WPA2 security protocol.

Variable Documentation

◆ CommonInfoChangedEvent

valueobject net::CommonInfoChangedEvent

Event that is send when common network info has changed.

Current common network info

◆ EthInfoChangedEvent

valueobject net::EthInfoChangedEvent

Event that is send when ethernet interface specific network info has changed.

Ethernet interface name

◆ InterfaceInfoChangedEvent

valueobject net::InterfaceInfoChangedEvent

Event that is send when common interface specific network info has changed.

Current common interface specific info

◆ LinkStateChangedEvent

valueobject net::LinkStateChangedEvent

Event that is send when the operational state of an interface changed.

interface name

◆ PortForwardingExpansionUnitPresenceStateChangedEvent

valueobject net::PortForwardingExpansionUnitPresenceStateChangedEvent

Event that is send when the presence state of a downstream port forwarding expansion unit changes.

true when an expansion unit is present

◆ WlanInfoChangedEvent

valueobject net::WlanInfoChangedEvent

Event that is send when WLAN interface specific network info has changed.

WLAN interface name