BgpNetwork

Package: inet.examples.bgpv4.BgpAndOspfSimple

BgpNetwork

network

(no description)

IntegratedCanvasVisualizer Ipv4NetworkConfigurator BgpRouter BgpRouter OspfRouter OspfRouter StandardHost 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.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.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)
A.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
A.at.forwardServiceRegistration bool true
A.at.forwardProtocolRegistration bool true
A.bgp.interfaceTableModule string

The path to the InterfaceTable module
A.bgp.routingTableModule string
A.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
B.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
B.at.forwardServiceRegistration bool true
B.at.forwardProtocolRegistration bool true
B.bgp.interfaceTableModule string

The path to the InterfaceTable module
B.bgp.routingTableModule string
B.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
RA1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
RA1.at.forwardServiceRegistration bool true
RA1.at.forwardProtocolRegistration bool true
RA1.bgp.interfaceTableModule string

The path to the InterfaceTable module
RA1.bgp.routingTableModule string
RA1.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
RB1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
RB1.at.forwardServiceRegistration bool true
RB1.at.forwardProtocolRegistration bool true
RB1.bgp.interfaceTableModule string

The path to the InterfaceTable module
RB1.bgp.routingTableModule string
RB1.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
HA11.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
HA11.at.forwardServiceRegistration bool true
HA11.at.forwardProtocolRegistration bool true
HB11.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source code

network BgpNetwork
{
    types:
        channel LINK_100 extends ThruputMeteringChannel
        {
            parameters:
                delay = 50us;
                datarate = 100Mbps;
                displayAsTooltip = true;
                thruputDisplayFormat = "#N";
        }
    submodules:
        visualizer: IntegratedCanvasVisualizer {
            parameters:
                @display("p=100,100;is=s");
        }
        configurator: Ipv4NetworkConfigurator {
            parameters:
                @display("p=100,200;is=s");
                config = xmldoc("IPv4Config.xml");
                addStaticRoutes = false;
                addDefaultRoutes = false;
                addSubnetRoutes = false;
        }
        A: BgpRouter {
            parameters:
                @display("p=550,100");
            gates:
                pppg[2];
        }
        B: BgpRouter {
            parameters:
                @display("p=700,100");
            gates:
                pppg[2];
        }
        RA1: OspfRouter {
            parameters:
                @display("p=400,100;i=device/router");
            gates:
                pppg[1];
                ethg[1];
        }
        RB1: OspfRouter {
            parameters:
                @display("p=850,100;i=device/router");
            gates:
                pppg[1];
                ethg[1];
        }
        HA11: StandardHost {
            parameters:
                @display("p=250,100;i=device/pc");
            gates:
                ethg[1];
        }
        HB11: StandardHost {
            parameters:
                @display("p=1000,100;i=device/pc");
            gates:
                ethg[1];
        }
    connections:
        //LAN A1 et A2
        HA11.ethg[0] <--> LINK_100 <--> RA1.ethg[0];

        //OSPF A
        RA1.pppg[0] <--> LINK_100 <--> A.pppg[1];

        //BGP
        A.pppg[0] <--> LINK_100 <--> B.pppg[0];

        //LAN B1 et B2
        HB11.ethg[0] <--> LINK_100 <--> RB1.ethg[0];

        //OSPF B
        RB1.pppg[0] <--> LINK_100 <--> B.pppg[1];
}
File: examples/bgpv4/BgpAndOspfSimple/Network.ned

This documentation is released under the Creative Commons license