.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH MN "1" "February 2024" "mn 2.3.0" "User Commands"
.SH NAME
mn \- create a Mininet network.
.SH SYNOPSIS
.B mn
[\fI\,options\/\fR]
.SH DESCRIPTION
(type mn \fB\-h\fR for details)
.PP
The mn utility creates Mininet network from the command line. It can create
parametrized topologies, invoke the Mininet CLI, and run tests.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-switch\fR=\fI\,SWITCH\/\fR
default|ivs|lxbr|ovs|ovsbr|ovsk|user[,param=value...]
user=UserSwitch ovs=OVSSwitch ovsbr=OVSBridge
ovsk=OVSSwitch ivs=IVSSwitch lxbr=LinuxBridge
default=OVSSwitch
.TP
\fB\-\-host\fR=\fI\,HOST\/\fR
cfs|proc|rt[,param=value...] proc=Host
rt=CPULimitedHost{'sched': 'rt'}
cfs=CPULimitedHost{'sched': 'cfs'}
.TP
\fB\-\-controller\fR=\fI\,CONTROLLER\/\fR
default|none|nox|ovsc|ref|remote|ryu[,param=value...]
ref=Controller ovsc=OVSController nox=NOX
remote=RemoteController ryu=Ryu
default=DefaultController none=NullController
.TP
\fB\-\-link\fR=\fI\,LINK\/\fR
default|ovs|tc|tcu[,param=value...] default=Link
tc=TCLink tcu=TCULink ovs=OVSLink
.TP
\fB\-\-topo\fR=\fI\,TOPO\/\fR
linear|minimal|reversed|single|torus|tree[,param=value
\&...] minimal=MinimalTopo linear=LinearTopo
reversed=SingleSwitchReversedTopo
single=SingleSwitchTopo tree=TreeTopo torus=TorusTopo
.TP
\fB\-c\fR, \fB\-\-clean\fR
clean and exit
.TP
\fB\-\-custom\fR=\fI\,CUSTOM\/\fR
read custom classes or params from .py file(s)
.TP
\fB\-\-test\fR=\fI\,TEST\/\fR
pingall|pingpair|iperf|iperfudp|all|none|build
.TP
\fB\-x\fR, \fB\-\-xterms\fR
spawn xterms for each node
.TP
\fB\-i\fR IPBASE, \fB\-\-ipbase\fR=\fI\,IPBASE\/\fR
base IP address for hosts
.TP
\fB\-\-mac\fR
automatically set host MACs
.TP
\fB\-\-arp\fR
set all\-pairs ARP entries
.TP
\fB\-v\fR VERBOSITY, \fB\-\-verbosity\fR=\fI\,VERBOSITY\/\fR
debug|info|output|warning|warn|error|critical
.TP
\fB\-\-innamespace\fR
sw and ctrl in namespace?
.TP
\fB\-\-listenport\fR=\fI\,LISTENPORT\/\fR
base port for passive switch listening
.TP
\fB\-\-nolistenport\fR
don't use passive listening port
.TP
\fB\-\-pre\fR=\fI\,PRE\/\fR
CLI script to run before tests
.TP
\fB\-\-post\fR=\fI\,POST\/\fR
CLI script to run after tests
.TP
\fB\-\-pin\fR
pin hosts to CPU cores (requires \fB\-\-host\fR cfs or \fB\-\-host\fR
rt)
.TP
\fB\-\-nat\fR
[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 \fB\-\-ipbase\fR option.
.TP
\fB\-\-version\fR
prints the version and exits
.TP
\fB\-w\fR, \fB\-\-wait\fR
wait for switches to connect
.TP
\fB\-t\fR WAIT, \fB\-\-twait\fR=\fI\,WAIT\/\fR
timed wait (s) for switches to connect
.TP
\fB\-\-cluster\fR=\fI\,server1\/\fR,server2...
run on multiple servers (experimental!)
.TP
\fB\-\-placement\fR=\fI\,block\/\fR|random
node placement for \fB\-\-cluster\fR (experimental!)