Release v3.4.0

.cookiecutter.json

@@ -21,7 +21,7 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.4.0",
+            "template_ref": "refs/tags/nautobot-app-v2.4.1",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
@@ -30,7 +30,7 @@
                 "poetry"
             ],
             "draft": false,
-            "baked_commit_ref": "671ef8a64a7bc40e991ade1dd64560d734f122bc"
+            "baked_commit_ref": "1c99457b09d05553ef7193e0dda021b2d1caa407"
         }
     }
 }

.github/CODEOWNERS

@@ -9,6 +9,9 @@
 /nautobot_ssot/integrations/infoblox/ @qduk @jdrew82 @nautobot/plugin-ssot
 /nautobot_ssot/integrations/ipfabric/ @alhogan @nautobot/plugin-ssot
 /nautobot_ssot/integrations/itential/ @jtdub @nautobot/plugin-ssot
+/nautobot_ssot/integrations/librenms/ @bile0026 @nautobot/plugin-ssot
 /nautobot_ssot/integrations/meraki/ @jdrew82 @nautobot/plugin-ssot
 /nautobot_ssot/integrations/servicenow/ @glennmatthews @qduk @nautobot/plugin-ssot
 /nautobot_ssot/integrations/slurpit/ @lpconsulting321 @pietos @nautobot/plugin-ssot
+/nautobot_ssot/integrations/solarwinds/ @jdrew82 @nopg @nautobot/plugin-ssot
+

.github/workflows/ci.yml

@@ -25,6 +25,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: ruff format"
         run: "poetry run invoke ruff --action format"
   ruff-lint:
@@ -36,6 +38,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: ruff"
         run: "poetry run invoke ruff --action lint"
   check-docs-build:
@@ -47,6 +51,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Check Docs Build"
         run: "poetry run invoke build-and-check-docs"
   poetry:
@@ -58,6 +64,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Checking: poetry lock file"
         run: "poetry run invoke lock --check"
   yamllint:
@@ -69,6 +77,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: yamllint"
         run: "poetry run invoke yamllint"
   check-in-docker:
@@ -91,6 +101,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Constrain Nautobot version and regenerate lock file"
         env:
           INVOKE_NAUTOBOT_SSOT_LOCAL: "true"
@@ -146,6 +158,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Constrain Nautobot version and regenerate lock file"
         env:
           INVOKE_NAUTOBOT_SSOT_LOCAL: "true"
@@ -187,6 +201,8 @@ jobs:
           fetch-depth: "0"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Check for changelog entry"
         run: |
           git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}

LICENSE

@@ -1,6 +1,6 @@
 Apache Software License 2.0
 
-Copyright (c) 2024, Network to Code, LLC
+Copyright (c) 2025, Network to Code, LLC
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -35,9 +35,11 @@ This Nautobot application framework includes the following integrations:
 - Infoblox
 - IPFabric
 - Itential
+- LibreNMS
 - Cisco Meraki
 - ServiceNow
 - Slurpit
+- SolarWinds
 
 Read more about integrations [here](https://docs.nautobot.com/projects/ssot/en/latest/user/integrations). To enable and configure integrations follow the instructions from [the install guide](https://docs.nautobot.com/projects/ssot/en/latest/admin/install/#integrations-configuration).
 
@@ -92,9 +94,11 @@ The SSoT framework includes a number of integrations with external Systems of Re
 * Cisco DNA Center
 * Infoblox
 * Itential
+* LibreNMS
 * Cisco Meraki
 * ServiceNow
 * Slurpit
+* SolarWinds
 
 > Note that the Arista CloudVision integration is currently incompatible with the [Arista Labs](https://labs.arista.com/) environment due to a TLS issue. It has been confirmed to work in on-prem environments previously.
 

development/creds.example.env

@@ -36,6 +36,9 @@ NAUTOBOT_SSOT_CITRIX_ADM_PASSWORD="changeme"
 
 NAUTOBOT_SSOT_INFOBLOX_PASSWORD="changeme"
 
+NAUTOBOT_SSOT_SOLARWINDS_USERNAME="admin"
+NAUTOBOT_SSOT_SOLARWINDS_PASSWORD="changeme"
+
 # ACI Credentials.  Append friendly name to the end to identify each APIC. 
 NAUTOBOT_APIC_BASE_URI_NTC=https://aci.cloud.networktocode.com
 NAUTOBOT_APIC_USERNAME_NTC=admin

development/development.env

@@ -115,4 +115,12 @@ IPFABRIC_TIMEOUT=15
 NAUTOBOT_SSOT_ENABLE_ITENTIAL="True"
 
 NAUTOBOT_SSOT_ENABLE_SLURPIT="False"
-SLURPIT_HOST="https://sandbox.slurpit.io"
+SLURPIT_HOST="https://sandbox.slurpit.io"
+
+
+NAUTOBOT_SSOT_ENABLE_LIBRENMS="False"
+NAUTOBOT_SSOT_LIBRENMS_SYSTEM_OF_RECORD="LibreNMS"
+NAUTOBOT_SSOT_LIBRENMS_HOSTNAME_FIELD="sysName" # hostname or sysName
+
+NAUTOBOT_SSOT_ENABLE_SOLARWINDS="False"
+

development/docker-compose.dev.yml

@@ -45,10 +45,12 @@ services:
     volumes:
       - "./nautobot_config.py:/opt/nautobot/nautobot_config.py"
       - "../:/source"
-# To expose postgres or redis to the host uncomment the following
-# postgres:
+# To expose postgres (5432), myql (3306) on db service or redis (6379) to the host uncomment the
+# following. Ensure to match the 2 idented spaces which to have the service nested under services.
+# db:
 #   ports:
 #     - "5432:5432"
+#     - "3306:3306"
 # redis:
 #   ports:
 #     - "6379:6379"

development/docker-compose.mysql.yml

@@ -14,6 +14,13 @@ services:
       - "development.env"
       - "creds.env"
       - "development_mysql.env"
+  beat:
+    environment:
+      - "NAUTOBOT_DB_ENGINE=django.db.backends.mysql"
+    env_file:
+      - "development.env"
+      - "creds.env"
+      - "development_mysql.env"
   db:
     image: "mysql:8"
     command:

development/nautobot_config.py

@@ -4,7 +4,7 @@
 import sys
 
 from nautobot.core.settings import *  # noqa: F403  # pylint: disable=wildcard-import,unused-wildcard-import
-from nautobot.core.settings_funcs import is_truthy, parse_redis_connection
+from nautobot.core.settings_funcs import is_truthy
 
 #
 # Debug
@@ -65,16 +65,8 @@
 #
 
 # The django-redis cache is used to establish concurrent locks using Redis.
-CACHES = {
-    "default": {
-        "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": parse_redis_connection(redis_database=0),
-        "TIMEOUT": 300,
-        "OPTIONS": {
-            "CLIENT_CLASS": "django_redis.client.DefaultClient",
-        },
-    }
-}
+# Inherited from nautobot.core.settings
+# CACHES = {....}
 
 #
 # Celery settings are not defined here because they can be overloaded with
@@ -229,9 +221,11 @@
         "enable_infoblox": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_INFOBLOX")),
         "enable_ipfabric": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_IPFABRIC")),
         "enable_itential": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_ITENTIAL")),
+        "enable_librenms": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_LIBRENMS", "false")),
         "enable_meraki": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_MERAKI")),
         "enable_servicenow": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_SERVICENOW")),
         "enable_slurpit": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_SLURPIT")),
+        "enable_solarwinds": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_SOLARWINDS")),
         "hide_example_jobs": is_truthy(os.getenv("NAUTOBOT_SSOT_HIDE_EXAMPLE_JOBS")),
         "device42_defaults": {
             "site_status": "Active",

docs/admin/install.md

@@ -97,6 +97,8 @@ Set up each integration using the specific guides:
 - [Infoblox](./integrations/infoblox_setup.md)
 - [IPFabric](./integrations/ipfabric_setup.md)
 - [Itential](./integrations/itential_setup.md)
+- [LibreNMS](./integrations/librenms_setup.md)
 - [Cisco Meraki](./integrations/meraki_setup.md)
 - [ServiceNow](./integrations/servicenow_setup.md)
 - [Slurpit](./integrations/slurpit_setup.md)
+- [SolarWinds](./integrations/solarwinds_setup.md)

docs/admin/integrations/index.md

@@ -11,6 +11,8 @@ This Nautobot app supports the following integrations:
 - [Infoblox](./infoblox_setup.md)
 - [IPFabric](./ipfabric_setup.md)
 - [Itential](./itential_setup.md)
+- [LibreNMS](./librenms_setup.md)
 - [Cisco Meraki](./meraki_setup.md)
 - [ServiceNow](./servicenow_setup.md)
 - [Slurpit](./slurpit_setup.md)
+- [SolarWinds](./solarwinds_setup.md)

docs/admin/integrations/librenms_setup.md

@@ -0,0 +1,46 @@
+# LibreNMS
+
+## Description
+
+This App will sync data from the LibreNMS API into Nautobot to create Device and IPAM inventory items. Most items will receive a custom field associated with them called "System of Record", which will be set to "LibreNMS" (or whatever you set the `NAUTOBOT_SSOT_LIBRENMS_SYSTEM_OF_RECORD` environment variable to). These items are then the only ones managed by the LibreNMS SSoT App. Other items within the Nautobot instance will not be affected unless there's items with overlapping names. If an item exists in Nautobot by it's identifiers but it does not have the "System of Record" custom field on it, the item will be updated with "LibreNMS" (or `NAUTOBOT_SSOT_LIBRENMS_SYSTEM_OF_RECORD` environment variable value) when the App runs. This way no duplicates are created, and the App will not delete any items that are not defined in the LibreNMS API data but were manually created in Nautobot.
+
+## Installation
+
+Before configuring the integration, please ensure, that `nautobot-ssot` app was [installed with LibreNMS integration extra dependencies](../install.md#install-guide).
+
+```shell
+pip install nautobot-ssot[librenms]
+```
+
+## Configuration
+
+Once the SSoT package has been installed you simply need to enable the integration by setting `enable_librenms` to True.
+
+```python
+PLUGINS = ["nautobot_ssot"]
+
+PLUGINS_CONFIG = {
+  "nautobot_ssot": {
+        # Other nautobot_ssot settings ommitted.
+        "enable_librenms": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_LIBRENMS", "true")),
+  }
+}
+```
+
+### External Integrations
+
+#### LibreNMS as DataSource
+
+The way you add your LibreNMS server instance is through the "External Integrations" objects in Nautobot. First, create a secret in Nautobot with your LibreNMS API token using an Environment Variable (or sync via secrets provider). Then create a SecretsGroup object and select the Secret you just created and set the Access Type to `HTTP(S)` and the Secret Type to `Token`.
+
+Once this is created, go into the Extensibility Menu and select `External Integrations`. Add an External Intergration with the Remote URL being your LibreNMS server URL (including http(s)://), set the method to `GET`, and select any other headers/settings you might need for your specific instance. Select the secrets group you created as this will inject the API token. Once created, you will select this External Integration when you run the LibreNMS to Nautobot SSoT job.
+
+![LibreNMS External Integration](../../images/librenms-external-integration.png)
+
+#### LibreNMS as DataTarget
+
+NotYetImplemented
+
+### LibreNMS API
+
+An API key with global read-only permissions is the minimum needed to sync information from LibreNMS.

docs/admin/integrations/solarwinds_setup.md

@@ -0,0 +1,25 @@
+# SolarWinds Integration Setup
+
+This guide will walk you through steps to set up the SolarWinds integration with the `nautobot_ssot` app.
+
+## Prerequisites
+
+Before configuring the integration, please ensure, that `nautobot-ssot` app was [installed with the SolarWinds integration extra dependencies](../install.md#install-guide).
+
+```shell
+pip install nautobot-ssot[solarwinds]
+```
+
+## Configuration
+
+Access to your SolarWinds instance is defined using the [ExternalIntegration](https://docs.nautobot.com/projects/core/en/stable/user-guide/platform-functionality/externalintegration/) model which allows you to utilize this integration with multiple instances concurrently. Please bear in mind that it will synchronize all data 1:1 with the specified instance to match exactly, meaning it will delete data missing from an instance. Each ExternalIntegration must specify a SecretsGroup with [Secrets](https://docs.nautobot.com/projects/core/en/stable/user-guide/platform-functionality/secret/) that contain the SolarWinds administrator Username and Password to authenticate with. You can find Secrets and SecretsGroups available under the Secrets menu.
+
+Below is an example snippet from `nautobot_config.py` that demonstrates how to enable the SolarWinds integration:
+
+```python
+PLUGINS_CONFIG = {
+    "nautobot_ssot": {
+        "enable_solarwinds": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_SOLARWINDS", "true")),
+    }
+}
+```

docs/admin/release_notes/version_3.4.md

@@ -0,0 +1,39 @@
+
+# v3.4 Release Notes
+
+This document describes all new features and changes in the release. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Release Overview
+
+This release adds two new integrations to the project, one for Solarwinds Orion and one for LibreNMS! There are also a lot of bug fixes for various integrations.
+
+## [v3.4.0 (2025-01-14)](https://github.com/nautobot/nautobot-app-ssot/releases/tag/v3.4.0)
+
+### Added
+
+- [#631](https://github.com/nautobot/nautobot-app-ssot/issues/631) - Added integration with SolarWinds.
+- [#636](https://github.com/nautobot/nautobot-app-ssot/issues/636) - Added LibreNMS integration.
+
+### Documentation
+
+- [#631](https://github.com/nautobot/nautobot-app-ssot/issues/631) - Added documentation for SolarWinds integration.
+
+### Fixed
+
+- [#597](https://github.com/nautobot/nautobot-app-ssot/issues/597) - Fixed ACI integration LocationType usage in CRUD operations to match Job device_site or specified APIC Location's LocationType.
+- [#598](https://github.com/nautobot/nautobot-app-ssot/issues/598) - Swapped out `nautobot.extras.plugins.PluginTemplateExtension` for `TemplateExtension`
+- [#621](https://github.com/nautobot/nautobot-app-ssot/issues/621) - Fixed ASN updates on Location objects.
+- [#621](https://github.com/nautobot/nautobot-app-ssot/issues/621) - Fixed documentation on data normalization.
+- [#624](https://github.com/nautobot/nautobot-app-ssot/issues/624) - Fixed Floors respecting location map for Building related changes.
+- [#626](https://github.com/nautobot/nautobot-app-ssot/issues/626) - Fixed SoftwareVersion update on Devices in DNA Center integration.
+- [#634](https://github.com/nautobot/nautobot-app-ssot/issues/634) - Fixed load locations on the source adapter for the ServiceNow integration when a site filter is applied.
+- [#641](https://github.com/nautobot/nautobot-app-ssot/issues/641) - Fixed incorrectly nested imports within if block used for Device Lifecycle Models.
+- [#643](https://github.com/nautobot/nautobot-app-ssot/issues/643) - Fixed DNA Center bug where empty Locations were imported.
+- [#646](https://github.com/nautobot/nautobot-app-ssot/issues/646) - Fixed IPAddress assigned wrong parent Prefix in Citrix ADM.
+- [#648](https://github.com/nautobot/nautobot-app-ssot/issues/648) - Fixed Citrix ADM deleting SoftwareVersion in use with ValidatedSoftware.
+- [#648](https://github.com/nautobot/nautobot-app-ssot/issues/648) - Fixed Meraki deleting SoftwareVersion in use with ValidatedSoftware.
+- [#650](https://github.com/nautobot/nautobot-app-ssot/issues/650) - Fixed Device floor name being incorrectly defined and including Building name when it shouldn't.
+
+### Housekeeping
+
+- [#1](https://github.com/nautobot/nautobot-app-ssot/issues/1) - Rebaked from the cookie `nautobot-app-v2.4.1`.

docs/user/integrations/bootstrap.md

@@ -19,6 +19,10 @@ NotYetImplemented
 
 ### Data structures
 
+### General Notes on Data in the YAML file
+
+Data values are generally normalized in the app code. If a value is supposed to be a string and you want it to be blank or none, include a blank string (`""`) in the value. Integers should be left completely blank. Lists should be set to an empty list (`[]`), and dictionaries should be set to a blank dictionary (`{}`) in the yaml file.
+
 #### global_settings.yml (see '../bootstrap/fixtures/global_settings.yml for examples of supported models)
 
 ```yaml

docs/user/integrations/index.md

@@ -11,6 +11,8 @@ This Nautobot app supports the following integrations:
 - [Infoblox](./infoblox.md)
 - [IPFabric](./ipfabric.md)
 - [Itential](./itential.md)
+- [LibreNMS](./librenms.md)
 - [Cisco Meraki](./meraki.md)
 - [ServiceNow](./servicenow.md)
 - [Slurpit](./slurpit.md)
+- [SolarWinds](./solarwinds.md)