netbox-ninja-plugin 0.1.4

Dynamic configuration files and images from NetBox.

Netbox Ninja Plugin

A NetBox plugin for generating dynamic text files and images using Jinja2 templates.

Overview

Netbox Ninja Plugin enables dynamic content generation in NetBox through Jinja2 templates. It supports both text file generation and SVG image creation from draw.io XML templates, seamlessly integrating with NetBox's data model.

Note: This plugin is currently in beta. While it's functional, some features are still under development and the API may change in future releases.

Key Features

• Dynamic text file generation using Jinja2 templates
• Template-based SVG image generation from draw.io XML format
• Direct integration with NetBox's data model
• REST API endpoints for template management
• Support for object-specific template rendering

Requirements

• NetBox v4.2.7 or later
• drawio-export-api Docker container (optional, required for image generation)

Quick Start

1. Install the plugin:

pip install netbox-ninja-plugin

2. Add to NetBox configuration:

PLUGINS = [
    'netbox_ninja_plugin',
]

3. Configure the plugin (see CONFIGURATION.md for detailed options):

PLUGINS_CONFIG = {
    "netbox_ninja_plugin": {
        "target_models": {
            "dcim": ["device", "interface", "site", "region"],
            "ipam": ["prefix"],
        },
        "jinja_model_querysets": {
            "dcim": ["device", "interface", "site", "region"],
            "ipam": ["prefix"],
        },
        "drawio_export_api": {
            "url": "https://drawio-export-api:443/svg",
            "token": "your-token",
            "pem_file_path": "/path/to/drawio_export_api.pem",
            "verify_tls": True,
            "timeout": 60,
        },
    }
}

Usage

Template Creation

1. Navigate to NetBox's Ninja Templates section
2. Create a new template with:
   • Name: Template identifier
   • Output type: Text or Draw.io format
   • Object types: NetBox objects to associate with the template
   • Template code: Your Jinja2 template

Template Variables

• Access NetBox objects using object queries, e.g. {{ sites.first() }} or {{ regions.get(slug='region1') }}
• For object-specific templates, use {{ target_object }} to reference the current object

For detailed examples and use cases, see EXAMPLES.md.

Security Note

The plugin currently doesn't enforce object-level permissions in templates. Exercise caution when exposing data through templates, as users may access data beyond their normal permissions.

Documentation

• Examples - Detailed usage examples and tutorials
• Configuration - Detailed configuration options and examples

License

This project is licensed under the MIT License - see the LICENSE file for details.