mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-09-01 15:54:03 +03:00
e2e2e23cf7
Implement custom VPCS driver and unified tool architecture:
- Add VPCSTelnet custom driver (vpcs_telnet.py)
- No authentication (direct console access like VPCS behavior)
- Simple prompt pattern matching (PC\d+>)
- Automatic ANSI escape code stripping for clean output
- Config mode methods return empty (VPCS has no config modes)
- Replace vpcs_tools_telnetlib3.py with vpcs_tools_netmiko.py
- Migrate from telnetlib3 to Netmiko + Nornir architecture
- Unified tool architecture matching config/display tools
- Improved code consistency and maintainability
- Add comprehensive test coverage (test_vpcs_telnet.py)
- 30 unit tests covering all VPCS driver functionality
- Tests for ANSI code stripping, telnet_login, send_command
- Tests for device registration and initialization
- Update VPCS built-in template (services/templates.py)
- Add platform:vpcs and device_type:gns3_vpcs_telnet tags
- Automatic driver selection without manual configuration
- Update documentation (docs/)
- multi-vendor-device-support.md: VPCS driver documentation
- netmiko_devices.md: Add VPCS to supported devices list
- README.md: Update multi-vendor support description
140 lines
4.6 KiB
Markdown
140 lines
4.6 KiB
Markdown
# GNS3 AI Copilot Documentation
|
|
|
|
This directory contains design documentation, implementation guides, and future plans for the GNS3 AI Copilot feature.
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
docs/gns3-copilot/
|
|
├── README.md # This file
|
|
└── implemented/ # Implemented features and designs
|
|
├── chat-api.md # Chat API design (SSE, session management)
|
|
├── llm-model-configs.md # LLM model configuration system
|
|
├── command-security.md # Command security and filtering
|
|
├── context-window-management.md # Context window optimization
|
|
├── node-control-tools.md # Node start/stop/suspend tools for lab automation
|
|
└── multi-vendor-device-support.md # Multi-vendor device support (Cisco, Huawei)
|
|
```
|
|
|
|
## Implemented Features
|
|
|
|
### Chat API (`implemented/chat-api.md`)
|
|
The core Chat API that enables AI-powered conversations within GNS3 projects.
|
|
|
|
**Key Features:**
|
|
- Server-Sent Events (SSE) for streaming responses
|
|
- Project-level session isolation
|
|
- Session management (CRUD operations)
|
|
- Statistics tracking (messages, tokens, LLM calls)
|
|
- User-level LLM configuration
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### LLM Model Configs (`implemented/llm-model-configs.md`)
|
|
Multi-level LLM model configuration system.
|
|
|
|
**Key Features:**
|
|
- System-wide defaults
|
|
- Group-level configurations
|
|
- User-level overrides
|
|
- Runtime parameter adjustment
|
|
- Model provider abstraction
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### Command Security (`implemented/command-security.md`)
|
|
Security framework for AI-generated commands.
|
|
|
|
**Key Features:**
|
|
- Command filtering and validation
|
|
- Dangerous operation detection
|
|
- HITL (Human-in-the-Loop) confirmations
|
|
- Audit logging
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### Context Window Management (`implemented/context-window-management.md`)
|
|
Optimization strategies for handling large project contexts.
|
|
|
|
**Key Features:**
|
|
- Intelligent content filtering
|
|
- Token usage optimization
|
|
- Summary generation
|
|
- Context compression
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### Node Control Tools (`implemented/node-control-tools.md`)
|
|
Tools for controlling network device lifecycle in GNS3 projects.
|
|
|
|
**Key Features:**
|
|
- Start nodes with progress tracking
|
|
- Quick start for automated workflows
|
|
- Stop nodes for lab shutdown
|
|
- Batch operations support
|
|
- Mode-based access control
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### Multi-Vendor Device Support (`implemented/multi-vendor-device-support.md`)
|
|
Multi-vendor network device support with custom Netmiko drivers for Huawei, Ruijie, and VPCS devices.
|
|
|
|
**Key Features:**
|
|
- Custom HuaweiTelnetCE driver for Huawei CloudEngine (no authentication)
|
|
- Custom RuijieTelnetEnhanced driver for Ruijie OS (interactive command handling)
|
|
- Custom VPCSTelnet driver for VPCS simulator (no authentication, ANSI code stripping)
|
|
- Cisco IOS Telnet support
|
|
- Dynamic device type detection from GNS3 tags
|
|
- Unified Nornir + Netmiko architecture
|
|
- Vendor-specific command handling (VRP system-view, Ruijie interactive prompts, VPCS simple prompts)
|
|
|
|
**Tested Vendors:**
|
|
- Cisco IOS (Telnet)
|
|
- Huawei CloudEngine (Telnet, custom driver)
|
|
- Ruijie (锐捷) OS (Telnet, custom enhanced driver)
|
|
- VPCS (Virtual PC Simulator, Telnet, custom driver)
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
## Future Enhancements
|
|
|
|
The following features are currently under consideration or development:
|
|
|
|
- Configuration Templates: Template-based configuration generation for multi-vendor network devices
|
|
- Vision-based Topology Creation: Create network topologies from images/diagrams
|
|
- Enhanced HITL Workflows: Advanced Human-in-the-Loop confirmation patterns
|
|
- Web UI Enhancements: Improved management interfaces
|
|
|
|
## Contributing
|
|
|
|
When adding new documentation:
|
|
|
|
1. **Implementation:** Add documentation to `implemented/` when feature is complete
|
|
2. **Naming:** Use concise names like `{feature}.md`
|
|
|
|
## Document Status Legend
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| ✅ Implemented | Feature is fully implemented and deployed |
|
|
| 📋 Design Complete | Design is done, awaiting implementation |
|
|
| 🚧 In Progress | Currently being implemented |
|
|
| 💡 Proposed | Initial idea or proposal |
|
|
|
|
## Related Documentation
|
|
|
|
- [GNS3 Server API Documentation](https://api.gns3.com/)
|
|
- [GNS3 Web UI Documentation](https://docs.gns3.com/)
|
|
- [LangGraph Documentation](https://langchain-ai.github.io/langgraph/)
|
|
- [FastAPI Documentation](https://fastapi.tiangolo.com/)
|
|
|
|
## Quick Links
|
|
|
|
- **Current Feature Branch:** `feature/ai-copilot-bridge`
|
|
- **Main Branch:** `master`
|
|
- **Issue Tracker:** [GitHub Issues](https://github.com/GNS3/gns3-server/issues)
|
|
|
|
---
|
|
|
|
_Last updated: 2026-03-14_
|