VlanExample

Package: inet.examples.ethernet.vlan

VlanExample

network

(no description)

Ipv4NetworkConfigurator StandardHost EthernetSwitch EthernetSwitch StandardHost

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Properties

Name Value Description
isNetwork

Unassigned submodule parameters

Name Type Default value Description
configurator.minLinkWeight double 1E-3
configurator.configureIsolatedNetworksSeparatly bool false
configurator.config xml xml("")

XML configuration parameters for IP address assignment and adding manual routes
configurator.assignAddresses bool true

assign IP addresses to all interfaces in the network
configurator.assignUniqueAddresses bool true

avoid using the same address and raise an error if not possible
configurator.assignDisjunctSubnetAddresses bool true

avoid using the same address prefix and netmask on different links when assigning IP addresses to interfaces
configurator.addStaticRoutes bool true

add static routes to the routing tables of all nodes to route to all destination interfaces (only where applicable; turn off when config file contains manual routes)
configurator.addDefaultRoutes bool true

add default routes if all routes from a source node go through the same gateway (used only if addStaticRoutes is true)
configurator.addSubnetRoutes bool true

add subnet routes instead of destination interface routes (only where applicable; used only if addStaticRoutes is true)
configurator.addDirectRoutes bool true

add direct routes (i.e. directly connected interfaces) to the routing table (used only if addStaticRoutes is true)
configurator.optimizeRoutes bool true

optimize routing tables by merging routes, the resulting routing table might route more packets than the original (used only if addStaticRoutes is true)
configurator.dumpTopology bool false

print extracted network topology to the module output
configurator.dumpLinks bool false

print recognized network links to the module output
configurator.dumpAddresses bool false

print assigned IP addresses for all interfaces to the module output
configurator.dumpRoutes bool false

print configured and optimized routing tables for all nodes to the module output
configurator.dumpConfig string ""

write configuration into the given config file that can be fed back to speed up subsequent runs (network configurations)
host1.status.initialStatus string "UP"

TODO @signal, @statistic
host1.pcapRecorder.verbose bool true

whether to log packets on the module output
host1.pcapRecorder.pcapFile string ""

the PCAP file to be written
host1.pcapRecorder.fileFormat string "pcapng"
host1.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
host1.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
host1.pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

space-separated list of sibling module names to listen on
host1.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
host1.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
host1.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
host1.pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
host1.pcapRecorder.helpers string ""

usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
host1.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
host1.pcapRecorder.displayStringTextFormat string "rec: %n pks"
host1.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
host1.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host1.cb.forwardServiceRegistration bool true
host1.cb.forwardProtocolRegistration bool true
host1.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host1.bl.forwardServiceRegistration bool true
host1.bl.forwardProtocolRegistration bool true
host1.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host1.li.forwardServiceRegistration bool true
host1.li.forwardProtocolRegistration bool true
host1.eth.bitrate double
host1.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host1.nl.forwardServiceRegistration bool true
host1.nl.forwardProtocolRegistration bool true
host1.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host1.tn.forwardServiceRegistration bool true
host1.tn.forwardProtocolRegistration bool true
host1.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host1.at.forwardServiceRegistration bool true
host1.at.forwardProtocolRegistration bool true
switch1.macTable.agingTime double
switch1.macTable.forwardingTableFile string
switch1.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
switch1.l2NodeConfigurator.interfaceTableModule string
switch1.l2NodeConfigurator.l2ConfiguratorModule string "l2NetworkConfigurator"

the absolute path to the ~L2NetworkConfigurator; use "" if there is no configurator
switch1.status.initialStatus string "UP"

TODO @signal, @statistic
switch1.pcapRecorder.verbose bool true

whether to log packets on the module output
switch1.pcapRecorder.pcapFile string ""

the PCAP file to be written
switch1.pcapRecorder.fileFormat string "pcapng"
switch1.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
switch1.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
switch1.pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

space-separated list of sibling module names to listen on
switch1.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
switch1.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
switch1.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
switch1.pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
switch1.pcapRecorder.helpers string ""

usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
switch1.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
switch1.pcapRecorder.displayStringTextFormat string "rec: %n pks"
switch1.stp.helloTime double
switch1.stp.forwardDelay double
switch1.stp.maxAge double
switch1.stp.bridgePriority int
switch1.stp.visualize bool
switch1.sc.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.sc.forwardServiceRegistration bool true
switch1.sc.forwardProtocolRegistration bool true
switch1.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.cb.forwardServiceRegistration bool true
switch1.cb.forwardProtocolRegistration bool true
switch1.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.bl.forwardServiceRegistration bool true
switch1.bl.forwardProtocolRegistration bool true
switch1.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.li.forwardServiceRegistration bool true
switch1.li.forwardProtocolRegistration bool true
switch1.cutthrough.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.cutthrough.forwardServiceRegistration bool true
switch1.cutthrough.forwardProtocolRegistration bool true
switch1.eth.bitrate double
switch2.macTable.agingTime double
switch2.macTable.forwardingTableFile string
switch2.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
switch2.l2NodeConfigurator.interfaceTableModule string
switch2.l2NodeConfigurator.l2ConfiguratorModule string "l2NetworkConfigurator"

the absolute path to the ~L2NetworkConfigurator; use "" if there is no configurator
switch2.status.initialStatus string "UP"

TODO @signal, @statistic
switch2.pcapRecorder.verbose bool true

whether to log packets on the module output
switch2.pcapRecorder.pcapFile string ""

the PCAP file to be written
switch2.pcapRecorder.fileFormat string "pcapng"
switch2.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
switch2.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
switch2.pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

space-separated list of sibling module names to listen on
switch2.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
switch2.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
switch2.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
switch2.pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
switch2.pcapRecorder.helpers string ""

usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
switch2.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
switch2.pcapRecorder.displayStringTextFormat string "rec: %n pks"
switch2.stp.helloTime double
switch2.stp.forwardDelay double
switch2.stp.maxAge double
switch2.stp.bridgePriority int
switch2.stp.visualize bool
switch2.sc.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.sc.forwardServiceRegistration bool true
switch2.sc.forwardProtocolRegistration bool true
switch2.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.cb.forwardServiceRegistration bool true
switch2.cb.forwardProtocolRegistration bool true
switch2.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.bl.forwardServiceRegistration bool true
switch2.bl.forwardProtocolRegistration bool true
switch2.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.li.forwardServiceRegistration bool true
switch2.li.forwardProtocolRegistration bool true
switch2.cutthrough.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.cutthrough.forwardServiceRegistration bool true
switch2.cutthrough.forwardProtocolRegistration bool true
switch2.eth.bitrate double
host2.status.initialStatus string "UP"

TODO @signal, @statistic
host2.pcapRecorder.verbose bool true

whether to log packets on the module output
host2.pcapRecorder.pcapFile string ""

the PCAP file to be written
host2.pcapRecorder.fileFormat string "pcapng"
host2.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
host2.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
host2.pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

space-separated list of sibling module names to listen on
host2.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
host2.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
host2.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
host2.pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
host2.pcapRecorder.helpers string ""

usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
host2.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
host2.pcapRecorder.displayStringTextFormat string "rec: %n pks"
host2.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
host2.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host2.cb.forwardServiceRegistration bool true
host2.cb.forwardProtocolRegistration bool true
host2.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host2.bl.forwardServiceRegistration bool true
host2.bl.forwardProtocolRegistration bool true
host2.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host2.li.forwardServiceRegistration bool true
host2.li.forwardProtocolRegistration bool true
host2.eth.bitrate double
host2.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host2.nl.forwardServiceRegistration bool true
host2.nl.forwardProtocolRegistration bool true
host2.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host2.tn.forwardServiceRegistration bool true
host2.tn.forwardProtocolRegistration bool true
host2.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
host2.at.forwardServiceRegistration bool true
host2.at.forwardProtocolRegistration bool true

Source code

network VlanExample
{
    submodules:
        configurator: Ipv4NetworkConfigurator {
            @display("p=100,100;is=s");
        }
        host1: StandardHost {
            @display("p=250,100");
        }
        switch1: EthernetSwitch {
            @display("p=350,100");
        }
        switch2: EthernetSwitch {
            @display("p=450,100");
        }
        host2: StandardHost {
            @display("p=550,100");
        }
    connections:
        host1.ethg++ <--> Eth100M <--> switch1.ethg++;
        host2.ethg++ <--> Eth100M <--> switch2.ethg++;
        switch1.ethg++ <--> Eth100M <--> switch2.ethg++;
}
File: examples/ethernet/vlan/VlanExample.ned

This documentation is released under the Creative Commons license