blob: e3e8179f1d3556e2821daea13c2b2cc7d9c8a664 [file] [log] [blame]
Umesh Krishnaswamy345ee992012-12-13 20:29:48 -08001One of Floodlight's main goals is extensibility and flexibility.
2
3To prove that point, this directory includes a number of useful
4utilities as examples of what can do with this extensibility.
5
6UTILITIES:
7--------------------------
8
9graphDeps.py and graphTopo.py
10
11 Read the module dependencies (graphDeps.py) or the topology
12 from the REST API and output it in the 'dot' format used by the
13 popular graphviz (www.graphviz.org) package so that they can
14 be visualized.
15
16 Example usage:
17 ./graphTopo.py $hostname # generate .dot file
18 dot -Tpdf -o $hostname.pdf $hostname.dot # convert to PDF
19 open $hostname.pdf # open to view topology
20
21
22
23packetStreamerClientExample.py
24
25 Example client for the packet streamer server in floodlight.
26 Allows you to intercept packets from floodlight's packet_in
27 processing chain and read them.
28