# odltools

**Repository Path**: mirrors_opendaylight/odltools

## Basic Information

- **Project Name**: odltools
- **Description**: ODL Tools
- **Primary Language**: Unknown
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

.. image:: https://travis-ci.org/shague/odltools.png?branch=master
   :target: https://travis-ci.org/shague/odltools

.. image:: https://img.shields.io/pypi/v/odltools.svg
   :target: https://pypi.python.org/pypi/odltools

.. image:: https://img.shields.io/pypi/wheel/odltools.svg
   :target: https://pypi.python.org/pypi/odltools

.. image:: https://img.shields.io/pypi/l/odltools.svg
   :target: https://pypi.python.org/pypi/odltools

.. image:: https://img.shields.io/pypi/pyversions/odltools.svg
   :target: https://pypi.python.org/pypi/odltools

odltools
========

A tool to troubleshoot the NetVirt OpenDaylight OpenStack integration.

The tool can fetch mdsal model dumps, openvswitch flow dumps
and extract dumps from CSIT output.xml files.

It also provides a set of BIST (built-in self-tests) that provide a
starting point for debugging an ODL deployment.

odltool's documentation can be found at `Read The Docs <http://odltools.readthedocs.org>`_.

Requirements
------------

* python 2.7, 3.3, 3.4, 3.5, 3.6
* requests

Installation
------------
::

  pip install odltools

Usage
-----
::

   usage: python -m odltools [-h] [-v] [-V]
                             {bist,csit,karaf,model,monitor,analyze,show} ...

   OpenDaylight Troubleshooting Tools

   optional arguments:
     -h, --help            show this help message and exit
     -v, --verbose         verbosity (-v, -vv)
     -V, --version         show program's version number and exit

   subcommands:
     Command Tool

     {bist,csit,karaf,model,monitor,analyze,show}


Contribute
----------
``odltools`` is an open source project that welcomes any and all contributions
from the community. odltools is hosted on `GitHub <http://github.com/shague/odltools>`_
.

Feel free to contribute to:

- `code <https://git.opendaylight.org/gerrit/gitweb?p=odltools.git>`_,
- `documentation <http://odltools.readthedocs.org>`_,
- `bug reports <https://jira.opendaylight.org/projects/ODLTOOLS>`_,
- `contribution reviews <https://git.opendaylight.org/gerrit/#/q/project:odltools>`_.

Please see the `Contributor Guidelines <https://git.opendaylight.org/gerrit/gitweb?p=odltools.git;a=blob;f=CONTRIBUTING.rst>`_
for information about contributing.

Licensing
---------
See the `LICENSE <http://github.com/shague/odltools/LICENSE.txt>`_ file