Update and rename MantenerFIFO to MantenerFIFO.md
[vsorcdistro/.git] / mininet / mn.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
2 .TH MN "1" "May 2019" "mn 2.3.0d5" "User Commands"
3 .SH NAME
4 mn \- create a Mininet network.
5 .SH SYNOPSIS
6 .B mn
7 [\fI\,options\/\fR]
8 .SH DESCRIPTION
9 (type mn \fB\-h\fR for details)
10 .PP
11 The mn utility creates Mininet network from the command line. It can create
12 parametrized topologies, invoke the Mininet CLI, and run tests.
13 .SH OPTIONS
14 .TP
15 \fB\-h\fR, \fB\-\-help\fR
16 show this help message and exit
17 .TP
18 \fB\-\-switch\fR=\fI\,SWITCH\/\fR
19 default|ivs|lxbr|ovs|ovsbr|ovsk|user[,param=value...]
20 ovs=OVSSwitch default=OVSSwitch ovsk=OVSSwitch
21 lxbr=LinuxBridge user=UserSwitch ivs=IVSSwitch
22 ovsbr=OVSBridge
23 .TP
24 \fB\-\-host\fR=\fI\,HOST\/\fR
25 cfs|proc|rt[,param=value...]
26 rt=CPULimitedHost{'sched': 'rt'} proc=Host
27 cfs=CPULimitedHost{'sched': 'cfs'}
28 .TP
29 \fB\-\-controller\fR=\fI\,CONTROLLER\/\fR
30 default|none|nox|ovsc|ref|remote|ryu[,param=value...]
31 ovsc=OVSController none=NullController
32 remote=RemoteController default=DefaultController
33 nox=NOX ryu=Ryu ref=Controller
34 .TP
35 \fB\-\-link\fR=\fI\,LINK\/\fR
36 default|ovs|tc|tcu[,param=value...] default=Link
37 ovs=OVSLink tcu=TCULink tc=TCLink
38 .TP
39 \fB\-\-topo\fR=\fI\,TOPO\/\fR
40 linear|minimal|reversed|single|torus|tree[,param=value
41 \&...] linear=LinearTopo
42 reversed=SingleSwitchReversedTopo tree=TreeTopo
43 single=SingleSwitchTopo torus=TorusTopo
44 minimal=MinimalTopo
45 .TP
46 \fB\-c\fR, \fB\-\-clean\fR
47 clean and exit
48 .TP
49 \fB\-\-custom\fR=\fI\,CUSTOM\/\fR
50 read custom classes or params from .py file(s)
51 .TP
52 \fB\-\-test\fR=\fI\,TEST\/\fR
53 none|build|all|iperf|pingpair|iperfudp|pingall
54 .TP
55 \fB\-x\fR, \fB\-\-xterms\fR
56 spawn xterms for each node
57 .TP
58 \fB\-i\fR IPBASE, \fB\-\-ipbase\fR=\fI\,IPBASE\/\fR
59 base IP address for hosts
60 .TP
61 \fB\-\-mac\fR
62 automatically set host MACs
63 .TP
64 \fB\-\-arp\fR
65 set all\-pairs ARP entries
66 .TP
67 \fB\-v\fR VERBOSITY, \fB\-\-verbosity\fR=\fI\,VERBOSITY\/\fR
68 info|warning|critical|error|debug|output
69 .TP
70 \fB\-\-innamespace\fR
71 sw and ctrl in namespace?
72 .TP
73 \fB\-\-listenport\fR=\fI\,LISTENPORT\/\fR
74 base port for passive switch listening
75 .TP
76 \fB\-\-nolistenport\fR
77 don't use passive listening port
78 .TP
79 \fB\-\-pre\fR=\fI\,PRE\/\fR
80 CLI script to run before tests
81 .TP
82 \fB\-\-post\fR=\fI\,POST\/\fR
83 CLI script to run after tests
84 .TP
85 \fB\-\-pin\fR
86 pin hosts to CPU cores (requires \fB\-\-host\fR cfs or \fB\-\-host\fR
87 rt)
88 .TP
89 \fB\-\-nat\fR
90 [option=val...] adds a NAT to the topology that
91 connects Mininet hosts to the physical network.
92 Warning: This may route any traffic on the machine
93 that uses Mininet's IP subnet into the Mininet
94 network. If you need to change Mininet's IP subnet,
95 see the \fB\-\-ipbase\fR option.
96 .TP
97 \fB\-\-version\fR
98 prints the version and exits
99 .TP
100 \fB\-\-cluster\fR=\fI\,server1\/\fR,server2...
101 run on multiple servers (experimental!)
102 .TP
103 \fB\-\-placement\fR=\fI\,block\/\fR|random
104 node placement for \fB\-\-cluster\fR (experimental!)