Add a Mininet details markdown page

Author: crotsos

MN.md

@@ -0,0 +1,122 @@
+# Mininet: `mn`
+
+`mn` - create a Mininet network. (`v2.3.0`)
+
+---
+
+## Synopsis
+
+```
+mn [options]
+``` 
+
+## Description
+
+```
+(type mn -h for details)
+
+The  mn  utility creates Mininet network from the command line. It can create parametrized
+topologies, invoke the Mininet CLI, and run tests.
+```
+
+## Options
+
+```
+-h, --help
+      show this help message and exit
+
+--switch=SWITCH
+      default|ivs|lxbr|ovs|ovsbr|ovsk|user[,param=value...]               user=UserSwitch
+      ovs=OVSSwitch   ovsbr=OVSBridge   ovsk=OVSSwitch   ivs=IVSSwitch   lxbr=LinuxBridge
+      default=OVSSwitch
+
+--host=HOST
+      cfs|proc|rt[,param=value...]     proc=Host     rt=CPULimitedHost{'sched':     'rt'}
+      cfs=CPULimitedHost{'sched': 'cfs'}
+
+--controller=CONTROLLER
+      default|none|nox|ovsc|ref|remote|ryu[,param=value...]                ref=Controller
+      ovsc=OVSController         nox=NOX         remote=RemoteController          ryu=Ryu
+      default=DefaultController none=NullController
+
+--link=LINK
+      default|ovs|tc|tcu[,param=value...] default=Link tc=TCLink tcu=TCULink ovs=OVSLink
+
+--topo=TOPO
+      linear|minimal|reversed|single|torus|tree[,param=value   ...]   minimal=MinimalTopo
+      linear=LinearTopo     reversed=SingleSwitchReversedTopo     single=SingleSwitchTopo
+      tree=TreeTopo torus=TorusTopo
+
+-c, --clean
+      clean and exit
+
+--custom=CUSTOM
+      read custom classes or params from .py file(s)
+
+--test=TEST
+      pingall|pingpair|iperf|iperfudp|all|none|build
+
+-x, --xterms
+      spawn xterms for each node
+
+-i IPBASE, --ipbase=IPBASE
+      base IP address for hosts
+
+--mac  automatically set host MACs
+
+--arp  set all-pairs ARP entries
+
+-v VERBOSITY, --verbosity=VERBOSITY
+      debug|info|output|warning|warn|error|critical
+
+--innamespace
+      sw and ctrl in namespace?
+
+--listenport=LISTENPORT
+      base port for passive switch listening
+
+--nolistenport
+      don't use passive listening port
+
+--pre=PRE
+      CLI script to run before tests
+
+--post=POST
+      CLI script to run after tests
+
+--pin  pin hosts to CPU cores (requires --host cfs or --host rt)
+
+--nat  [option=val...]  adds  a  NAT  to  the  topology that connects Mininet hosts to the
+      physical network.  Warning: This may route any traffic on  the  machine  that  uses
+      Mininet's  IP  subnet  into the Mininet network. If you need to change Mininet's IP
+      subnet, see the --ipbase option.
+
+--version
+      prints the version and exits
+
+-w, --wait
+      wait for switches to connect
+
+-t WAIT, --twait=WAIT
+      timed wait (s) for switches to connect
+
+--cluster=server1,server2...
+      run on multiple servers (experimental!)
+
+--placement=block|random
+      node placement for --cluster (experimental!)
+```
+
+## Examples
+
+Create a linear topology with 3 switches, using Linux Bridge switches, no controller, and automatic MAC addressing:
+
+```
+sudo mn --topo=linear,3 --mac --switch=lxbr --controller=none
+```
+
+Create a tree topology of depth 2 and fanout 3, using Open vSwitch switches and a remote controller at IP address 192.168.1.100:
+
+```
+sudo mn --topo=tree,2,3 --switch=ovs --controller=remote,ip=192.168.1.100
+```

Makefile

@@ -1,9 +1,13 @@
-all: output/lab-handout.html output/lab-material.zip
+all: output/lab-handout.html output/lab-material.zip output/MN.html
 
 output/lab-handout.html: .resources/metadata.md README.md .resources/pandoc.css
 	mkdir -p output
 	cat .resources/metadata.md README.md | pandoc -s -f markdown+task_lists -t html5 --css .resources/pandoc.css --lua-filter=.resources/enable-checkbox.lua --embed-resources -o output/lab-handout.html
 
+output/MN.html: .resources/metadata.md MN.md .resources/pandoc.css
+	mkdir -p output
+	cat .resources/metadata.md MN.md | pandoc -s -f markdown+task_lists -t html5 --css .resources/pandoc.css --lua-filter=.resources/enable-checkbox.lua --embed-resources -o output/MN.html	
+
 output/lab-material.zip: topology.py server.py solution/Makefile .devcontainer.json
 	mkdir -p output
 	zip -j output/lab-material.zip topology.py server.py solution/Makefile .devcontainer.json

README.md

@@ -310,7 +310,7 @@ In the previous task, we extended our Mininet topology to include a router and t
 
 NAT is a technique that allows multiple devices in a private network to share a single public IP address when accessing the Internet. It works by modifying the source IP address and port number of outgoing packets from devices in the private network to the public IP address and a unique port number assigned by the router. When the response packets return from the Internet, the router translates the destination IP address and port number back to the original private IP address and port number of the device that initiated the request.
 
-The Linux operating system provides built-in support for NAT through the use of iptables, a powerful firewall and packet filtering tool. To enable NAT on the router host in our Mininet topology, we need to configure iptables to perform source NAT (SNAT) for outgoing packets from the home network to the Internet services.
+The Linux OS provides built-in support for NAT through the use of iptables, a powerful firewall and packet filtering tool. To enable NAT on the router host in our Mininet topology, we need to configure iptables to perform source NAT (SNAT) for outgoing packets from the home network to the Internet services.
 
 You can enable NAT on the router host by running the following commands in the Mininet CLI:
 
@@ -321,4 +321,4 @@ mininet> router iptables -t nat -A POSTROUTING -o router-eth2 -j MASQUERADE
 
 These commands add rules to the NAT table in iptables that specify that outgoing packets on interfaces `router-eth1` and `router-eth2` should have their source IP address modified to the IP address of the respective interface (i.e., perform source NAT). The `MASQUERADE` target is used to automatically determine the appropriate source IP address based on the outgoing interface.
 
-> **Your task**: After enabling NAT on the router, test connectivity from the home network hosts to the Internet services by running the following commands in the Mininet CLI:
+> **Your task**: After enabling NAT on the router, test connectivity from the home network hosts to the Internet networks, answer the questions in the final part of the [Week1 Unassessed Quiz](https://modules.lancaster.ac.uk/mod/quiz/view.php?id=2824281).