Raritan PX2/PX3 JSON-RPC API
Public Member Functions | Public Attributes | List of all members
net::Net_3_0_0 Interface Reference

Network configuration interface. More...

import"Net.idl";

Public Member Functions

int setNetworkConfigIP (in NetworkConfigIP cfg)
 Set common IP parameters. More...
 
void getNetworkConfigIP (out NetworkConfigIP cfg)
 Retrieve the common IP parameters. More...
 
int setNetworkConfigIPv4 (in NetworkConfigIPv4 cfg4)
 Set the IPv4 configuration. More...
 
void getNetworkConfigIPv4 (out NetworkConfigIPv4 cfg4, out NetworkConfigIPv4 cfg4current)
 Retrieve the IPv4 configuration. More...
 
void getNetworkConfigRoutesIPv4 (out vector< IPv4RoutingEntry > static_routes, out vector< IPv4RoutingEntry > active_routes)
 
int setNetworkConfigRoutesIPv4 (in vector< IPv4RoutingEntry > static_routes)
 
void getNetworkConfigRoutesIPv6 (out vector< IPv6RoutingEntry > static_routes, out vector< IPv6RoutingEntry > active_routes)
 
int setNetworkConfigRoutesIPv6 (in vector< IPv6RoutingEntry > static_routes)
 
int setNetworkConfigIPv6 (in NetworkConfigIPv6 cfg6)
 Set the IPv6 configuration. More...
 
void getNetworkConfigIPv6 (out NetworkConfigIPv6 cfg6, out NetworkActiveValuesIPv6 ipv6current)
 Retrieve the IPv6 configuration. More...
 
int setNetworkConfigServices (in vector< ServiceConfig > services)
 Change the network service configuration. More...
 
void getNetworkConfigServices (out vector< ServiceConfig > services)
 Retrieve the network service configuration. More...
 
void getNetworkConfigInterface (out InterfaceState_2_0_0 state, out LanInterfaceSettings lan, out LanInterfaceParameters_2_0_0 lancurrent, out WirelessInterfaceSettings_2_0_0 wlan)
 Retrieve the current LAN interface configuration. More...
 
void getMACs (out InterfaceState_2_0_0 state, out string ethmac, out string wlanmac)
 Get MAC-Addresses of lan interfaces. More...
 
int setNetworkConfigLan (in LanInterfaceSettings lancfg)
 Set the LAN interface configuration, enable wired networking. More...
 
int setNetworkConfigWLan (in WirelessInterfaceSettings_2_0_0 wlancfg)
 Set the wireless configuration, enable wireless networking. More...
 
int getBridgeSlaveCount ()
 Get the number of slave units that are directly sharing this unit's network connection. More...
 

Public Attributes

constant int ERR_INVALID_PARAMS = 1
 Invalid parameters.
 

Detailed Description

Network configuration interface.

Member Function Documentation

int net::Net_3_0_0::getBridgeSlaveCount ( )

Get the number of slave units that are directly sharing this unit's network connection.

Returns
Number of slaves directly connected to this unit.
void net::Net_3_0_0::getMACs ( out InterfaceState_2_0_0  state,
out string  ethmac,
out string  wlanmac 
)

Get MAC-Addresses of lan interfaces.

If wlan is not enabled or present, wlanmac may be set to empty string

void net::Net_3_0_0::getNetworkConfigInterface ( out InterfaceState_2_0_0  state,
out LanInterfaceSettings  lan,
out LanInterfaceParameters_2_0_0  lancurrent,
out WirelessInterfaceSettings_2_0_0  wlan 
)

Retrieve the current LAN interface configuration.

Parameters
stateResult: Wired or wireless interface?
lanResult: Wired interface settings
lancurrentResult: Current wired interface parameters
wlanResult: Wireless interface settings
void net::Net_3_0_0::getNetworkConfigIP ( out NetworkConfigIP  cfg)

Retrieve the common IP parameters.

Parameters
cfgResult: Configured IP settings
void net::Net_3_0_0::getNetworkConfigIPv4 ( out NetworkConfigIPv4  cfg4,
out NetworkConfigIPv4  cfg4current 
)

Retrieve the IPv4 configuration.

Parameters
cfg4Result: Configured IPv4 settings
cfg4currentResult: Active values (e.g. in case of DHCP)
void net::Net_3_0_0::getNetworkConfigIPv6 ( out NetworkConfigIPv6  cfg6,
out NetworkActiveValuesIPv6  ipv6current 
)

Retrieve the IPv6 configuration.

Parameters
cfg6Result: Configured IPv6 settings
ipv6currentResult: Active values (e.g. in case of DHCP, stateless config)
void net::Net_3_0_0::getNetworkConfigServices ( out vector< ServiceConfig services)

Retrieve the network service configuration.

Parameters
servicesList of all supported network services
int net::Net_3_0_0::setNetworkConfigIP ( in NetworkConfigIP  cfg)

Set common IP parameters.

Parameters
cfgNew IP settings
Returns
0 if OK
1 if any parameters were invalid
int net::Net_3_0_0::setNetworkConfigIPv4 ( in NetworkConfigIPv4  cfg4)

Set the IPv4 configuration.

Parameters
cfg4New IPv4 settings
Returns
0 if OK
1 if any parameters were invalid
int net::Net_3_0_0::setNetworkConfigIPv6 ( in NetworkConfigIPv6  cfg6)

Set the IPv6 configuration.

Parameters
cfg6New IPv6 settings
Returns
0 if OK
1 if any parameters were invalid
int net::Net_3_0_0::setNetworkConfigLan ( in LanInterfaceSettings  lancfg)

Set the LAN interface configuration, enable wired networking.

Parameters
lancfgNew LAN interface settings
Returns
0 if OK
1 if any parameters were invalid
int net::Net_3_0_0::setNetworkConfigServices ( in vector< ServiceConfig services)

Change the network service configuration.

This call changes the configuration of one or more network services identified by name. Other services are not affected. The resulting configuration of all enabled services must be consistent, i.e. there must be not port collisions.

Parameters
servicesList of network services to be changed
Returns
0 if OK
1 if any parameters were invalid
int net::Net_3_0_0::setNetworkConfigWLan ( in WirelessInterfaceSettings_2_0_0  wlancfg)

Set the wireless configuration, enable wireless networking.

Parameters
wlancfgNew wireless interface settings
Returns
0 if OK
1 if any parameters were invalid

The documentation for this interface was generated from the following file: