diff --git a/examples/README.md b/examples/README.md index 56c82d3a57b0cdc1e59aed78019f37ef8a928ed3..8b1383748ef74200ff9c5994af011e5a6c120154 100644 --- a/examples/README.md +++ b/examples/README.md @@ -11,6 +11,31 @@ Mininet's Python API. This example uses Mininet's medium-level API to create an sshd process running in a namespace. Doesn't use OpenFlow. +#### bind.py: + +This example shows how you can create private directories for each +node in a Mininet topology. + +#### cluster.py: + +This example contains all of the code for experimental cluster +edition. Remote classes and MininetCluster can be imported from +here to create a topology with nodes on remote machines. + +#### clusterSanity.py: + +This example runs cluster edition locally as a sanity check to test +basic functionality. + +#### clustercli.py: + +This example contains a CLI for experimental cluster edition. + +#### clusterdemo.py: + +This example is a basic demo of cluster edition on 3 servers with +a tree topology of depth 3 and fanout 3. + #### consoles.py: This example creates a grid of console windows, one for each node, @@ -47,6 +72,11 @@ topology object) and adding nodes to it. This example shows how to add an interface (for example a real hardware interface) to a network after the network is created. +#### intfoptions.py: + +This example reconfigures a TCIntf during runtime with different +traffic control commands to test bandwidth, loss, and delay. + #### limit.py: This example shows how to use link and CPU limits. @@ -56,7 +86,7 @@ This example shows how to use link and CPU limits. This example shows how to create a custom topology programatically by subclassing Topo, and how to run a series of tests on it. -### linuxrouter.py: +#### linuxrouter.py: This example shows how to create and configure a router in Mininet that uses Linux IP forwarding. @@ -65,11 +95,16 @@ that uses Linux IP forwarding. This example demonstrates creating a network via a graphical editor. -#### mobility.py +#### mobility.py: This example demonstrates detaching an interface from one switch and attaching it another as a basic way to move a host around a network. +#### multiLink.py: + +This example demonstrates the creation of multiple links between +nodes using a custom Topology class. + #### multiping.py: This example demonstrates one method for @@ -89,7 +124,12 @@ This example shows how to connect a Mininet network to the Internet using NAT. It also answers the eternal question "why can't I ping `google.com`?" -#### numberedports.py +#### natnet.py: + +This example demonstrates how to create a network using a NAT node +to connect hosts to the internet. + +#### numberedports.py: This example verifies the mininet ofport numbers match up to the ovs port numbers. It also verifies that the port numbers match up to the interface numbers