update netconf and netmiko connections

Author: jtdub

netnir/__init__.py

@@ -1,6 +1,6 @@
 """
-initialize netnir by looking for the netnir config. If the netnir config doesn't exist,
-netnir will create the default config and folders.
+initialize netnir by looking for the netnir config. If the netnir config
+doesn't exist, netnir will create the default config and folders.
 """
 
-__version__ = "0.0.17"
+__version__ = "0.0.18"

netnir/cli.py

@@ -12,8 +12,9 @@ class Cli:
 
     def __init__(self):
         """
-        A class object used to setup the netnir cli, consume the available commands from plugins,
-        display the available commands, and execute the available commands based on user input.
+        A class object used to setup the netnir cli, consume the available
+        commands from plugins, display the available commands, and execute
+        the available commands based on user input.
         """
         from netnir.helpers import plugins_import
 

netnir/core/tasks/netconf.py

@@ -4,6 +4,7 @@
     netconf_filter,
     netconf_source,
     netconf_target,
+    netconf_capabilities,
     config,
 )
 
@@ -18,19 +19,28 @@ def parser(parser):
         netconf_filter(parser)
         netconf_source(parser)
         netconf_target(parser)
+        netconf_capabilities(parser)
         config(parser)
 
     def run(self):
         """execute netconf commands
 
         :returns: nornir Result object
         """
-        from netnir.plugins.netconf import netconf_get_config, netconf_edit_config
+        from netnir.plugins.netconf import (
+            netconf_get_config,
+            netconf_edit_config,
+            netconf_capabilities,
+        )
         from nornir.plugins.functions.text import print_result
 
         self.nr = self._inventory()
 
-        if self.args.config:
+        if self.args.capabilities:
+            results = self.nr.run(
+                task=netconf_capabilities, name="NETCONF SERVER CAPABILITIES",
+            )
+        elif self.args.config:
             results = self.nr.run(
                 task=netconf_edit_config,
                 name="NETCONF EDIT CONFIG",

netnir/helpers/common/args.py

@@ -157,3 +157,17 @@ def netconf_config(parser, required: bool = False):
         help="yang config file that defines what to fetch from a device or edit on a device",
         required=required,
     )
+
+
+def netconf_capabilities(parser, required: bool = False):
+    """
+    common argument to retrieve the netconf capabilities from a netconf server
+    via netconf with the --capabilities flag.
+    """
+    parser.add_argument(
+        "--capabilities",
+        help="retrieve netconf capabilities from a netconf server",
+        required=required,
+        nargs="?",
+        const=True,
+    )

netnir/plugins/netconf.py

@@ -3,6 +3,29 @@
 from ncclient import manager
 
 
+def netconf_capabilities(task: Task) -> Result:
+    """nornir get netconf capabilities
+
+    :params task: type object
+    :returns: nornir result object
+    """
+    device_params = {
+        "host": task.host.hostname,
+        "port": task.host.port or 830,
+        "username": task.host.username,
+        "password": task.host.password,
+        "hostkey_verify": False,
+        "device_params": {
+            "name": device_mapper(os_type=task.host.data["os"], proto="netconf")
+        },
+    }
+
+    with manager.connect(**device_params) as conn:
+        results = [capability for capability in conn.server_capabilities]
+
+    return Result(host=task.host, result=results)
+
+
 def netconf_get_config(
     task: Task,
     source: str = "running",

netnir/plugins/netmiko.py

@@ -11,18 +11,23 @@ def netmiko_send_commands(task: Task, commands: list()) -> Result:
 
     :returns: nornir Result object
     """
+    try:
+        secret = task.host.connection_options["netmiko"]["extras"]["secret"]
+    except KeyError:
+        secret = None
+
     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),
+        "secret": secret,
+        "ssh_config_file": task.nornir.config.ssh.config_file or None,
     }
+    output = str()
 
     with ConnectHandler(**device_params) as conn:
-        output = str()
-
         for command in commands:
             output += conn.send_command(command)
 
@@ -37,13 +42,19 @@ def netmiko_send_config(task: Task, commands: list()) -> Result:
 
     :returns: nornir Result object
     """
+    try:
+        secret = task.host.connection_options["netmiko"]["extras"]["secret"]
+    except KeyError:
+        secret = None
+
     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),
+        "secret": secret,
+        "ssh_config_file": task.nornir.config.ssh.config_file or None,
     }
 
     with ConnectHandler(**device_params) as conn: