Quickstart Guide

Get up and running with Network Automation Toolkit in minutes.

Prerequisites

  • • Docker Desktop installed
  • • SSH access to your Cisco devices
  • • Basic familiarity with the command line
1

Install Docker Desktop

Download and install Docker Desktop from docker.com/products/docker-desktop/

Windows users: Enable WSL2 when prompted during installation.

2

Authenticate with Docker

Log in to Docker to pull the Network Automation Toolkit image:

Terminal 
docker login
3

Set up your workspace

Create a working directory and add two files: devices.csv and docker-compose.yml

devices.csv

Create a CSV file listing your network devices:

devices.csv 
host,device_type
192.168.1.1,cisco_ios
192.168.1.2,cisco_xe

Supported device types:

  • cisco_ios - Cisco IOS devices
  • cisco_xe - Cisco IOS-XE devices
  • cisco_nxos - Cisco NX-OS devices
  • cisco_asa - Cisco ASA firewalls

docker-compose.yml

Create a Docker Compose file to run the toolkit:

docker-compose.yml 
version: '3.8'

services:
  network_automation:
    image: vietha/network_automation_tools:latest
    volumes:
      - ./devices.csv:/app/devices.csv
      - ./outputs:/app/outputs
      # Uncomment for AWS tools:
      # - ~/.aws:/root/.aws:ro
      # Uncomment for FortiGate tools:
      # - ./fortigate_profiles:/app/fortigate_profiles:ro
    stdin_open: true
    tty: true
4

Run the toolkit

Launch the interactive menu:

Terminal 
docker compose run network_automation

This will present a menu where you can select which tool to run. Output files will be saved to the outputs/ directory in your workspace.

Updating to the latest version

Pull the latest image:

Terminal 
docker compose pull
Explore Tools →