Add variable for SSH config file (#107)

Author: miaow2

README.md

@@ -87,6 +87,7 @@ PLUGINS_CONFIG = {
         "USERNAME": "foo",
         "PASSWORD": "bar",
         "AUTH_SECONDARY": "foobar",  # define here password for accessing Privileged EXEC mode, this variable is optional
+        "PATH_TO_SSH_CONFIG_FILE": "/home/.ssh/config",  # define here PATH to SSH config file, it will be used for device connections, this variable is optional
     },
 }
 ```

netbox_config_diff/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = "Artem Kotik"
 __email__ = "[email protected]"
-__version__ = "2.11.0"
+__version__ = "2.12.0"
 
 
 class ConfigDiffConfig(PluginConfig):
@@ -19,6 +19,7 @@ class ConfigDiffConfig(PluginConfig):
         "USER_SECRET_ROLE": "Username",
         "PASSWORD_SECRET_ROLE": "Password",
         "SECOND_AUTH_SECRET_ROLE": "Second Auth",
+        "PATH_TO_SSH_CONFIG_FILE": "",
     }
 
 

netbox_config_diff/models/data_models.py

@@ -2,6 +2,7 @@
 from dataclasses import dataclass
 
 from dcim.models import Device
+from netbox.plugins import get_plugin_config
 from scrapli import AsyncScrapli
 
 from netbox_config_diff.choices import ConfigComplianceStatusChoices
@@ -35,7 +36,7 @@ def __str__(self) -> str:
         return self.name
 
     def to_scrapli(self) -> dict:
-        return {
+        sccrapli_dict = {
             "host": self.mgmt_ip,
             "auth_username": self.username,
             "auth_password": self.password,
@@ -82,6 +83,12 @@ def to_scrapli(self) -> dict:
             },
         }
 
+        ssh_config = get_plugin_config("netbox_config_diff", "PATH_TO_SSH_CONFIG_FILE")
+        if ssh_config:
+            sccrapli_dict["ssh_config_file"] = ssh_config
+
+        return sccrapli_dict
+
     def get_status(self) -> str:
         if self.error:
             return ConfigComplianceStatusChoices.ERRORED