Skip to content

lykinsbd/naas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

299 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NAAS

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

Tests Code Quality Docker Build codecov Documentation Status

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

  • ✅ RESTful API with async job processing
  • 🔒 HTTPS with TLS and HTTP Basic Auth
  • 🐳 Docker Compose deployment included
  • 📊 Redis-backed job queue (RQ)
  • 🚀 Horizontal scaling support
  • 🔌 All Netmiko platforms supported

Documentation

Contributing

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

Support

License

MIT License - see LICENSE file for details


Built with Netmiko by Kirk Byers

About

Netmiko as a Service

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors