VIRTUTECH CONFIDENTIAL    Previous - Up - Next

rn-eth-proxy-tap

Provided by
real-network
Class Hierarchy
conf-object → log-object → rn-eth-proxy-tap
Interfaces Implemented
log_object, ethernet_device
Description
Ethernet proxy using a TAP interface.

Attributes

Attributes inherited from class conf-object
attributes, classname, component, iface, name, object_id, queue
Attributes inherited from class log-object
access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask
Attribute List
close_iface
Pseudo class attribute; write-only access; type: String.

A persistent TUN/TAP interface from a previous session can be closed by giving its name to this attribute. This attribute is not applicable on Windows platforms.

connected
Optional attribute; read/write access; type: Integer.

Set to 1 if the object is connected to the real network and configured properly. Also used to initiate a new connection. If the object successfully opened the TUN/TAP device but failed to read the IP address and netmask (or MAC address), this attribute has to be set to 1 again after the TUN/TAP device has been configured.

external_arp_table
Pseudo attribute; read/write access; type: [[ss]*].

ARP table for real network, used to proxy Ethernet frames.

filter_arp
Optional attribute; read/write access; type: Integer.

When this attribute is set to 1 (default), some ARP related optimizations are enabled. For example ARP requests are not forwarded between the real and simulated network if the host is known to reside on the same network as the requester.

gateway_ip
Pseudo attribute; read/write access; type: String.

The IP address of the gateway in the real network.

host_ip
Pseudo attribute; read-only access; type: String.

The IP address of the network device connected to the real network.

host_mac
Pseudo attribute; read-only access; type: String.

The MAC address of the network device connected to the real network.

host_netmask
Pseudo attribute; read-only access; type: String.

Network address mask of the host ethernet network.

host_network
Pseudo attribute; read-only access; type: String.

Network address of the host ethernet network.

interface
Optional attribute; read/write access; type: String.

The name that the router should use for the TUN/TAP interface on the host. Useful if the interface already exists, i.e. for persistent interfaces. if not set, a name for the interface will be selected automatically.

internal_arp_table
Optional attribute; read/write access; type: [[ss]*].

ARP table for simulated network, used to proxy Ethernet frames.

link
Optional attribute; read/write access; type: Object or Nil.

Simulated Ethernet link to connect to.

link_status_devices
Optional attribute; read/write access; type: [o*].

List of devices that should be notified of link status changes (on the host interface). The devices must implement the link-status interface.

link_status_enabled
Optional attribute; read/write access; type: b.

Enables host link status propagation. Note that disabling is not supported.

link_status_inject
Pseudo attribute; write-only access; type: Integer.

Generates a link-status change event. Used for testing of host link status propagation. The value written should be a ieee_802_3_link_status_t value.

mac
Optional attribute; read/write access; type: String.

The MAC address of the Ethernet adapter connected to the simulated network.

persistent
Optional attribute; read/write access; type: Integer.

Set to 1 if the TUN/TAP interface opened should be persistent, i.e. if it shouldn't be removed when Simics exists. A persistent interface is useful to avoid reconfiguration of it everytime a new simulation session is started. Setting this attribute has no effect on Windows; all TAP-Win32 devices are persistent.

tap_bridge
Optional attribute; read/write access; type: Integer.

Should be set to 1 if the TAP interface is used to setup an Ethernet bridge.

tun_tap_device
Pseudo class attribute; read/write access; type: String.

The name of the host TUN/TAP device to use to connect to the real network. A TUN/TAP device supports IP packet tunneling and Ethernet frame bridging between the host that Simics is running on and the simulated network. Default is /dev/net/tun. This attribute is not applicable on Windows platforms.

tx_bandwidth
Optional attribute; read/write access; type: Integer.

The transmit bandwidth of the network interface in bits per second. The network interface will limit the rate at which it sends packets to remain below this bandwidth. Set to 0 for unlimited bandwidth. Default limit is 10Mbit/s.

tx_packet_rate
Optional attribute; read/write access; type: Integer.

The maximum transmit rate of the network interface in packets per second. The network interface will limit the rate at which it sends packets to remain below this rate. Set to 0 for unlimited rate, which is the default.

Command List

Commands defined by interface log_object
log, log-group, log-level, log-size, log-type
Commands
finish-connectionFinalize a real network connection
infoprint information about the device
statusprint status of the device

Command Descriptions

<rn-eth-proxy-tap>.finish-connection
Synopsis
<rn-eth-proxy-tap>.finish-connection
Description
Finish the connection to the real network once the TUN/TAP interface has been assigned an IP address and network mask ethat the real-network object has to read. This command usually isn't needed since Simics will retry getting the interface configuration when it receives a packet from or to the real network.
<rn-eth-proxy-tap>.info
Synopsis
<rn-eth-proxy-tap>.info
Description
Print detailed information about the configuration of the device.
<rn-eth-proxy-tap>.status
Synopsis
<rn-eth-proxy-tap>.status
Description
Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL    Previous - Up - Next