mininet/README.md

   1 Mininet: Rapid Prototyping for Software Defined Networks
   2 ========================================================
   3 *The best way to emulate almost any network on your laptop!*
   4
   5 Mininet 2.3.0d5
   6
   7 [![Build Status][1]](https://travis-ci.org/mininet/mininet)
   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 this release
  71
  72 This is primarily a performance improvement and bug fix release.
  73
  74 - Batch startup has been implemented for Open vSwitch, improving
  75   startup performance.
  76
  77 - OVS patch links have been implemented via OVSLink and --link ovs
  78
  79   Warning! These links have *serious limitations* compared to
  80   virtual Ethernet pairs: they are not attached to real Linux
  81   interfaces so you cannot use tcpdump or wireshark with them;
  82   they also cannot be used in long chains - we don't recommend more
  83   than 64 OVSLinks, for example --linear,64. However, they can offer
  84   significantly better performance than veth pairs, for certain
  85   configurations.
  86
  87 - You can now easily install Mininet on a Raspberry Pi ;-)
  88
  89 - Additional information for this release and previous releases
  90   may be found in the release notes on docs.mininet.org
  91
  92 ### Installation
  93
  94 See `INSTALL` for installation instructions and details.
  95
  96 ### Documentation
  97
  98 In addition to the API documentation (`make doc`), much useful
  99 information, including a Mininet walkthrough and an introduction
 100 to the Python API, is available on the
 101 [Mininet Web Site](http://mininet.org).
 102 There is also a wiki which you are encouraged to read and to
 103 contribute to, particularly the Frequently Asked Questions (FAQ.)
 104
 105 ### Support
 106
 107 Mininet is community-supported. We encourage you to join the
 108 Mininet mailing list, `mininet-discuss` at:
 109
 110 <https://mailman.stanford.edu/mailman/listinfo/mininet-discuss>
 111
 112 ### Join Us
 113
 114 Thanks again to all of the Mininet contributors!
 115
 116 Mininet is an open source project and is currently hosted
 117 at <https://github.com/mininet>.  You are encouraged to download
 118 the code, examine it, modify it, and submit bug reports, bug fixes,
 119 feature requests, new features and other issues and pull requests.
 120 Thanks to everyone who has contributed code to the Mininet project
 121 (see CONTRIBUTORS for more info!) It is because of everyone's
 122 hard work that Mininet continues to grow and improve.
 123
 124 ### Enjoy Mininet
 125
 126 Best wishes, and we look forward to seeing what you can do with
 127 Mininet to change the networking world!
 128
 129 Bob Lantz
 130 Mininet Core Team
 131
 132 [1]: https://travis-ci.org/mininet/mininet.svg?branch=master