Closes #35: Add ability to define password for accessing priviliged exec mode

Author: miaow2

README.md

@@ -77,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
     },
 }
 ```
@@ -119,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/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",
     },
 }
 ```

docs/media/screenshots/cr-created.png

@@ -2,7 +2,7 @@
 
 __author__ = "Artem Kotik"
 __email__ = "miaow2@yandex.ru"
-__version__ = "2.0.1"
+__version__ = "2.1.0"
 
 
 class ConfigDiffConfig(PluginConfig):
@@ -18,6 +18,7 @@ class ConfigDiffConfig(PluginConfig):
     default_settings = {
         "USER_SECRET_ROLE": "Username",
         "PASSWORD_SECRET_ROLE": "Password",
+        "SECOND_AUTH_SECRET_ROLE": "Second Auth",
     }
 
 

docs/secrets.md

@@ -124,7 +124,7 @@ def get_devices_with_rendered_configs(self, devices: Iterable[Device]) -> Iterat
         self.check_netbox_secrets()
         self.substitutes = {}
         for device in devices:
-            username, password = self.get_credentials(device)
+            username, password, auth_secondary = self.get_credentials(device)
             rendered_config = None
             error = None
             context_data = device.get_config_context()
@@ -152,6 +152,7 @@ def get_devices_with_rendered_configs(self, devices: Iterable[Device]) -> Iterat
                 exclude_regex=device.platform.platform_setting.exclude_regex,
                 username=username,
                 password=password,
+                auth_secondary=auth_secondary,
                 rendered_config=rendered_config,
                 error=error,
             )

netbox_config_diff/__init__.py

@@ -37,7 +37,7 @@ def __init__(self, devices: Iterable[Device], request: NetBoxFakeRequest) -> Non
     def validate_devices(self) -> None:
         self.check_netbox_secrets()
         for device in self.devices:
-            username, password = self.get_credentials(device)
+            username, password, auth_secondary = self.get_credentials(device)
             if device.platform.platform_setting is None:
                 self.logger.log_warning(f"Skipping {device}, add PlatformSetting for {device.platform} platform")
             elif device.platform.platform_setting.driver not in ACCEPTABLE_DRIVERS:
@@ -66,6 +66,7 @@ def validate_devices(self) -> None:
                     platform=device.platform.platform_setting.driver,
                     username=username,
                     password=password,
+                    auth_secondary=auth_secondary,
                     rendered_config=rendered_config,
                     error=error,
                 )