Version 2.1.0

Author: miaow2

.github/workflows/commit.yaml

@@ -21,8 +21,8 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install --upgrade setuptools wheel
           python -m pip install -r requirements/dev.txt
-      - name: Run black
-        run: black --check --diff --color .
+      - name: Run ruff format
+        run: ruff format .
       - name: Run ruff
         run: ruff .
 

.pre-commit-config.yaml

@@ -5,13 +5,10 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
-    hooks:
-      - id: black
-        args: [--check, --diff, --color, .]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.280
+    rev: v0.1.2
     hooks:
       - id: ruff
         args: [netbox_config_diff]
+      - id: ruff-format
+        exclude: migrations

README.md

@@ -1,7 +1,6 @@
 [![NetBox version](https://img.shields.io/badge/NetBox-3.5|3.6-blue.svg)](https://github.com/netbox-community/netbox)
 [![Supported Versions](https://img.shields.io/pypi/pyversions/netbox-config-diff.svg)](https://pypi.org/project/netbox-config-diff/)
 [![PyPI version](https://badge.fury.io/py/netbox-config-diff.svg)](https://badge.fury.io/py/netbox-config-diff)
-[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![CI](https://github.com/miaow2/netbox-config-diff/actions/workflows/commit.yaml/badge.svg?branch=develop)](https://github.com/miaow2/netbox-config-diff/actions)
@@ -78,6 +77,7 @@ PLUGINS_CONFIG = {
     "netbox_config_diff": {
         "USERNAME": "foo",
         "PASSWORD": "bar",
+        "AUTH_SECONDARY": "foobar",  # define here password for accessing Privileged EXEC mode, this variable is optional
     },
 }
 ```
@@ -120,6 +120,14 @@ No diff
 
 ![Screenshot of the compliance ok](docs/media/screenshots/compliance-ok.png)
 
+Configuration request
+
+![Screenshot of the CR](docs/media/screenshots/cr-created.png)
+
+Completed Configuration request
+
+![Screenshot of the completed CR](docs/media/screenshots/cr-completed.png)
+
 ## Credits
 
 Based on the NetBox plugin tutorial:

docs/changelog.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.1.0 (2023-10-26)
+
+* [#35](https://github.com/miaow2/netbox-config-diff/issues/35) Add ability to define password for accessing priviliged exec mode
+* [#37](https://github.com/miaow2/netbox-config-diff/issues/37) Add `DeviceRole` field to `CollectDiffScript`
+* [#38](https://github.com/miaow2/netbox-config-diff/issues/38) Remove config template filter for devices filed in forms
+* [#39](https://github.com/miaow2/netbox-config-diff/issues/39) Add `Status` field to `CollectDiffScript`
+* [#43](https://github.com/miaow2/netbox-config-diff/issues/43) `ConfigDiffScript` does not create empty changelog entries
+
+## 2.0.1 (2023-10-22)
+
+* [#33](https://github.com/miaow2/netbox-config-diff/issues/33) Fix failing migrations on fresh database install
+
 ## 2.0.0 (2023-10-18)
 
 * [#25](https://github.com/miaow2/netbox-config-diff/issues/25) Add configuration management

docs/colliecting-diffs.md

@@ -28,11 +28,11 @@ You can find scripts list in navbar `Customization -> Scripts`.
 
 ![Screenshot of the scripts list](media/screenshots/script-list.png)
 
-In the script, you can define a site, on which devices run compliance, or devices.
- If you define both fields, script will run only on devices from `Devices` field
+In the script, you can define a site or role, on which devices run compliance, or devices.
+ If you define all fields, script will run only on devices from `Devices` field
 
 !!! warning
-    Script runs only on devices with status `Active`, assigned Primary IP, Config Template, Platform and PlatformSetting
+    Script runs only on devices with assigned Primary IP, Platform and PlatformSetting
 
 If you have configs in NetBox DataSource, you can define it, the script instead of connecting to devices will find configs in DataSource by device's names.
 

docs/configuratiom-management.md

@@ -59,7 +59,7 @@ And rendered config template with substitute
 Now you let's create `Configuration Request` with devices you want to configure.
 
 !!! warning
-    For request only accepts devices with `Active` status and assigned Platform, Primary IP, Config Template and PlatformSetting
+    For request only accepts devices with `Active` status and assigned Platform, Primary IP, and PlatformSetting
 
 Find `Configuration Requests` in navbar.
 

docs/media/screenshots/cr-completed.png

@@ -4,7 +4,8 @@ You can store credentials for devices authentification in NetBox secrets [plugin
 
 Read NetBox secrets docs for more info.
 
-In plugin variables define secrets roles for username (`USER_SECRET_ROLE`) and password (`PASSWORD_SECRET_ROLE`).
+In plugin variables define secrets roles for username (`USER_SECRET_ROLE`), password (`PASSWORD_SECRET_ROLE`) and
+ password (`SECOND_AUTH_SECRET_ROLE`) for Privileged EXEC mode.
 
 Default values for this variables are:
 
@@ -13,6 +14,7 @@ PLUGINS_CONFIG = {
     "netbox_config_diff": {
         "USER_SECRET_ROLE": "Username",
         "PASSWORD_SECRET_ROLE": "Password",
+        "SECOND_AUTH_SECRET_ROLE": "Second Auth",
     },
 }
 ```