Skip to main content

VPN APP

Project description

Nautobot VPN App

Nautobot VPN App Logo

CI Status PyPI Version PyPI Downloads

An App for Nautobot

Overview

A Nautobot plugin designed to model, visualize, and manage VPN infrastructure, including IPSec tunnels, IKE gateways, crypto profiles, and dynamic topology diagrams sourced from Neo4j.


Key Features

  • IKE Gateway and IPSec Tunnel modeling
  • Inline or default crypto profile selection
  • Dynamic tunnel provisioning form with interface auto-selection
  • Topology visualization via Neo4j + Cytoscape

Requirements

  • Nautobot >= 2.4.0
  • Python >= 3.8
  • Neo4j >= 5.0 (for topology view)

Installation

1. Install via pip

pip install nautobot-app-vpn

2. Enable the plugin

In your nautobot_config.py, add to PLUGINS and configure Neo4j settings:

PLUGINS = [
    "nautobot_app_vpn",
    # ...
]

PLUGINS_CONFIG = {
    "nautobot_app_vpn": {
        "neo4j": {
            "uri": "bolt://neo4j:7687",
            "user": "neo4j",
            "password": "testneo4j",  # Change this
        }
    }
}

Docker/Compose Setup (Optional)

If you are using docker-compose, include this plugin in your plugin_requirements.txt:

nautobot_app_vpn

Then rebuild Nautobot:

docker-compose build nautobot

Usage

Topology View

The plugin provides a Neo4j-powered dashboard under Plugins > VPN Dashboard, enabling visualization of active IPSec tunnels and their metadata.

Forms for Provisioning

  • Auto-select interfaces based on ISP zone tags
  • Auto-populate IPs from synced device data
  • Support dynamic IP tunnels
  • Create or select IKE/IPsec crypto profiles

Screenshots

VPN Menu

VPN Dashboard

IKE Crypto

IPsec Crypto

IKE Gateway

IPSec Tunnel

Tunnel Monitor


Development

Clone and install in editable mode:

git clone https://github.com/iss-world/nautobot-app-vpn.git
cd nautobot-app-vpn
poetry install

Run linters locally

ruff check .
yamllint .

Contributing

Pull requests are welcome! Please ensure code follows Nautobot plugin guidelines and passes all checks.


License

Apache License 2.0. See LICENSE for details.


Author

Maintained by @npolisetty26

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nautobot_app_vpn-1.0.6.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nautobot_app_vpn-1.0.6-py3-none-any.whl (3.7 MB view details)

Uploaded Python 3

File details

Details for the file nautobot_app_vpn-1.0.6.tar.gz.

File metadata

  • Download URL: nautobot_app_vpn-1.0.6.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for nautobot_app_vpn-1.0.6.tar.gz
Algorithm Hash digest
SHA256 55ad289a87aff8d99b52c88561e0d0dc1f05b8b825b9c57ce2a8efc612a63ae3
MD5 0ba420ca1c8be6c5cc89e27f0581ce01
BLAKE2b-256 824ff3197226478664c2e90d38523e0be6e8baa18bb9609812b65361cd7ea10f

See more details on using hashes here.

File details

Details for the file nautobot_app_vpn-1.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for nautobot_app_vpn-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 824c15f2395c348dda2ece5c3b3dd4b32742dcee2c07f0794cb4c60ffa99c3e2
MD5 56c040e0c02327fbe21aa4a209594cb1
BLAKE2b-256 8f718d857eb4e812940b02eb10ccec99f43f4db8713fe03097a0758cf26a5f46

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page