NAAS

Netmiko As A Service - REST API wrapper for network device automation

NAAS provides a production-ready REST API for Netmiko, enabling network automation through HTTP instead of SSH. Run commands on network devices, manage configurations, and integrate with existing tools—all through a simple API.

Quick Start

# Start with Docker Compose
git clone https://github.com/lykinsbd/naas.git
cd naas
docker compose up -d

# Send a command
curl -k -X POST https://localhost:8443/v1/send_command \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d '{"ip": "192.168.1.1", "platform": "cisco_ios", "commands": ["show version"]}'

📖 Full documentation | 🚀 Installation guide | 📚 API reference

Why NAAS?

• Centralized access - Single API endpoint for all network devices, simplifying security and compliance
• HTTPS everywhere - Proxy SSH/Telnet through HTTPS without complex tunneling
• Asynchronous execution - Non-blocking job queue handles long-running commands
• Multi-platform - Supports 100+ device types via Netmiko
• Production-ready - 100% test coverage, Docker deployment, horizontal scaling

Key Features

v1.3 (Latest)

• ✨ TextFSM structured output - Parse command output into typed data structures
• 🔍 Platform autodetect - Automatic device type detection via SSHDetect
• ⚡ Connection pooling - Persistent SSH connections for better performance
• 📊 Prometheus metrics - Monitor performance and health at /metrics
• 🛑 Job cancellation - Cancel running jobs via DELETE endpoint
• 📝 Audit events - Structured logging for compliance and troubleshooting

Core Features

• ✅ RESTful API with async job processing
• 🔒 HTTPS with TLS and HTTP Basic Auth
• 🐳 Docker Compose and Kubernetes deployment
• 📊 Redis-backed job queue (RQ)
• 🚀 Horizontal scaling support
• 🔌 All Netmiko platforms supported
• 🔐 Circuit breaker pattern for failing devices
• 🎯 100% test coverage

Documentation

• Installation - Docker Compose and Kubernetes
• API Usage - Examples and guides
• API Reference - Interactive Swagger docs
• Contributing - Development setup
• Changelog - Release notes

Contributing

Contributions welcome! See the Contributing Guide for development setup, workflow, and guidelines.

Support

• Documentation - Guides and API reference
• Issues - Bug reports and feature requests
• Discussions - Questions and community support

License

MIT License - see LICENSE file for details

---

Built with Netmiko by Kirk Byers