`ti2` is a tool to generate a network diagram in the OS(Linux)
from os environment.

Features
========
* Collect the network information for the OS (Open vSwitch, Linux Bridge, libvirt)
* Generate the input format of Graph-Easy (basic feature).
  Graph-Easy http://search.cpan.org/~shlomif/Graph-Easy-0.72/lib/Graph/Easy.pm
* Generate the springy HTML format.
  Springy https://github.com/dhotson/springy

Setup
=====

by tar ball
----------------
Extract the tar file::

   $ tar xfz ti2-x.x.tar.gz

use
========================
   $ cd ti2-x.x
   $ ./ti2.py

Usage
=====
Usage: ti2.py [options]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -f FORMAT, --format=FORMAT
                        specify output format [FORMAT: g/graph-easy,
                        s/springy, r/springy-raphael, t/graphviz-tb]
  -d, --debug           enable debug output
  -e FILE, --export_file=FILE
                        export linkpairs to json file
  -x, --export_stdout   export linkpairs to stdout
  -i FILE, --import_file=FILE
                        import json file as linkpairs
  -a, --api_server      enable Web API server
  -v, --verbose         verbose output.

  Remote connection:
    connect to a remote system via SSH

    -r REMOTE_DESC, --remote=REMOTE_DESC
                        specify user's name and hostname, port number (ex. -r
                        user@hostname:22)
    -p PASSWORD, --password=PASSWORD
                        specify user's SSH password
    -k FILE, --sshkey=FILE
                        specify user's SSH private-key file

  Collector Agent flags:
    disable Collector Agents

    --disable_ovs_agent
                        disable Open vSwitch collector agent
    --disable_linux_agent
                        disable linux OS collector agent
    --disable_linuxnet_agent
                        disable linux Network collector agent
    --disable_linuxbridge_agent
                        disable linux bridge collector agent
    --disable_linuxvlan_agent
                        disable linux vlan collector agent
    --disable_libvirt_agent
                        disable libvirt collector agent
    --disable_namespace_agent
                        disable network namespace collector agent
    --disable_sspvxlan_agent
                        disable SSP VXLAN collector agent
    --disable_veth_agent
                        disable veth collector agent


Requirements
============
* Python 2.6 or later
* Python Libvirt Library 0.9.10 or later.
* Python Flask Library 0.10.1 or later.
* Python SSH Library 1.8.0 or later. (or Paramiko Library 1.7.5 or later.)


License
=======
Apache License 2.0


History
=======

1.2 (2013-10-14)
------------------
* public release

1.1 (2013-03-06)
------------------
* first release

