velocitycmdb 0.10.0

Tactical network CMDB with automated discovery, change detection, and operational intelligence

VelocityCMDB

Tactical, highly portable network CMDB with automated discovery, change detection, and operational intelligence for Windows, Mac or Linux

⚠️ Important Notice

VelocityCMDB is currently in Proof of Concept (POC) stage and is under active development. While functional, it is not yet recommended for production environments. The codebase and features are subject to significant changes. Feel free to test, contribute, and provide feedback, but please exercise caution in production or security-critical environments.

New site onboarded in under 1 hour - Automated discovery, configuration capture, and topology visualization out of the box.

---

What is VelocityCMDB?

VelocityCMDB is a pip-installable network CMDB that combines asset management, automated discovery, configuration tracking, and operational intelligence in a unified platform.

Key Features:

• 🔍 Automated Discovery - LLDP/CDP-based topology mapping
• 📊 Device Inventory - Complete asset tracking with components, sites, vendors, roles
• 🔄 Change Detection - Real-time configuration and other cli captured information monitoring with severity classification
• 🗺️ Topology Visualization - Interactive maps with export to GraphML/DrawIO/PNG
• 🔍 Operational Search - Full-text search across 8,891+ captures (Config, Arp, Mac, Inventory and more)
• 📝 Integrated Documentation - Wiki-style notes linked to devices
• 🖥️ Web SSH Terminal - Browser-based device access with authentication
• 👥 Multi-Auth - LDAP, local database, and OS authentication

Why VelocityCMDB?

• ⚡ Fast Setup - pip install velocitycmdb && init command, then start the app
• 🎯 Wizard-Driven - Discovery and collection wizards guide deployment
• 🏢 Enterprise Friendly - Basic Role-based access, audit logging, backup/restore
• 🔧 Engineer-Focused - CLI tools, REST API, and scriptable workflows, run locally or on a server

---

Quick Start

Installation

# Install from PyPI (coming soon)
pip install velocitycmdb

# Initialize databases and directories
python -m velocitycmdb.cli init

# Create first admin user
python -m velocitycmdb.cli create-admin

# Start the web server
python -m velocitycmdb.app.run

Access the dashboard at http://localhost:8086

Onboard Your First Site

Step 1: Run Discovery Wizard (15 minutes)

• Navigate to Discovery → Wizard
• Enter seed device credentials
• Let LLDP/CDP discover your network
• Review topology map

Step 2: Run Collection Wizard (30 minutes)

• Select discovered devices
• Choose capture types (configs, routes, MACs, etc.)
• Execute concurrent collection
• Review capture status

Total Time: ~45 minutes ✅

---

Architecture

VelocityCMDB is built on proven open-source components:

Foundation:

• Secure Cartography - Network discovery (134⭐, 21 forks)
• Paramiko - SSH automation
• TextFSM - Multi-vendor parsing (100+ templates)
• Flask + SocketIO - Real-time web interface
• SQLite FTS5 - Full-text search

Novel Contributions:

• Pip-installable packaging with CLI entry points
• Wizard-driven workflows for discovery and collection
• Component-level hardware tracking with normalization
• Integrated knowledge system with device associations
• Dual-database architecture (assets + ARP tracking)
• Configuration change detection with content hashing

Structure:

velocitycmdb/
├── cli.py                 # Command-line interface
├── app/                   # Flask web application
│   ├── blueprints/       # 13+ modular features
│   └── templates/        # Material Design 3 UI
├── services/             # Business logic
│   ├── discovery.py      # LLDP-based topology
│   ├── collection.py     # Data capture orchestration
│   └── fingerprint.py    # Device classification
├── db/                   # Database management
└── pcng/                 # Capture engine (100+ job templates)

---

Features

Asset Management

• Devices - Full CRUD with sites, vendors, roles, stacks
• Components - Hardware inventory (1,684 components tracked)
• Sites/Vendors/Roles - Complete taxonomy management
• Bulk Operations - Preview-commit workflow for batch changes

Discovery & Topology

• Automated Discovery - LLDP/CDP-based network mapping
• Topology Maps - Interactive visualization with export
• Secure Cartography - Enhanced topology with vendor icons
• Multiple Formats - GraphML (yEd), DrawIO, PNG, SVG

Operational Intelligence

• Capture Search - Full-text search across configurations
• Change Detection - Real-time config monitoring with diffs
• Coverage Analysis - Gap identification and success metrics
• OS Version Tracking - Compliance monitoring
• ARP Search - MAC address lookup with vendor OUI

Collaboration

• Notes System - Wiki-style documentation with rich text
• Device Associations - Link notes to devices and sites
• Internal Linking - [[Note Title]] syntax for knowledge graphs
• Full-Text Search - Unified search across notes + captures

Security & Administration

• Multi-Auth Backend - LDAP, database, OS authentication
• Role-Based Access - Admin, operator, viewer groups
• Audit Logging - Track all administrative actions
• Backup/Restore - Complete system lifecycle management
• User Management - Full CRUD with password policies

Automation

• SSH Terminal - WebSocket-based browser access
• Collection Wizard - Concurrent capture execution
• 100+ Job Templates - Pre-built for Cisco, Arista, Juniper, HPE
• REST API - Programmatic access to all features

---

Screenshots

Device Inventory 12 devices across sites with vendor/role filtering	Device Detail Hardware components with capture status
Change Tracking 33 configuration changes with severity	Collection Wizard Real-time concurrent capture execution
Capture Search Full-text search across operational data	SSH Terminal Web-based device access with credentials

---

Proven at Scale

Production Deployment Stats:

• ✅ 357 devices managed
• ✅ 53 sites across infrastructure
• ✅ 126 switch stacks tracked
• ✅ 1,684 hardware components
• ✅ 8,891 successful captures
• ✅ 99.3% device classification accuracy

Performance:

• Discovery: 45-60 min for 295 devices
• Fingerprinting: 60-90 min (8 concurrent processes)
• Full onboarding cycle: ~4 hours (manual)
• Dashboard response: <500ms
• Backup: 15-30 sec (58 MB compressed)

Vendor Support:

• Cisco IOS/IOS-XE/NX-OS
• Arista EOS
• HPE ProCurve/Aruba
• Juniper Junos (beta)

---

Documentation

Comprehensive guides for every component:

Getting Started:

• Installation Guide
• Quick Start Tutorial
• Configuration Guide

Core Workflows:

• Network Discovery
• Data Collection
• Change Detection
• Topology Visualization

Administration:

• User Management
• Authentication Setup
• Backup & Restore
• Database Management

Development:

• API Documentation
• Plugin Development
• Contributing Guide

---

CLI Reference

# Initialize system
velocitycmdb init                    # Create databases and directories
velocitycmdb create-admin            # Create first admin user

# Server management  
velocitycmdb run                     # Start web server (port 8086)
velocitycmdb run --port 5000        # Custom port

# Database operations
velocitycmdb backup                  # Create system backup
velocitycmdb restore backup.zip      # Restore from backup
velocitycmdb db-check               # Validate database health

# Discovery operations
velocitycmdb discover --seed 10.0.1.1 --username admin

# Bulk operations
velocitycmdb collect --site "ENG Site" --capture configs

---

Roadmap

v1.0 - Foundation (Current)

• ✅ Pip-installable package
• ✅ Wizard-driven workflows
• ✅ 13+ feature modules
• ✅ Multi-auth backend
• ✅ Material Design 3 UI

v1.1 - Enhanced Automation (Q1 2026)

• Job scheduler UI
• Webhook notifications
• Prometheus exporter
• Advanced search filters

v1.2 - Integration (Q2 2026)

• NetBox plugin/sync
• REST API expansion
• Custom collection jobs
• Device driver plugins

v2.0 - Enterprise (Q3 2026)

• Multi-tenancy
• SSO integration
• Distributed monitoring
• GitOps workflows

---

Community & Support

Resources:

• 📖 Documentation
• 💬 Discussions
• 🐛 Issue Tracker
• 📧 Mailing List

Contributing: We welcome contributions! See CONTRIBUTING.md for guidelines.

Professional Support: Enterprise support and training available - contact via GitHub.

---

Related Projects

Part of the VelociTerm ecosystem:

• VelociTerm - Web SSH terminal framework
• Secure Cartography - Network discovery engine
• TerminalTelemetry - SSH automation patterns
• PyCorpus - Knowledge management (coming soon)

---

License

MIT License - See LICENSE for details.

---

Credits

Created by Scott Peterman

Built with:

• Flask & SocketIO
• Cytoscape.js
• Material Design 3
• TextFSM & Paramiko
• NetworkX & SQLite

Acknowledgments:

• NetBox Labs for community support
• Network automation community for feedback
• Contributors and early adopters

---

VelocityCMDB v1.0 - Production Ready | November 2025

---