Network OSPF_mininet

Package: inet.examples.ospfv2.areatests
File: examples/ospfv2/areatests/mininet.ned

(no description)

OSPFRouter OSPFRouter OSPFRouter StandardHost OSPFRouter OSPFRouter StandardHost IPv4NetworkConfigurator ScenarioManager

Usage diagram:

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

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Parameters:

Name Type Default value Description
numBBr int 2
numSBr int 2
numHst int 2

Properties:

Name Value Description
isNetwork

Unassigned submodule parameters:

Name Type Default value Description
BBR.status.initialStatus string "UP"

TODO @signal, @statistic
BBR.routingTable.forwarding bool
BBR.routingTable.multicastForwarding bool
BBR.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
BBR.pcapRecorder.verbose bool false

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

the PCAP file to be written
BBR.pcapRecorder.snaplen int 65535

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

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

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

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

space-separated list of inbound packet signals to subscribe to
BBR.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
BBR.lo0.lo.interfaceTableModule string

The path to the InterfaceTable module
BBR.lo0.lo.mtu int 4470B
BBR.bgp.interfaceTableModule string

The path to the InterfaceTable module
BBR.bgp.routingTableModule string
BBR.bgp.ospfRoutingModule string hasOSPF ? "^.ospf" : ""
BBR.bgp.dataTransferMode string
BBRtoS1.status.initialStatus string "UP"

TODO @signal, @statistic
BBRtoS1.routingTable.forwarding bool
BBRtoS1.routingTable.multicastForwarding bool
BBRtoS1.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
BBRtoS1.pcapRecorder.verbose bool false

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

the PCAP file to be written
BBRtoS1.pcapRecorder.snaplen int 65535

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

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

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

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

space-separated list of inbound packet signals to subscribe to
BBRtoS1.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
BBRtoS1.lo0.lo.interfaceTableModule string

The path to the InterfaceTable module
BBRtoS1.lo0.lo.mtu int 4470B
BBRtoS1.bgp.interfaceTableModule string

The path to the InterfaceTable module
BBRtoS1.bgp.routingTableModule string
BBRtoS1.bgp.ospfRoutingModule string hasOSPF ? "^.ospf" : ""
BBRtoS1.bgp.dataTransferMode string
S1R.status.initialStatus string "UP"

TODO @signal, @statistic
S1R.routingTable.forwarding bool
S1R.routingTable.multicastForwarding bool
S1R.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
S1R.pcapRecorder.verbose bool false

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

the PCAP file to be written
S1R.pcapRecorder.snaplen int 65535

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

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

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

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

space-separated list of inbound packet signals to subscribe to
S1R.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
S1R.lo0.lo.interfaceTableModule string

The path to the InterfaceTable module
S1R.lo0.lo.mtu int 4470B
S1R.bgp.interfaceTableModule string

The path to the InterfaceTable module
S1R.bgp.routingTableModule string
S1R.bgp.ospfRoutingModule string hasOSPF ? "^.ospf" : ""
S1R.bgp.dataTransferMode string
S1H.status.initialStatus string "UP"

TODO @signal, @statistic
S1H.routingTable.forwarding bool
S1H.routingTable.multicastForwarding bool
S1H.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
S1H.pcapRecorder.verbose bool false

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

the PCAP file to be written
S1H.pcapRecorder.snaplen int 65535

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

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

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

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

space-separated list of inbound packet signals to subscribe to
S1H.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
S1H.lo0.lo.interfaceTableModule string

The path to the InterfaceTable module
S1H.lo0.lo.mtu int 4470B
BBRtoS2.status.initialStatus string "UP"

TODO @signal, @statistic
BBRtoS2.routingTable.forwarding bool
BBRtoS2.routingTable.multicastForwarding bool
BBRtoS2.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
BBRtoS2.pcapRecorder.verbose bool false

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

the PCAP file to be written
BBRtoS2.pcapRecorder.snaplen int 65535

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

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

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

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

space-separated list of inbound packet signals to subscribe to
BBRtoS2.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
BBRtoS2.lo0.lo.interfaceTableModule string

The path to the InterfaceTable module
BBRtoS2.lo0.lo.mtu int 4470B
BBRtoS2.bgp.interfaceTableModule string

The path to the InterfaceTable module
BBRtoS2.bgp.routingTableModule string
BBRtoS2.bgp.ospfRoutingModule string hasOSPF ? "^.ospf" : ""
BBRtoS2.bgp.dataTransferMode string
S2R.status.initialStatus string "UP"

TODO @signal, @statistic
S2R.routingTable.forwarding bool
S2R.routingTable.multicastForwarding bool
S2R.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
S2R.pcapRecorder.verbose bool false

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

the PCAP file to be written
S2R.pcapRecorder.snaplen int 65535

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

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

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

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

space-separated list of inbound packet signals to subscribe to
S2R.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
S2R.lo0.lo.interfaceTableModule string

The path to the InterfaceTable module
S2R.lo0.lo.mtu int 4470B
S2R.bgp.interfaceTableModule string

The path to the InterfaceTable module
S2R.bgp.routingTableModule string
S2R.bgp.ospfRoutingModule string hasOSPF ? "^.ospf" : ""
S2R.bgp.dataTransferMode string
S2H.status.initialStatus string "UP"

TODO @signal, @statistic
S2H.routingTable.forwarding bool
S2H.routingTable.multicastForwarding bool
S2H.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
S2H.pcapRecorder.verbose bool false

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

the PCAP file to be written
S2H.pcapRecorder.snaplen int 65535

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

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

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

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

space-separated list of inbound packet signals to subscribe to
S2H.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
S2H.lo0.lo.interfaceTableModule string

The path to the InterfaceTable module
S2H.lo0.lo.mtu int 4470B
configurator.minLinkWeight double 1E-3
configurator.assignAddresses bool true

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

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

add subnet routes instead of destination interface routes (only where applicable; 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)
scenarioManager.script xml xml("")

Source code:

network OSPF_mininet
{
    parameters:
        int numBBr = 2;
        int numSBr = 2;
        int numHst = 2;
    types:
        channel C extends ThruputMeteringChannel
        {
            delay = 0.1us;
            datarate = 100Mbps;
            thruputDisplayFormat = "#N";
        }
    submodules:
        BBR[numBBr]: OSPFRouter;
        BBRtoS1: OSPFRouter;
        S1R[numSBr]: OSPFRouter;
        S1H[numHst]: StandardHost;
        BBRtoS2: OSPFRouter;
        S2R[numSBr]: OSPFRouter;
        S2H[numHst]: StandardHost;
        configurator: IPv4NetworkConfigurator {
            parameters:
                config = xml("<config>"+
                            "<interface hosts='BBR[*]' address='192.168.100.x' netmask='255.255.255.x' />"+
                            "<interface hosts='BBRtoS*' towards='BBR[*]' address='192.168.100.x' netmask='255.255.255.x' />"+

                            "<interface hosts='BBRtoS1' towards='S1R[*]' address='192.168.201.x' netmask='255.255.255.x' />"+
                            "<interface hosts='S1H[*] S1R[*]' address='192.168.201.x' netmask='255.255.255.x' />"+

                            "<interface hosts='BBRtoS2' towards='S2R[*]' address='192.168.202.x' netmask='255.255.255.x' />"+
                            "<interface hosts='S2H[*] S2R[*]' address='192.168.202.x' netmask='255.255.255.x' />"+

                            "<route hosts='S*H[*]' destination='*' netmask='0.0.0.0' interface='eth0' />"+
                            "</config>");
                addStaticRoutes = false;
                addDefaultRoutes = false;
                @display("p=75,43");
        }
        scenarioManager: ScenarioManager {
            @display("p=187,43");
        }
    connections:
        BBRtoS1.ethg++ <--> C <--> BBR[0].ethg++;
        BBRtoS1.ethg++ <--> C <--> S1R[0].ethg++;
        BBRtoS2.ethg++ <--> C <--> S2R[0].ethg++;
        BBRtoS2.ethg++ <--> C <--> BBR[numBBr-1].ethg++;
        for i=1..numBBr-1 {
            BBR[i-1].ethg++ <--> C <--> BBR[i].ethg++;
        }
        for i=1..numSBr-1 {
            S1R[i-1].ethg++ <--> C <--> S1R[i].ethg++;
            S2R[i-1].ethg++ <--> C <--> S2R[i].ethg++;
        }
        for i=0..numHst-1 {
            S1R[numSBr-1].ethg++ <--> C <--> S1H[i].ethg++;
            S2R[numSBr-1].ethg++ <--> C <--> S2H[i].ethg++;
        }
}

This documentation is released under the Creative Commons license