ToiNetIpDevice Interface Reference

---

Description

Technical Preview:

This interface is a TECHNICAL PREVIEW, it may change.

ToiNetIpDevice is used to get generic information about the network device and to set some generic parameters. Changes take effect after ToiNetConfigurationSession::apply().

import "ToiNetIpDevice.idl";

Inheritance diagram for ToiNetIpDevice:

List of all members.

Public Member Functions
string	getMacAddress ()
ToiNetIpDeviceInterfaceInfo	getInterfaceInfo (in TToiInterfaceId interfaceId) raises (TToiInvalidArgumentException)
ToiNetIpDeviceNetStatistics	getStatistics ()
ToiNetIpDeviceDhcpStatus	getDhcpStatus (in TToiInterfaceId interfaceId) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void	setEnabled (in TToiInterfaceId interfaceId, in boolean enable) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void	setAcquisition (in TToiInterfaceId interfaceId, in TToiAddressAcquisition acquisition) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void	setStaticAddress (in TToiInterfaceId interfaceId, in string ip, in string netmask) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
Public Attributes
const TToiInterfaceId	DEFAULT_INTERFACE = 0
TToiAddressAcquisition
const TToiAddressAcquisition	ADDRESS_ACQUISITION_STATIC = 0
const TToiAddressAcquisition	ADDRESS_ACQUISITION_DHCP = 1
const TToiAddressAcquisition	ADDRESS_ACQUISITION_DHCP_AUTO_IP = 2
Public Types
typedef long	TToiInterfaceId
typedef long	TToiAddressAcquisition

---

Member Typedef Documentation

typedef long ToiNetIpDevice::TToiAddressAcquisition

The IP address acquisition method.

typedef long ToiNetIpDevice::TToiInterfaceId

Network interface identifier type.

---

Member Function Documentation

ToiNetIpDeviceDhcpStatus ToiNetIpDevice::getDhcpStatus

(

in TToiInterfaceId

interfaceId

)

raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Returns DHCP status.

Parameters:

interfaceId

Interface identifier.

Return values:

dhcpStatus

DHCP status.

Exceptions:

TToiInvalidArgumentException	Raised if interface identifier is invalid.
TToiInvalidPreconditionException	Raised if IP acquisition method is not DHCP.

ToiNetIpDeviceInterfaceInfo ToiNetIpDevice::getInterfaceInfo

(

in TToiInterfaceId

interfaceId

)

raises (TToiInvalidArgumentException)

Returns network interface info.

Parameters:

interfaceId

Interface identifier.

Return values:

info	Interface info.

Exceptions:

TToiInvalidArgumentException

Raised if interface identifier is invalid.

string ToiNetIpDevice::getMacAddress

(

)

Returns network device mac address.

Return values:

mac	Device mac address.

ToiNetIpDeviceNetStatistics ToiNetIpDevice::getStatistics

(

)

Returns network device statistics.

Return values:

statistics

Device statistics.

void ToiNetIpDevice::setAcquisition	(	in TToiInterfaceId	interfaceId,
		in TToiAddressAcquisition	acquisition
	)		raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Sets the IP address acquisition method for network interface.

Parameters:

interfaceId	Interface identifier.
acquisition	IP address acquisition method.

Exceptions:

TToiInvalidArgumentException	Raised if interface identifier is invalid.
TToiInvalidPreconditionException	Raised if configuration is not in session mode.

void ToiNetIpDevice::setEnabled	(	in TToiInterfaceId	interfaceId,
		in boolean	enable
	)		raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Enables/disables network interface.

Parameters:

interfaceId	Interface identifier.
enable	Enable/disable flag.

Exceptions:

TToiInvalidArgumentException	Raised if interface identifier is invalid.
TToiInvalidPreconditionException	Raised if configuration is not in session mode.

void ToiNetIpDevice::setStaticAddress	(	in TToiInterfaceId	interfaceId,
		in string	ip,
		in string	netmask
	)		raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Sets static IP address and netmask for network interface.

Parameters:

interfaceId	Interface identifier.
ip	IP address.
netmask	Netmask.

Exceptions:

TToiInvalidArgumentException	Raised if interface identifier, IP address or netmask are invalid.
TToiInvalidPreconditionException	Raised if IP acquisition method is not static or if configuration is not in session mode.

---

Member Data Documentation

const TToiAddressAcquisition ToiNetIpDevice::ADDRESS_ACQUISITION_DHCP = 1

The IP address acquisition method is DHCP.

This constant can also be accessed from toi.consts.ToiNetIpDevice.ADDRESS_ACQUISITION_DHCP.

const TToiAddressAcquisition ToiNetIpDevice::ADDRESS_ACQUISITION_DHCP_AUTO_IP = 2

The IP address acquisition method is DHCP with fallback to Auto-IP when a DHCP address can't be acquired. DHCP acquisition attempts continue in the background until successful.

This constant can also be accessed from toi.consts.ToiNetIpDevice.ADDRESS_ACQUISITION_DHCP_AUTO_IP.

const TToiAddressAcquisition ToiNetIpDevice::ADDRESS_ACQUISITION_STATIC = 0

The IP address acquisition method is static.

This constant can also be accessed from toi.consts.ToiNetIpDevice.ADDRESS_ACQUISITION_STATIC.

const TToiInterfaceId ToiNetIpDevice::DEFAULT_INTERFACE = 0

Default interface identifier.

This constant can also be accessed from toi.consts.ToiNetIpDevice.DEFAULT_INTERFACE.