devices.csv

Show Interfaces

Collect interface state and statistics from all devices.

Description

The Show Interfaces tool collects detailed interface state and statistics from all devices in your network. It captures interface status (up/down), line protocol state, bandwidth, MTU, error counters, and traffic statistics. This data is useful for monitoring interface health, troubleshooting connectivity issues, and tracking performance metrics over time.

Input

This tool requires:

  • devices.csv file with columns: host, device_type
  • SSH credentials (username and password prompted at runtime)
  • Output folder name (prompted at runtime)

Usage

Run the toolkit and select option [2] from the menu:

Terminal
docker compose run network_automation

Output

Results are saved to:

outputs/show_interfaces/<run_name>_<timestamp>/

Each run produces:

  • CSV files - One per device with interface statistics
  • JSON files - Raw parsed output from each device
  • Excel summary report - Consolidated interface data across all devices

Standalone Usage

To run this tool directly without the run.py menu:

Terminal
cd tools/show_interfaces/scripts && python interface.py