convert to native netmiko task runner

Author: jtdub

netnir/core/inventory.py

@@ -21,7 +21,6 @@ def __init__(self, **kwargs):
         )
 
     def nhosts(self):
-        from netnir.helpers import device_mapper
         from netnir.core.credentials import Credentials
         from netnir.constants import (
             HOSTVARS,
@@ -47,7 +46,7 @@ def nhosts(self):
                 "username": host_vars.get("username", creds["username"]),
                 "password": host_vars.get("password", creds["password"]),
                 "port": host_vars.get("port", 22),
-                "platform": device_mapper(host_vars["os"]),
+                "platform": host_vars["os"],
                 "groups": host_vars.get("groups", list()),
                 "data": {
                     **host_vars,
@@ -61,18 +60,6 @@ def nhosts(self):
                     ),
                     "mgmt_protocol": host_vars.get("mgmt_protocol", "ssh"),
                 },
-                "connection_options": {
-                    "netconf": {
-                        "hostname": f"{host}.{domain}" if domain else host,
-                        "username": host_vars.get("username", creds["username"]),
-                        "password": host_vars.get("password", creds["password"]),
-                        "platform": device_mapper(
-                            os_type=host_vars["os"], proto="netconf"
-                        ),
-                        "port": host_vars.get("port", 830),
-                        "extras": {"hostkey_verify": False},
-                    },
-                },
             }
 
         return data

netnir/core/networking.py

@@ -1,6 +1,6 @@
 from netnir.helpers.scaffold.command import CommandScaffold
 from netnir.core.template import CompileTemplate
-from netnir.core.networking import Networking
+from netnir.plugins.netmiko import netmiko_send_commands
 from netnir.helpers import output_writer, TextColor
 from netnir.plugins.hier import hier_host
 from netnir.constants import OUTPUT_DIR
@@ -72,10 +72,13 @@ def run(self, template_file="main.conf.j2"):
             message = TextColor.green("templates compiled for all hosts")
             return logging.info(message)
 
-        networking = Networking(nr=self.nr)
-        running_config = networking.fetch(commands="show running")
-        output_writer(nornir_results=running_config, output_file="running.conf")
-        print_result(running_config)
+        results = self.nr(
+            task=netmiko_send_commands,
+            commands="show running",
+            name="FETCH RUNNING CONFIG",
+        )
+        output_writer(nornir_results=results, output_file="running.conf")
+        print_result(results)
 
         result = self.nr.run(
             task=hier_host,
@@ -85,6 +88,7 @@ def run(self, template_file="main.conf.j2"):
             compiled_config="compiled.conf",
             config_path=OUTPUT_DIR,
             load_file=True,
+            name="RENDER REMEDIATION CONFIG",
         )
 
         print_result(result)

netnir/core/tasks/config_plan.py

@@ -1,7 +1,7 @@
 from netnir.helpers.scaffold.command import CommandScaffold
 from netnir.helpers.common.args import num_workers
 from netnir.helpers import output_writer
-from netnir.core.networking import Networking
+from netnir.plugins.netmiko import netmiko_send_commands
 from nornir.plugins.functions.text import print_result
 
 """fetch remove device configs"""
@@ -28,8 +28,7 @@ def run(self):
         """
 
         self.nr = self._inventory()
-        networking = Networking(nr=self.nr, num_workers=self.args.workers)
-        results = networking.fetch(commands="show running")
+        results = self.nr.run(task=netmiko_send_commands, commands="show running")
         output_writer(nornir_results=results, output_file="running.conf")
 
         return print_result(results)

netnir/core/tasks/fetch/config.py

@@ -1,14 +1,12 @@
 from netnir.helpers.scaffold.command import CommandScaffold
-from netnir.core.networking import Networking
+from netnir.plugins.netmiko import netmiko_send_commands, netmiko_send_config
 from netnir.helpers import output_writer
 from netnir.helpers.common.args import (
     output,
-    num_workers,
     commands,
     config,
 )
 from nornir.plugins.functions.text import print_result
-import sys
 
 """ssh cli commands"""
 
@@ -25,7 +23,6 @@ def parser(parser):
         """
         CommandScaffold.parser(parser)
         output(parser)
-        num_workers(parser)
         commands(parser)
         config(parser)
 
@@ -35,14 +32,19 @@ def run(self):
         """
 
         self.nr = self._inventory()
-        networking = Networking(nr=self.nr, num_workers=self.args.workers,)
 
         if self.args.config:
-            results = networking.config(self.args.commands)
-        elif self.args.commands:
-            results = networking.fetch(self.args.commands)
+            results = self.nr.run(
+                task=netmiko_send_config,
+                commands=self.args.commands,
+                name="SSH CONFIG EXECUTION",
+            )
         else:
-            sys.exit()
+            results = self.nr.run(
+                task=netmiko_send_commands,
+                commands=self.args.commands,
+                name="SSH COMMAND EXECUTION",
+            )
 
         if isinstance(results, str):
             results = [results]

netnir/core/tasks/ssh.py

@@ -0,0 +1,55 @@
+from nornir.core.task import Task, Result
+from netmiko import ConnectHandler
+from netnir.helpers import device_mapper
+
+"""netmiko (SSH) nornir tasks"""
+
+
+def netmiko_send_commands(task: Task, commands: list()):
+    """send show commands to a device via netmiko
+
+    :param task: nornir Task object
+    :param commands: a list of commands to execute
+
+    :returns: nornir Result object
+    """
+    device_params = {
+        "host": task.host.hostname,
+        "device_type": device_mapper(os_type=task.host.platform, proto="netmiko"),
+        "port": task.host.port,
+        "username": task.host.username,
+        "password": task.host.password,
+        "secret": task.host.connection_options["netmiko"]["extras"].get("secret", None),
+    }
+
+    with ConnectHandler(**device_params) as conn:
+        output = str()
+
+        for command in commands:
+            output += conn.send_command(command)
+
+    return Result(host=task.host, result=output)
+
+
+def netmiko_send_config(task: Task, commands: list()):
+    """execute configuration changes on a device via netmiko
+
+    :param task: nornir Task object
+    :param commands: a list of commands to execute
+
+    :returns: nornir Result object
+    """
+    device_params = {
+        "host": task.host.hostname,
+        "device_type": device_mapper(os_type=task.host.platform, proto="netmiko"),
+        "port": task.host.port,
+        "username": task.host.username,
+        "password": task.host.password,
+        "secret": task.host.connection_options["netmiko"]["extras"].get("secret", None),
+    }
+
+    with ConnectHandler(**device_params) as conn:
+        output = conn.send_config_set(commands)
+        output += conn.save()
+
+    return Result(task.host, result=output)

netnir/plugins/netmiko.py

@@ -8,7 +8,7 @@ def test_inventory(initial_setup):
         "port": 22,
         "username": os.environ.get("NETNIR_USER"),
         "password": os.environ.get("NETNIR_PASS"),
-        "platform": "cisco_xr",
+        "platform": "iosxr",
         "groups": ["dc1"],
         "data": {
             "groups": ["dc1"],
@@ -19,23 +19,14 @@ def test_inventory(initial_setup):
             "template_path": "./tests/data/templates/provider1/iosxr",
             "mgmt_protocol": "ssh",
         },
-        "connection_options": {
-            "netconf": {
-                "hostname": "router.dc1.example.net",
-                "username": os.environ.get("NETNIR_USER"),
-                "password": os.environ.get("NETNIR_PASS"),
-                "platform": "iosxr",
-                "port": 830,
-                "extras": {"hostkey_verify": False},
-            },
-        },
+        "connection_options": {},
     }
     router2 = {
         "hostname": "router.dc2.example.net",
         "port": 22,
         "username": os.environ.get("NETNIR_USER"),
         "password": os.environ.get("NETNIR_PASS"),
-        "platform": "cisco_ios",
+        "platform": "ios",
         "groups": ["dc2"],
         "data": {
             "groups": ["dc2"],
@@ -46,16 +37,7 @@ def test_inventory(initial_setup):
             "template_path": "./tests/data/templates/provider2/ios",
             "mgmt_protocol": "ssh",
         },
-        "connection_options": {
-            "netconf": {
-                "hostname": "router.dc2.example.net",
-                "username": os.environ.get("NETNIR_USER"),
-                "password": os.environ.get("NETNIR_PASS"),
-                "platform": "default",
-                "port": 830,
-                "extras": {"hostkey_verify": False},
-            },
-        },
+        "connection_options": {},
     }
 
     assert isinstance(inv.hosts, dict) is True