README

   1 `ti2` is a tool to generate a network diagram in the OS(Linux)
   2 from os environment.
   3
   4 Features
   5 ========
   6 * Collect the network information for the OS (Open vSwitch, Linux Bridge, libvirt)
   7 * Generate the input format of Graph-Easy (basic feature).
   8   Graph-Easy http://search.cpan.org/~shlomif/Graph-Easy-0.72/lib/Graph/Easy.pm
   9 * Generate the springy HTML format.
  10   Springy https://github.com/dhotson/springy
  11
  12 Setup
  13 =====
  14
  15 by tar ball
  16 ----------------
  17 Extract the tar file::
  18
  19    $ tar xfz ti2-x.x.tar.gz
  20
  21 use
  22 ========================
  23    $ cd ti2-x.x
  24    $ ./ti2.py
  25
  26 Usage
  27 =====
  28 Usage: ti2.py [options]
  29
  30 Options:
  31   --version             show program's version number and exit
  32   -h, --help            show this help message and exit
  33   -f FORMAT, --format=FORMAT
  34                         specify output format [FORMAT: g/graph-easy,
  35                         s/springy, r/springy-raphael, t/graphviz-tb]
  36   -d, --debug           enable debug output
  37   -e FILE, --export_file=FILE
  38                         export linkpairs to json file
  39   -x, --export_stdout   export linkpairs to stdout
  40   -i FILE, --import_file=FILE
  41                         import json file as linkpairs
  42   -a, --api_server      enable Web API server
  43   -v, --verbose         verbose output.
  44
  45   Remote connection:
  46     connect to a remote system via SSH
  47
  48     -r REMOTE_DESC, --remote=REMOTE_DESC
  49                         specify user's name and hostname, port number (ex. -r
  50                         user@hostname:22)
  51     -p PASSWORD, --password=PASSWORD
  52                         specify user's SSH password
  53     -k FILE, --sshkey=FILE
  54                         specify user's SSH private-key file
  55
  56   Collector Agent flags:
  57     disable Collector Agents
  58
  59     --disable_ovs_agent
  60                         disable Open vSwitch collector agent
  61     --disable_linux_agent
  62                         disable linux OS collector agent
  63     --disable_linuxnet_agent
  64                         disable linux Network collector agent
  65     --disable_linuxbridge_agent
  66                         disable linux bridge collector agent
  67     --disable_linuxvlan_agent
  68                         disable linux vlan collector agent
  69     --disable_libvirt_agent
  70                         disable libvirt collector agent
  71     --disable_namespace_agent
  72                         disable network namespace collector agent
  73     --disable_sspvxlan_agent
  74                         disable SSP VXLAN collector agent
  75     --disable_veth_agent
  76                         disable veth collector agent
  77
  78
  79 Requirements
  80 ============
  81 * Python 2.6 or later
  82 * Python Libvirt Library 0.9.10 or later.
  83 * Python Flask Library 0.10.1 or later.
  84 * Python SSH Library 1.8.0 or later. (or Paramiko Library 1.7.5 or later.)
  85
  86
  87 License
  88 =======
  89 Apache License 2.0
  90
  91
  92 History
  93 =======
  94
  95 1.2 (2013-10-14)
  96 ------------------
  97 * public release
  98
  99 1.1 (2013-03-06)
 100 ------------------
 101 * first release
 102