ryu/doc/source/gui.rst

   1 ***************
   2 Topology Viewer
   3 ***************
   4
   5 ryu.app.gui_topology.gui_topology provides topology visualization.
   6
   7 This depends on following ryu applications.
   8
   9 ===================== =================================================
  10 ryu.app.rest_topology Get node and link data.
  11 ryu.app.ws_topology   Being notified change of link up/down.
  12 ryu.app.ofctl_rest    Get flows of datapaths.
  13 ===================== =================================================
  14
  15 Usage
  16 =====
  17
  18 Run mininet (or join your real environment)::
  19
  20     $ sudo mn --controller remote --topo tree,depth=3
  21
  22 Run GUI application::
  23
  24     $ PYTHONPATH=. ./bin/ryu run --observe-links ryu/app/gui_topology/gui_topology.py
  25
  26 Access http://<ip address of ryu host>:8080 with your web browser.
  27
  28 Screenshot
  29 ==========
  30
  31 .. image:: gui.png
  32    :width: 640 px
  33