GitHub - ksator/arista_eos_audit: This repo has python content to collect eos commands from Arista devices. It also has python content to audit offline the data collected and to generate a report.

Table of content

About this repository
Requirements
How to use this repository
Repository details
    input.yml file
    audit directory
    collect_eos_commands.py file
    custom_show_tech_support.py file
    generate_audit_report.py file
        Overview
        Report files
        Supported audit features

About this repository

This repo has python content to collect eos commands from Arista devices.
It also has python content to audit offline the data collected and to generate a report.

Requirements

I am using this Python version

python -V
Python 3.7.7

And I installed netmiko to interact with EOS devices.

pip freeze | grep netmiko
netmiko==3.1.1

How to use this repository

Install the requirements described in the above section.

Then update the file input.yml. It has the required input for the various scripts available in this repository.

Then you can run the script collect_eos_commands.py to collect commands output from EOS devices.

If you want to generate offline a custom show tech-support text file, run the script custom_show_tech_support.py.

Once you collected the commands output, you can run the script generate_audit_report.py to generate reports.

Repository details

input.yml file

This is the repository input.

The file input.yml has the required input for the files

It is used to define these variables:

devices: list of EOS devices
username: devices username
password: devices password
text_cmds: list EOS commands to collect in text format
json_cmds: list EOS commands to collect in JSON format
text_and_json_cmds: list EOS commands to collect in text and JSON format
output_directory: directory to save the show commands collected and the reports generated
custom_show_tech_support: list of files (show commands) to include in a custom show tech-support text file.
audit: list of topics to audit and to include in the report.

audit directory

The audit directory is a python package that has python functions.
Some of these functions are imported by the pythons scritps of this repository (collect_eos_commands.py, custom_show_tech_support.py, generate_audit_report.py)

collect_eos_commands.py file

It is used to collect EOS commands.

It uses the variables defined in the file input.yml to collect show commands from EOS devices.
It supports collecting show commands in both text and JSON format.
The commands output is saved in device directory in the output directory.

click me to see the output structure

output/10.83.28.122/eos_commands
├── json
│   ├── show\ hostname.json
│   ├── show\ interfaces\ description.json
│   ├── show\ inventory.json
│   ├── show\ ip\ bgp\ summary\ vrf\ all.json
│   ├── show\ lldp\ neighbors.json
│   ├── show\ mlag\ detail.json
│   ├── show\ reload\ cause\ full.json
│   ├── show\ reload\ cause\ history.json
│   ├── show\ system\ environment\ cooling.json
│   ├── show\ system\ environment\ power.json
│   ├── show\ system\ environment\ temperature\ transceiver.json
│   ├── show\ system\ environment\ temperature.json
│   └── show\ version.json
└── text
    ├── custom\ show\ tech-support.txt
    ├── show\ hostname.txt
    ├── show\ interfaces\ description.txt
    ├── show\ inventory.txt
    ├── show\ ip\ bgp\ summary\ vrf\ all.txt
    ├── show\ lldp\ neighbors.txt
    ├── show\ logging\ system.txt
    ├── show\ mlag\ detail.txt
    ├── show\ reload\ cause\ full.txt
    ├── show\ reload\ cause\ history.txt
    ├── show\ running-config.txt
    ├── show\ system\ environment\ cooling.txt
    ├── show\ system\ environment\ power.txt
    ├── show\ system\ environment\ temperature\ transceiver.txt
    ├── show\ system\ environment\ temperature.txt
    └── show\ version.txt
output/10.83.28.203/eos_commands
├── json
│   ├── show\ hostname.json
│   ├── show\ interfaces\ description.json
│   ├── show\ inventory.json
│   ├── show\ ip\ bgp\ summary\ vrf\ all.json
│   ├── show\ lldp\ neighbors.json
│   ├── show\ mlag\ detail.json
│   ├── show\ reload\ cause\ full.json
│   ├── show\ reload\ cause\ history.json
│   ├── show\ system\ environment\ cooling.json
│   ├── show\ system\ environment\ power.json
│   ├── show\ system\ environment\ temperature\ transceiver.json
│   ├── show\ system\ environment\ temperature.json
│   └── show\ version.json
└── text
    ├── custom\ show\ tech-support.txt
    ├── show\ hostname.txt
    ├── show\ interfaces\ description.txt
    ├── show\ inventory.txt
    ├── show\ ip\ bgp\ summary\ vrf\ all.txt
    ├── show\ lldp\ neighbors.txt
    ├── show\ logging\ system.txt
    ├── show\ mlag\ detail.txt
    ├── show\ reload\ cause\ full.txt
    ├── show\ reload\ cause\ history.txt
    ├── show\ running-config.txt
    ├── show\ system\ environment\ cooling.txt
    ├── show\ system\ environment\ power.txt
    ├── show\ system\ environment\ temperature\ transceiver.txt
    ├── show\ system\ environment\ temperature.txt
    └── show\ version.txt
output/10.83.28.217/eos_commands
├── json
│   ├── show\ hostname.json
│   ├── show\ interfaces\ description.json
│   ├── show\ inventory.json
│   ├── show\ ip\ bgp\ summary\ vrf\ all.json
│   ├── show\ lldp\ neighbors.json
│   ├── show\ mlag\ detail.json
│   ├── show\ reload\ cause\ full.json
│   ├── show\ reload\ cause\ history.json
│   ├── show\ system\ environment\ cooling.json
│   ├── show\ system\ environment\ power.json
│   ├── show\ system\ environment\ temperature\ transceiver.json
│   ├── show\ system\ environment\ temperature.json
│   └── show\ version.json
└── text
    ├── custom\ show\ tech-support.txt
    ├── show\ hostname.txt
    ├── show\ interfaces\ description.txt
    ├── show\ inventory.txt
    ├── show\ ip\ bgp\ summary\ vrf\ all.txt
    ├── show\ lldp\ neighbors.txt
    ├── show\ logging\ system.txt
    ├── show\ mlag\ detail.txt
    ├── show\ reload\ cause\ full.txt
    ├── show\ reload\ cause\ history.txt
    ├── show\ running-config.txt
    ├── show\ system\ environment\ cooling.txt
    ├── show\ system\ environment\ power.txt
    ├── show\ system\ environment\ temperature\ transceiver.txt
    ├── show\ system\ environment\ temperature.txt
    └── show\ version.txt

custom_show_tech_support.py file

It is used to build a custom show tech-support file.

It uses the variables defined in the file input.yml to generate offline a custom show tech-support text file.
For each devices indicated in input.yml, it assembles the files (based on what is indicated in input.yml file) to generate offline a custom show tech-support text file.
It supports only the text format (no JSON format support).
The name of the output file is "custom show tech-support.txt". It is saved in device directory in the output directory.

tree output/*/eos_commands/text -f  | grep custom
├── output/10.83.28.122/eos_commands/text/custom\ show\ tech-support.txt
├── output/10.83.28.203/eos_commands/text/custom\ show\ tech-support.txt
├── output/10.83.28.217/eos_commands/text/custom\ show\ tech-support.txt

generate_audit_report.py file

It is used to generate audit reports.

Overview

The file generate_audit_report.py uses the variables defined in the file input.yml to audit offline some of the collected files and to generate a report.

Report files

For each device defined in the file input.yml, the file generate_audit_report.py generates 2 reports in the "report" directory:

The file "main.txt" includes details regarding all the tests generate_audit_report.py ran for this device.
The file "failures_only.txt" includes only the tests that failed for this device.

click me to see the output structure

output/10.83.28.122/reports
├── failures_only
│   ├── check_bgp.txt
│   ├── check_cooling.txt
│   ├── check_inventory.txt
│   ├── check_mlag.txt
│   ├── check_power.txt
│   ├── check_reload_cause_full.txt
│   ├── check_reload_cause_history.txt
│   ├── check_temperature.txt
│   ├── check_temperature_transceivers.txt
│   ├── init.txt
│   ├── print_hostname.txt
│   ├── print_lldp.txt
│   └── print_version.txt
├── failures_only.txt
├── main
│   ├── check_bgp.txt
│   ├── check_cooling.txt
│   ├── check_inventory.txt
│   ├── check_mlag.txt
│   ├── check_power.txt
│   ├── check_reload_cause_full.txt
│   ├── check_reload_cause_history.txt
│   ├── check_temperature.txt
│   ├── check_temperature_transceivers.txt
│   ├── init.txt
│   ├── print_hostname.txt
│   ├── print_lldp.txt
│   └── print_version.txt
└── main.txt
output/10.83.28.203/reports
├── failures_only
│   ├── check_bgp.txt
│   ├── check_cooling.txt
│   ├── check_inventory.txt
│   ├── check_mlag.txt
│   ├── check_power.txt
│   ├── check_reload_cause_full.txt
│   ├── check_reload_cause_history.txt
│   ├── check_temperature.txt
│   ├── check_temperature_transceivers.txt
│   ├── init.txt
│   ├── print_hostname.txt
│   ├── print_lldp.txt
│   └── print_version.txt
├── failures_only.txt
├── main
│   ├── check_bgp.txt
│   ├── check_cooling.txt
│   ├── check_inventory.txt
│   ├── check_mlag.txt
│   ├── check_power.txt
│   ├── check_reload_cause_full.txt
│   ├── check_reload_cause_history.txt
│   ├── check_temperature.txt
│   ├── check_temperature_transceivers.txt
│   ├── init.txt
│   ├── print_hostname.txt
│   ├── print_lldp.txt
│   └── print_version.txt
└── main.txt
output/10.83.28.217/reports
├── failures_only
│   ├── check_bgp.txt
│   ├── check_cooling.txt
│   ├── check_inventory.txt
│   ├── check_mlag.txt
│   ├── check_power.txt
│   ├── check_reload_cause_full.txt
│   ├── check_reload_cause_history.txt
│   ├── check_temperature.txt
│   ├── check_temperature_transceivers.txt
│   ├── init.txt
│   ├── print_hostname.txt
│   ├── print_lldp.txt
│   └── print_version.txt
├── failures_only.txt
├── main
│   ├── check_bgp.txt
│   ├── check_cooling.txt
│   ├── check_inventory.txt
│   ├── check_mlag.txt
│   ├── check_power.txt
│   ├── check_reload_cause_full.txt
│   ├── check_reload_cause_history.txt
│   ├── check_temperature.txt
│   ├── check_temperature_transceivers.txt
│   ├── init.txt
│   ├── print_hostname.txt
│   ├── print_lldp.txt
│   └── print_version.txt
└── main.txt

Then, the file generate_audit_report.py:

Assembles the "main.txt" report of each device into one main.txt file. So main.txt includes all the tests generate_audit_report.py ran for all the devices. It is saved at the root of the output directory.
Assembles the "failures_only.txt" report of each device into one failures_only.txt file. So failures_only.txt includes for all the devices only the tests that failed. It is saved at the root of the output directory.

Supported audit features

The file generate_audit_report.py imports python functions from the audit python package

To enable or disable audit features on generate_audit_report.py, update the file input.yml.

The following audit features are currently supported:

print_hostname

Description: include the device hostname and fqdn
Required eos command: show hostname | json
Test failure conditions: This is a report without any test so there is no failure/passing condition