(feature): Added automated device config backups. (#35)

(feature): Added ability to backup device configurations on a daily/weekly basis.

Author: blake-russell

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
     - name: Set up Python for formatting/linting
       uses: actions/setup-python@v4
       with:
-        python-version: '3.8'
+        python-version: '3.9'
 
     - name: Lint with flake8 (with soft fail)
       run: |

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.3.1 - 10-20-2025
+- 🆕 Inventory Config Backups: Added ability to fetch device configuration via NAPALM drivers.
+- 🆕 Inventory Config Backups: Added ability automatically backup configurations on a daily/weekly basis.
+
 ## v0.3.0 - 10-10-2025
 - 🖥️ Inventory: Re-design into single modal/page for CRUD process.
 - 🆕 Inventory Tracked Interface: Added ability to add interfaces in order to "track" for particular scripts and cards such as Statseeker

src/network_ops_dashboard/admin.py

@@ -53,6 +53,7 @@
 admin.site.register(StatseekerAlert)
 admin.site.register(DiscoveryJob)
 admin.site.register(DiscoveredDevice)
+admin.site.register(ConfigBackupSchedule)
 
 @admin.register(SiteSettings)
 class SiteSettingsAdmin(admin.ModelAdmin):

src/network_ops_dashboard/inventory/forms.py

@@ -88,4 +88,13 @@ def clean(self):
             if not password:
                 self.add_error("password", "Password is required if no API key is provided.")
 
-        return cleaned_data
+        return cleaned_data
+
+class ConfigBackupScheduleForm(forms.ModelForm):
+    class Meta:
+        model = ConfigBackupSchedule
+        fields = ["enabled", "frequency", "day_of_week", "time_of_day", "email_alerts", "alert_email", "devices"]
+        widgets = {
+            "time_of_day": forms.TimeInput(attrs={"type": "time", "class": "form-control"}),
+            "devices": forms.SelectMultiple(attrs={"class": "form-select", "size": 8}),
+        }

src/network_ops_dashboard/inventory/models.py

@@ -219,4 +219,51 @@ class Meta:
         ]
 
     def __str__(self):
-        return f"{self.device.name} {self.name}"
+        return f"{self.device.name} {self.name}"
+    
+class ConfigBackupSchedule(models.Model):
+    FREQUENCY_CHOICES = [
+        ("daily", "Daily"),
+        ("weekly", "Weekly"),
+    ]
+    DAYS_OF_WEEK = [
+        (1, "Monday"),
+        (2, "Tuesday"),
+        (3, "Wednesday"),
+        (4, "Thursday"),
+        (5, "Friday"),
+        (6, "Saturday"),
+        (0, "Sunday"),
+    ]
+
+    enabled = models.BooleanField(default=False)
+    frequency = models.CharField(max_length=10, choices=FREQUENCY_CHOICES, default="weekly")
+    day_of_week = models.IntegerField(choices=DAYS_OF_WEEK, default=0)
+    time_of_day = models.TimeField(default=timezone.now)
+    email_alerts = models.BooleanField(default=False)
+    alert_email = models.EmailField(blank=True, null=True)
+
+    # which devices to include
+    devices = models.ManyToManyField(Inventory, related_name="config_backup_targets", blank=True)
+
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return "Global Config Backup Schedule"
+
+    @property
+    def cron_key(self):
+        return "config_backup"
+
+    def ensure_cron_job(self):
+        """Create or update the single cron job."""
+        from network_ops_dashboard.scripts.cron import ensure_daily_cron, ensure_weekly_cron
+
+        if not self.enabled:
+            return
+
+        hhmm = self.time_of_day.strftime("%H:%M")
+        if self.frequency == "daily":
+            ensure_daily_cron(self.cron_key, hhmm)
+        else:
+            ensure_weekly_cron(self.cron_key, hhmm, self.day_of_week)

src/network_ops_dashboard/inventory/urls.py

@@ -28,6 +28,8 @@
     re_path(r'^edit/(?P<pk>[0-9]{1,10})/$', views.inventory_edit_modal, name='inventory_edit_modal'),
     re_path(r'^delete/(?P<pk>[0-9]{1,10})/$', views.inventory_delete_modal, name='inventory_delete_modal'),
     re_path(r'^fetch-config/(?P<pk>[0-9]{1,10})/$', views.inventory_fetch_config, name='inventory_fetch_config'),
+    re_path(r'^config-backup/save/$', views.config_backup_save, name='config_backup_save'),
+    re_path(r'^config-backup/modal/$', views.config_backup_modal, name='config_backup_modal'),
     re_path(r'^platform/$', views.platform_home, name='platform_home'),
     re_path(r'^platform/add/$', views.platform_add, name='platform_add'),
     re_path(r'^platform/edit/(?P<pk>[0-9]{1,10})/$', views.platform_edit, name='platform_edit'),

src/network_ops_dashboard/inventory/views.py

@@ -240,6 +240,37 @@ def inventory_fetch_config(request, pk):
     except Exception as e:
         return JsonResponse({"status": "error", "message": str(e)}, status=500)
 
+@login_required(login_url='/accounts/login/')
+def config_backup_modal(request):
+    from network_ops_dashboard.inventory.models import ConfigBackupSchedule, Inventory
+    from network_ops_dashboard.inventory.forms import ConfigBackupScheduleForm
+
+    cfg, _ = ConfigBackupSchedule.objects.get_or_create(pk=1)
+    form = ConfigBackupScheduleForm(instance=cfg)
+    devices = Inventory.objects.all().order_by("name")
+
+    return render(request, "network_ops_dashboard/inventory/_config_backup_modal.html", {"form": form, "cfg": cfg, "devices": devices})
+
+@require_POST
+@login_required(login_url='/accounts/login/')
+def config_backup_save(request):
+    from network_ops_dashboard.inventory.models import ConfigBackupSchedule
+    from network_ops_dashboard.inventory.forms import ConfigBackupScheduleForm
+
+    cfg, _ = ConfigBackupSchedule.objects.get_or_create(pk=1)
+    form = ConfigBackupScheduleForm(request.POST, instance=cfg)
+
+    if form.is_valid():
+        cfg = form.save()
+        cfg.ensure_cron_job()
+        response = HttpResponse(
+            "<script>window.dispatchEvent(new Event('configBackupSaved'));</script>"
+        )
+        response["HX-Trigger"] = "configBackupSaved"
+        return response
+
+    return render(request, "network_ops_dashboard/inventory/_config_backup_modal.html", {"form": form, "cfg": cfg, "devices": cfg.devices.all()})
+
 @login_required(login_url='/accounts/login/')
 def platform_home(request):
     platform_all = Platform.objects.all().order_by('name')

src/network_ops_dashboard/management/commands/collect_device_configs.py

@@ -0,0 +1,79 @@
+from django.core.management.base import BaseCommand
+from django.core.mail import send_mail
+from django.conf import settings
+import logging
+
+logger = logging.getLogger(__name__)
+
+class Command(BaseCommand):
+    help = "Collect Inventory Device Configs."
+
+    @staticmethod
+    def _email_config_backup_summary(results, cfg):
+        total = len(results)
+        failed = [r for r in results if not r.get("success")]
+        passed = [r for r in results if r.get("success")]
+        subject = "[Config Backup] All Successful" if not failed else f"[Config Backup] {len(failed)} Failures"
+
+        results_str = f"Processed {total} device config backups and {len(failed)} failed."
+        lines = [results_str, ""]
+
+        ordered = failed + passed
+        for r in ordered:
+            if r.get("success"):
+                lines.append(f"{r['device']}: OK")
+            else:
+                err = r.get("error")
+                lines.append(f"{r['device']}: FAILED" + (f" — {err}" if err else ""))
+
+        body = "\n".join(lines) + "\n"
+
+        to_email = getattr(cfg, "alert_email", "") or getattr(settings, "ADMINS", [("", "")])[0][1] or None
+        if to_email:
+            send_mail(
+                subject,
+                body,
+                getattr(settings, "DEFAULT_FROM_EMAIL", None),
+                [to_email],
+                fail_silently=True,
+            )
+
+    def handle(self, *args, **kwargs):
+        from network_ops_dashboard.inventory.models import ConfigBackupSchedule
+        from network_ops_dashboard.inventory.scripts.services import pull_device_config
+
+        cfg = ConfigBackupSchedule.objects.first()
+        if not cfg:
+            logger.warning("Config Backup: no ConfigBackupSchedule found.")
+            return
+        if not cfg.enabled:
+            logger.info("Config Backup: disabled; skipping.")
+            return
+        if not cfg.devices.exists():
+            logger.info("Config Backup: no devices enabled for config backup; skipping.")
+            return
+
+        results = []
+        logger.info("Config Backup: Backups started.")
+
+        for device in cfg.devices.all():
+            try:
+                pull_device_config(device)
+                results.append({"device": device.name, "success": True})
+                logger.info(f"Config Backup: {device.name} backup success.")
+            except Exception as e:
+                results.append({"device": device.name, "success": False})
+                logger.error(f"Config Backup: {device.name} backup failed: {e}")
+
+        failed = [r for r in results if not r["success"]]
+        logger.info(f"Config Backup: Finished. {len(results)} processed, {len(failed)} failed.")
+
+        if cfg.email_alerts:
+            if cfg.alert_email:
+                try:
+                    self._email_config_backup_summary(results, cfg)
+                    logger.info("Config Backup: Summary email sent.")
+                except Exception as e:
+                    logger.error(f"Config Backup: Email failed: {e}")
+            else:
+                logger.info(f"Config Backup: Email Alerts enabled but no email configured. Please configure email address in settings.")

src/network_ops_dashboard/scripts/cron.py

@@ -13,6 +13,7 @@
     "sdwan_vmanage_stats": "collect_sdwan_stats",
     "pagerduty_incidents": "collect_pd_incidents",
     "statseeker_alarms": "collect_statseeker_alarms",
+    "config_backup": "collect_device_configs",
 }
 
 def _job_comment(key: str) -> str:

src/network_ops_dashboard/templates/network_ops_dashboard/inventory/_config_backup_modal.html

@@ -0,0 +1,110 @@
+<div class="modal-header">
+  <h5 class="modal-title">Configuration Backup Settings</h5>
+  <button type="button" class="btn-close" data-bs-dismiss="modal"></button>
+</div>
+
+<form method="post"
+      hx-post="{% url 'config_backup_save' %}"
+      hx-target="#configBackupModal .modal-content"
+      hx-swap="outerHTML">
+  {% csrf_token %}
+  <div class="modal-body">
+
+    <div class="form-check form-switch mb-3">
+      <input class="form-check-input" type="checkbox" name="enabled" id="id_enabled"
+             {% if cfg.enabled %}checked{% endif %}>
+      <label class="form-check-label" for="id_enabled">Enable Config Backups</label>
+    </div>
+
+    <div class="row g-2">
+      <div class="col-md-6">
+        <label class="form-label">Frequency</label>
+        <select name="frequency" class="form-select" id="id_frequency">
+          <option value="daily" {% if cfg.frequency == 'daily' %}selected{% endif %}>Daily</option>
+          <option value="weekly" {% if cfg.frequency == 'weekly' %}selected{% endif %}>Weekly</option>
+        </select>
+      </div>
+
+      <div class="col-md-6">
+        <label class="form-label">Time of Day</label>
+        <input type="time" name="time_of_day" class="form-control"
+               value="{{ cfg.time_of_day|time:'H:i' }}">
+      </div>
+    </div>
+
+    <div class="mt-3">
+      <label class="form-label">Day of Week (for weekly)</label>
+      <select name="day_of_week" class="form-select">
+        {% for value, label in form.fields.day_of_week.choices %}
+          <option value="{{ value }}" {% if form.instance.day_of_week == value %}selected{% endif %}>{{ label }}</option>
+        {% endfor %}
+      </select>
+    </div>
+
+    <hr>
+
+    <div class="mb-3">
+      <div class="form-check form-switch">
+        <input class="form-check-input" type="checkbox" name="email_alerts" id="id_email_alerts"
+               {% if cfg.email_alerts %}checked{% endif %}>
+        <label class="form-check-label" for="id_email_alerts">Email Alerts</label>
+      </div>
+      <input type="email" class="form-control mt-2" name="alert_email"
+             value="{{ cfg.alert_email|default_if_none:'' }}" placeholder="Email address for alerts">
+    </div>
+
+    <hr>
+
+    <!-- Multi-select for devices -->
+    <label class="form-label">Devices to Include</label>
+    <select name="devices" multiple class="form-select" size="8">
+      {% for device in devices %}
+        <option value="{{ device.pk }}" {% if device in cfg.devices.all %}selected{% endif %}>
+          {{ device.name }}
+        </option>
+      {% endfor %}
+    </select>
+
+  </div>
+
+  <div class="modal-footer">
+    <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Cancel</button>
+    <button type="submit" class="btn btn-primary">Save</button>
+  </div>
+</form>
+
+<script>
+  document.body.addEventListener("htmx:afterSwap", (evt) => {
+    // Only re-run when the config modal was swapped
+    if (evt.detail.target.id === "configBackupModal" || evt.detail.target.closest("#configBackupModal")) {
+      const chk = document.querySelector('#configBackupModal input[name="email_alerts"]');
+      const emailField = document.querySelector('#configBackupModal input[name="alert_email"]');
+      const freqSelect = document.querySelector('#configBackupModal select[name="frequency"]');
+      const daySelect = document.querySelector('#configBackupModal select[name="day_of_week"]');
+  
+      function toggleEmailField() {
+        if (!chk || !emailField) return;
+        if (chk.checked) {
+          emailField.disabled = false;
+          emailField.placeholder = "admin@example.com";
+        } else {
+          emailField.value = "";
+          emailField.disabled = true;
+          emailField.placeholder = "(disabled)";
+        }
+      }
+  
+      function toggleDaySelect() {
+        if (!freqSelect || !daySelect) return;
+        const isWeekly = freqSelect.value === "weekly";
+        daySelect.disabled = !isWeekly;
+        if (!isWeekly) daySelect.value = "";
+      }
+  
+      toggleEmailField();
+      toggleDaySelect();
+      if (chk) chk.addEventListener("change", toggleEmailField);
+      if (freqSelect) freqSelect.addEventListener("change", toggleDaySelect);
+    }
+  });
+  </script>