vetr-summarizer 0.1.0

A package to generate HTML reports from ACI VETR data JSON files.

Table of Contents

1. vetR Summarizer
2. Objective
3. Installation
4. Usage

vetR Summarizer

This tool summarizes data from any APIC collected by vetr-collector.

Objective

This tool processes data collected by vetr-collector for the ACI health check and displays it in an pretty HTML format. This tool can also be run from any computer having aci-vetr-data collected from any APIC.

A sample preview of the output HTML

Almost all MOs include unnecessary configuration properties. Some of these properties: extMngdBy, childAction, userdom, etc. These unnecessary properties (key-value pairs) are excluded from the report for a neater representation of the output in the HTML file. All excluded keys can be found in config/excluded_keys file. You can also customize the keys to exclude according to your own case.

Installation

Install from PyPi

$ pip install --user vetr-summarizer

Usage

Both keyword arguments are optional. Currently html is the only supported output format.

$ vetr-summarizer --help
usage: vetr-summarizer [-h] [-f {html}] [-x EXCLUDE_FILE] [-v] directory  

Process and summarize aci-vetr-data JSON files into HTML reports.

positional arguments:
  directory             A path to the directory containing the JSON files.

options:
  -h, --help            show this help message and exit
  -f {html}, --format {html}
                        Output format (html).
  -x EXCLUDE_FILE, --exclude-file EXCLUDE_FILE
                        File containing keys to exclude from the summary HTML report.
  -v, --version         show program's version number and exit

Thanks for using vetr-summarizer! :)

$ vetr-summarizer "/path/to/aci-vetr-data"

HTML output is written to /path/to/vetr-summary.html

Author

Osama Abbas

Contributions

As there is always a room for imporovment, you are welcome to contribute to vetr-summarizer.