Statistics
| Branch: | Tag: | Revision:

mininet @ 9bfc7c77

Name Size Revision Age Author Comment
  bin 19bc1df1 about 8 years Brian O'Connor fixed style error
  custom dec1f402 almost 9 years Brandon Heller custom topo: remove author name No need for th...
  debian 65c35b65 over 8 years ryanc Remove networkx dependency Conflicts: util/i...
  doc c04ef88e almost 9 years Bob Lantz Add note regarding removing old OVS junk.
  examples 9bfc7c77 about 8 years Bob Lantz Satisfy pylint
  mininet e69355f7 about 8 years Bob Lantz One last code check fix: line too long
  util b79ce2a5 about 8 years Bob Lantz Clarify actual testing in module comment
.gitattributes 17 Bytes 29884297 about 9 years Bob Lantz show method names in git diff output
.gitignore 106 Bytes 4f33cad0 about 9 years Bob Lantz Ignore more stuff, notably generated docs and m...
.pylint 8.74 KB 350fdbfe over 9 years Bob Lantz Allow modules (node.py) to be 1500 lines. Maybe...
CONTRIBUTORS 739 Bytes 896c4cbc about 8 years Bob Lantz Edits for 2.1.0
INSTALL 4.06 KB 896c4cbc about 8 years Bob Lantz Edits for 2.1.0
LICENSE 1.66 KB 32507498 about 8 years Bob Lantz Initial text and version updates for 2.1.0
Makefile 1.47 KB 0c5aae15 about 8 years Bob Lantz examples -> mininet/examples for code check
README.md 4.4 KB 226a1dc3 about 8 years Bob Lantz Minor edits
mnexec.c 4.6 KB 36bf8ac9 over 8 years Vitaliy Ivanov mnexec.c: substituting tabs with spaces.
setup.py 1.19 KB 896c4cbc about 8 years Bob Lantz Edits for 2.1.0

Latest revisions

# Date Author Comment
9bfc7c77 09/11/2013 07:00 PM Bob Lantz

Satisfy pylint

045ef7b8 09/11/2013 07:00 PM Bob Lantz

Add docstring to satisfy pylint

e69355f7 09/11/2013 07:00 PM Bob Lantz

One last code check fix: line too long

9d14c841 09/11/2013 07:00 PM Bob Lantz

Pass code check

f796f01f 09/11/2013 07:00 PM Bob Lantz

add spaces to satisfy pylint ;-p

35029978 09/11/2013 07:00 PM Bob Lantz

code check fixes & add comment spaces

445c0959 09/11/2013 07:00 PM Bob Lantz

Pass code check (except bogus Popen error)

0c5aae15 09/11/2013 07:00 PM Bob Lantz

examples -> mininet/examples for code check

2e7d0d49 09/11/2013 07:00 PM Brian O'Connor

fixed indent issue with examples/controllers.py

e9a835ac 09/11/2013 07:00 PM Brian O'Connor

print usage message for unknown command

View all revisions | View revisions

README


Mininet: Rapid Prototyping for Software Defined Networks

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

Version 2.1.0

What is Mininet?

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

sudo mn

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

How does it work?

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

Features

Mininet includes:

  • A command-line launcher (mn) to instantiate networks.

  • A handy Python API for creating networks of varying sizes and topologies.

  • Examples (in the examples/ directory) to help you get started.

  • Full API documentation via Python help() docstrings, as well as the ability to generate PDF/HTML documentation with make doc.

  • Parametrized topologies (Topo subclasses) using the Mininet object. For example, a tree network may be created with the command:

    mn --topo tree,depth=2,fanout=3

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

    mininet> h11 ifconfig -a

    tells host h11 to run the command ifconfig -a

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

    mn -c

New features in 2.1.0

Mininet 2.1.0 provides a number of bug fixes as well as several new features, including:

  • Convenient access to Mininet() as a dict of nodes
  • X11 tunneling (wireshark in Mininet hosts, finally!)
  • Accurate reflection of the Mininet() object in the CLI
  • Automatically detecting and adjusting resource limits
  • Automatic cleanup on failure of the mn command
  • Preliminary support for running OVS in user space mode
  • Preliminary support for the Indigo Virtual Switch (IVSSwitch)
  • The ability to import modules from mininet.examples

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

  • Connecting Mininet hosts the internet (or a LAN) using NAT
  • Modeling control as well as data networks
  • Creating per-host custom directories using bind mounts

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

Installation

See INSTALL for installation instructions and details.

Documentation

In addition to the API documentation (make doc), much useful information, including a Mininet walkthrough and an introduction to the Python API, is available on the Mininet Web Site. There is also a wiki which you are encouraged to read and to contribute to, particularly the Frequently Asked Questions (FAQ.)

Support

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

https://mailman.stanford.edu/mailman/listinfo/mininet-discuss

Contributing

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

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

Credits

The Mininet 2.1.0 Team:

  • Bob Lantz
  • Brian O'Connor

Also available in: Atom