Merge pull request #13 from netdevops/netconf

add netconf

netnir/__init__.py

@@ -3,4 +3,4 @@
 netnir will create the default config and folders.
 """
 
-__version__ = "0.0.10"
+__version__ = "0.0.11"

netnir/core/inventory.py

@@ -44,8 +44,8 @@ def nhosts(self):
             )
             data[host] = {
                 "hostname": f"{host}.{domain}" if domain else host,
-                "username": creds["username"],
-                "password": creds["password"],
+                "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"]),
                 "groups": host_vars.get("groups", list()),
@@ -64,8 +64,8 @@ def nhosts(self):
                 "connection_options": {
                     "netconf": {
                         "hostname": f"{host}.{domain}" if domain else host,
-                        "username": creds["username"],
-                        "password": creds["password"],
+                        "username": host_vars.get("username", creds["username"]),
+                        "password": host_vars.get("password", creds["password"]),
                         "platform": host_vars.get("os"),
                         "port": host_vars.get("port", 830),
                         "extras": {"hostkey_verify": False},

netnir/core/tasks/inventory.py

@@ -1,49 +1,16 @@
-from netnir.constants import NR
-from netnir.helpers.common.args import filter_host, filter_hosts, filter_group
-from netnir.helpers import filter_type, inventory_filter
-from netnir.plugins.facts import inventory_facts
-from nornir.plugins.functions.text import print_result
+from netnir.helpers.scaffold.command import CommandScaffold
 
 
-"""inventory cli commands
-"""
-
-
-class Inventory:
+class Inventory(CommandScaffold):
     """
     cli based inventory search
-
-    :param args: type obj
     """
 
-    def __init__(self, args):
-        """
-        initialize the inventory class
-        """
-        self.args = args
-        self.nr = NR
-
-    @staticmethod
-    def parser(parser):
-        """
-        cli command parser
-        """
-        filter_host(parser)
-        filter_hosts(parser)
-        filter_group(parser)
-
     def run(self):
-        """
-        cli execution
-        """
-        devices_filter = filter_type(
-            host=self.args.host, filter=self.args.filter, group=self.args.group
-        )
-        self.nr = inventory_filter(
-            nr=self.nr,
-            device_filter=devices_filter["data"],
-            type=devices_filter["type"],
-        )
+        from netnir.plugins.facts import inventory_facts
+        from nornir.plugins.functions.text import print_result
+
+        self.nr = self._inventory()
         results = self.nr.run(task=inventory_facts)
         print_result(results)
 

netnir/core/tasks/netconf.py

@@ -0,0 +1,19 @@
+from netnir.helpers.scaffold.command import CommandScaffold
+
+
+class NetConf(CommandScaffold):
+    """netconf commands"""
+
+    def run(self):
+        """execute netconf commands
+
+        :returns: nornir Result object
+        """
+        from netnir.plugins.netconf import netconf_get
+        from nornir.plugins.functions.text import print_result
+
+        self.nr = self._inventory()
+        results = self.nr.run(task=netconf_get, name="NETCONF GET CONFIG AND STATE")
+        print_result(results)
+
+        return results

netnir/helpers/defaults.py

@@ -27,6 +27,10 @@
             "class": "netnir.core.tasks.ssh.Ssh",
             "description": "command and config execution over SSH",
         },
+        "netconf": {
+            "class": "netnir.core.tasks.netconf.NetConf",
+            "description": "command and config execution over NETCONF",
+        },
         "fetch": {
             "class": "netnir.core.tasks.fetch.Fetch",
             "description": "fetch commands",

netnir/helpers/scaffold/command.py

@@ -0,0 +1,49 @@
+""" netnir command scaffolding """
+
+
+class CommandScaffold:
+    """ scaffold class """
+
+    def __init__(self, args):
+        """initialize the class
+
+        :params args: type object
+        """
+        from netnir.constants import NR
+
+        self.args = args
+        self.nr = NR
+
+    @staticmethod
+    def parser(parser):
+        """command parser function
+
+        :params parser: type object
+        """
+        from netnir.helpers.common.args import filter_host, filter_hosts, filter_group
+
+        filter_host(parser)
+        filter_hosts(parser)
+        filter_group(parser)
+
+    def run(self):
+        """things to do"""
+        return "things to do"
+
+    def _inventory(self):
+        """filter inventory
+
+        :returns: filtered nornir inventory object
+        """
+        from netnir.helpers import inventory_filter, filter_type
+
+        devices_filter = filter_type(
+            host=self.args.host, filter=self.args.filter, group=self.args.group
+        )
+        self.nr = inventory_filter(
+            nr=self.nr,
+            device_filter=devices_filter["data"],
+            type=devices_filter["type"],
+        )
+
+        return self.nr

netnir/plugins/netconf.py

@@ -0,0 +1,14 @@
+from nornir.core.task import Task, Result
+
+
+def netconf_get(task: Task) -> Result:
+    """nornir netconf get task
+
+    :params task: type object
+    """
+    manager = task.host.get_connection(
+        connection="netconf", configuration=task.nornir.config
+    )
+    result = manager.get()
+
+    return Result(result=result, host=task.host)

tests/data/netnir.yaml

@@ -27,3 +27,6 @@ plugins:
     ssh:
         class: netnir.core.tasks.ssh.Ssh
         description: "command and config execution over SSH"
+    netconf:
+        class: netnir.core.tasks.netconf.NetConf
+        description: "command and config execution over NETCONF"

tests/netnir/helpers/test_nornir_config.py → tests/netnir/helpers/test_netnir_config.py

@@ -1,4 +1,4 @@
-def test_nornir_config(initial_setup):
+def test_netnir_config(initial_setup):
     from netnir.helpers import netnir_config
 
     test_config = {
@@ -28,6 +28,10 @@ def test_nornir_config(initial_setup):
                 "class": "netnir.core.tasks.ssh.Ssh",
                 "description": "command and config execution over SSH",
             },
+            "netconf": {
+                "class": "netnir.core.tasks.netconf.NetConf",
+                "description": "command and config execution over NETCONF",
+            },
             "fetch": {
                 "class": "netnir.core.tasks.fetch.Fetch",
                 "description": "fetch commands",