force the enable call to allow many cisco ios platforms to work

docs/task/task.md

@@ -102,4 +102,11 @@ class DispatcherMixin:
         if isinstance(config_context, int):
             return config_context
         return cls.tcp_port
-```
+```
+
+## Environment Variables
+
+| Environment Variable | Explanation |
+| ----- | ----------- |
+| NORNIR_NAUTOBOT_REVERT_IN_SECONDS  | Amount in seconds to revert if a config based method fails. |
+| NORNIR_NAUTOBOT_NETMIKO_ENABLE_DEFAULT | Override the default(True) to not automatically call the `enable` function before running commands. |

examples/basic_with_task.py

@@ -0,0 +1,38 @@
+"""Example with a actual dispatcher task."""
+
+import logging
+import os
+from nornir import InitNornir
+from nornir_utils.plugins.functions import print_result
+from nornir_nautobot.plugins.tasks.dispatcher import dispatcher
+
+
+LOGGER = logging.getLogger(__name__)
+
+my_nornir = InitNornir(
+    inventory={
+        "plugin": "NautobotInventory",
+        "options": {
+            "nautobot_url": "http://localhost:8080/",
+            "nautobot_token": "0123456789abcdef0123456789abcdef01234567",
+            "filter_parameters": {"location": "Site 1"},
+            "ssl_verify": False,
+        },
+    },
+)
+my_nornir.inventory.defaults.username = os.getenv("NORNIR_USERNAME")
+my_nornir.inventory.defaults.password = os.getenv("NORNIR_PASSWORD")
+
+for nr_host, nr_obj in my_nornir.inventory.hosts.items():
+    network_driver = my_nornir.inventory.hosts[nr_host].platform
+    result = my_nornir.run(
+        task=dispatcher,
+        logger=LOGGER,
+        method="get_config",
+        obj=nr_host,
+        framework="netmiko",
+        backup_file="./ios.cfg",
+        remove_lines=None,
+        substitute_lines=None,
+    )
+    print_result(result)

nornir_nautobot/plugins/tasks/dispatcher/default.py

@@ -23,9 +23,8 @@
 from nornir_jinja2.plugins.tasks import template_file
 from nornir_napalm.plugins.tasks import napalm_configure, napalm_get
 from nornir_netmiko.tasks import netmiko_send_command
-
 from nornir_nautobot.exceptions import NornirNautobotException
-from nornir_nautobot.utils.helpers import make_folder
+from nornir_nautobot.utils.helpers import make_folder, is_truthy
 
 _logger = logging.getLogger(__name__)
 
@@ -459,7 +458,11 @@ def get_config(
         command = cls.config_command
 
         try:
-            result = task.run(task=netmiko_send_command, command_string=command)
+            result = task.run(
+                task=netmiko_send_command,
+                command_string=command,
+                enable=is_truthy(os.getenv("NORNIR_NAUTOBOT_NETMIKO_ENABLE_DEFAULT", default="True")),
+            )
         except NornirSubTaskError as exc:
             if isinstance(exc.result.exception, NetmikoAuthenticationException):
                 error_msg = f"`E1017:` Failed with an authentication issue: `{exc.result.exception}`"

nornir_nautobot/utils/helpers.py

@@ -31,3 +31,25 @@ def import_string(dotted_path):
         return getattr(importlib.import_module(module_name), class_name)
     except (ModuleNotFoundError, AttributeError):
         return None
+
+
+def is_truthy(arg):
+    """Convert "truthy" strings into Booleans.
+
+    Args:
+        arg (str): Truthy string (True values are y, yes, t, true, on and 1; false values are n, no,
+        f, false, off and 0. Raises ValueError if val is anything else.
+
+    Examples:
+        >>> is_truthy('yes')
+        True
+    """
+    if isinstance(arg, bool):
+        return arg
+
+    val = str(arg).lower()
+    if val in ("y", "yes", "t", "true", "on", "1"):
+        return True
+    if val in ("n", "no", "f", "false", "off", "0"):
+        return False
+    return True