Statistics
| Branch: | Tag: | Revision:

mininet / README.md @ 32507498

History | View | Annotate | Download (4.38 KB)

1

    
2
Mininet: Rapid Prototyping for Software Defined Networks
3
========================================================
4

    
5
*The best way to emulate almost any network on your laptop!*
6

    
7
Version 2.1.0
8

    
9
### What is Mininet?
10

    
11
Mininet emulates a complete network of hosts, links, and switches
12
on a single machine.  To create a sample two-host, one-switch network,
13
just run:
14

    
15
  `sudo mn`
16

    
17
Mininet is useful for interactive development, testing, and demos,
18
especially those using OpenFlow and SDN.  OpenFlow-based network
19
controllers prototyped in Mininet can usually be transferred to
20
hardware with minimal changes for full line-rate execution.
21

    
22
### How does it work?
23

    
24
Mininet creates virtual networks using process-based virtualization
25
and network namespaces - features that are available in recent Linux
26
kernels.  In Mininet, hosts are emulated as `bash` processes running in
27
a network namespace, so any code that would normally run on a Linux
28
server (like a web server or client program) should run just fine
29
within a Mininet "Host".  The Mininet "Host" will have its own private
30
network interface and can only see its own processes.  Switches in
31
Mininet are software-based switches like Open vSwitch or the OpenFlow
32
reference switch.  Links are virtual ethernet pairs, which live in the
33
Linux kernel and connect our emulated switches to emulated hosts
34
(processes).
35

    
36
### Features
37

    
38
Mininet includes:
39

    
40
* A command-line launcher (`mn`) to instantiate networks.
41

    
42
* A handy Python API for creating networks of varying sizes and
43
  topologies.
44

    
45
* Examples (in the `examples/` directory) to help you get started.
46

    
47
* Full API documentation via Python `help()` docstrings, as well as
48
  the ability to generate PDF/HTML documentation with `make doc`.
49

    
50
* Parametrized topologies (`Topo` subclasses) using the Mininet
51
  object.  For example, a tree network may be created with the
52
  command:
53

    
54
  `mn --topo tree,depth=2,fanout=3`
55

    
56
* A command-line interface (`CLI` class) which provides useful
57
  diagnostic commands (like `iperf` and `ping`), as well as the
58
  ability to run a command to a node. For example,
59

    
60
  `mininet> h11 ifconfig -a`
61

    
62
  tells host h11 to run the command `ifconfig -a`
63

    
64
* A "cleanup" command to get rid of junk (interfaces, processes, files
65
  in /tmp, etc.) which might be left around by Mininet or Linux. Try
66
  this if things stop working!
67

    
68
  `mn -c`
69

    
70
### New features in 2.1.0
71

    
72
Mininet 2.1.0 provides a number of bug fixes as well as a
73
number of new features, including:
74

    
75
* Convenient access to Mininet() as a dict
76
* X11 tunneling (wireshark in Mininet hosts!)
77
* Accurate reflection of the Mininet() object in the CLI
78
* Automatically detecting and adjusting resource limits
79
* Automatic cleanup on failure of the `mn` command
80
* Support for running OVS in user space mode
81
* Preliminary support for the Indigo Virtual Switch (IVSSwitch)
82
* The ability to import examples as modules
83

    
84
We have provided several new examples which can also be
85
imported to provide useful functionality, including:
86

    
87
* A simple NAT script to attach Mininet networks to your LAN
88
* An example of modeling control and data networks
89
* An example of per-host custom directories using bind mounts
90

    
91
Note that these are experimental features which may "graduate"
92
into mainline Mininet in the future, so they should not be
93
considered a stable part of the Mininet API!
94

    
95
### Installation
96

    
97
See `INSTALL` for installation instructions and details.
98

    
99
### Documentation
100

    
101
In addition to the API documentation (`make doc`), much useful
102
information, including a Mininet walkthrough and an introduction
103
to the Python API, is available on the
104
[Mininet Web Site](http://mininet.org).
105
There is also a wiki which you are encouraged to read and to
106
contribute to, particularly the Frequently Asked Questions (FAQ.)
107

    
108
### Support
109

    
110
Mininet is community-supported. We encourage you to join the
111
Mininet mailing list, `mininet-discuss` at:
112

    
113
<https://mailman.stanford.edu/mailman/listinfo/mininet-discuss>
114

    
115
### Contributing
116

    
117
Mininet is an open source project and is currently hosted
118
at <https://github.com/mininet>.  You are encouraged to download
119
the code, examine it, modify it, and submit bug reports, bug fixes,
120
feature requests, new features and other issues and pull requests.
121
Thanks to everyone who has contributed to the project
122
(see CONTRIBUTORS for more info!)
123

    
124
Best wishes, and we look forward to seeing what you can do with
125
Mininet to change the networking world!
126

    
127
### Credits
128

    
129
The Mininet 2.1.0 Team:
130

    
131
* Bob Lantz
132
* Brian O'Connor