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]
  36   -d FILE, --database=FILE
  37                         store record to database
  38   -t TYPE, --datatype=TYPE
  39                         specify database type(default: json)
  40   -v, --verbose         verbose output.
  41
  42   Remote connection:
  43     connect to a remote system via SSH
  44
  45     -r REMOTE_DESC, --remote=REMOTE_DESC
  46                         specify user's name and hostname, port number (ex. -r
  47                         user@hostname:22)
  48     -p PASSWORD, --password=PASSWORD
  49                         specify user's SSH password
  50     -k FILE, --sshkey=FILE
  51                         specify user's SSH private-key file
  52
  53
  54 Requirements
  55 ============
  56 * Python 2.6 or later
  57 * Python Libvirt Library 0.9.10 or later.
  58 * Python SSH Library 1.8.0 or later. (or Paramiko Library 1.7.5 or later.)
  59
  60
  61 License
  62 =======
  63 Apache License 2.0
  64
  65
  66 History
  67 =======
  68
  69 1.1 (2013-03-06)
  70 ------------------
  71 * first release
  72