1MN(1)                            User Commands                           MN(1)
2
3
4

NAME

6       mn - create a Mininet network.
7

SYNOPSIS

9       mn [options]
10

DESCRIPTION

12       (type mn -h for details)
13
14       The  mn  utility  creates Mininet network from the command line. It can
15       create parametrized topologies, invoke the Mininet CLI, and run tests.
16

OPTIONS

18       -h, --help
19              show this help message and exit
20
21       --switch=SWITCH
22              default|ivs|lxbr|ovs|ovsbr|ovsk|user[,param=value...]
23              user=UserSwitch   ovs=OVSSwitch  ovsbr=OVSBridge  ovsk=OVSSwitch
24              ivs=IVSSwitch lxbr=LinuxBridge default=OVSSwitch
25
26       --host=HOST
27              cfs|proc|rt[,param=value...]      proc=Host       rt=CPULimited‐
28              Host{'sched': 'rt'} cfs=CPULimitedHost{'sched': 'cfs'}
29
30       --controller=CONTROLLER
31              default|none|nox|ovsc|ref|remote|ryu[,param=value...]   ref=Con‐
32              troller   ovsc=OVSController   nox=NOX   remote=RemoteController
33              ryu=Ryu default=DefaultController none=NullController
34
35       --link=LINK
36              default|ovs|tc|tcu[,param=value...]    default=Link    tc=TCLink
37              tcu=TCULink ovs=OVSLink
38
39       --topo=TOPO
40              linear|minimal|reversed|single|torus|tree[,param=value ...] min‐
41              imal=MinimalTopo    linear=LinearTopo   reversed=SingleSwitchRe‐
42              versedTopo single=SingleSwitchTopo tree=TreeTopo torus=TorusTopo
43
44       -c, --clean
45              clean and exit
46
47       --custom=CUSTOM
48              read custom classes or params from .py file(s)
49
50       --test=TEST
51              pingall|pingpair|iperf|iperfudp|all|none|build
52
53       -x, --xterms
54              spawn xterms for each node
55
56       -i IPBASE, --ipbase=IPBASE
57              base IP address for hosts
58
59       --mac  automatically set host MACs
60
61       --arp  set all-pairs ARP entries
62
63       -v VERBOSITY, --verbosity=VERBOSITY
64              debug|info|output|warning|warn|error|critical
65
66       --innamespace
67              sw and ctrl in namespace?
68
69       --listenport=LISTENPORT
70              base port for passive switch listening
71
72       --nolistenport
73              don't use passive listening port
74
75       --pre=PRE
76              CLI script to run before tests
77
78       --post=POST
79              CLI script to run after tests
80
81       --pin  pin hosts to CPU cores (requires --host cfs or --host rt)
82
83       --nat  [option=val...] adds a NAT to the topology that connects Mininet
84              hosts  to  the  physical  network.   Warning: This may route any
85              traffic on the machine that uses Mininet's IP  subnet  into  the
86              Mininet  network. If you need to change Mininet's IP subnet, see
87              the --ipbase option.
88
89       --version
90              prints the version and exits
91
92       -w, --wait
93              wait for switches to connect
94
95       -t WAIT, --twait=WAIT
96              timed wait (s) for switches to connect
97
98       --cluster=server1,server2...
99              run on multiple servers (experimental!)
100
101       --placement=block|random
102              node placement for --cluster (experimental!)
103
104
105
106mn 2.3.1b4                         July 2023                             MN(1)