Merge pull request #40 from ktbyers/develop

Release 0.2.0

.github/workflows/commit.yaml

@@ -14,12 +14,12 @@ jobs:
       - name: Setup python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: 3.10.4
 
       - name: Install Poetry
         uses: snok/[email protected]
         with:
-          version: 1.1.8
+          version: 1.1.13
           virtualenvs-create: true
           virtualenvs-in-project: true
 

nornir_netmiko/__init__.py

@@ -5,6 +5,7 @@
 from nornir_netmiko.tasks import netmiko_save_config
 from nornir_netmiko.tasks import netmiko_send_command
 from nornir_netmiko.tasks import netmiko_send_config
+from nornir_netmiko.tasks import netmiko_multiline
 
 
 __all__ = (
@@ -14,5 +15,6 @@
     "netmiko_file_transfer",
     "netmiko_save_config",
     "netmiko_send_command",
+    "netmiko_multiline",
     "netmiko_send_config",
 )

nornir_netmiko/tasks/__init__.py

@@ -3,6 +3,7 @@
 from nornir_netmiko.tasks.netmiko_save_config import netmiko_save_config
 from nornir_netmiko.tasks.netmiko_send_command import netmiko_send_command
 from nornir_netmiko.tasks.netmiko_send_config import netmiko_send_config
+from nornir_netmiko.tasks.netmiko_multiline import netmiko_multiline
 
 
 __all__ = (
@@ -11,4 +12,5 @@
     "netmiko_save_config",
     "netmiko_send_command",
     "netmiko_send_config",
+    "netmiko_multiline",
 )

nornir_netmiko/tasks/netmiko_multiline.py

@@ -0,0 +1,33 @@
+from typing import Sequence, Union, List, Any
+from nornir.core.task import Result, Task
+from nornir_netmiko.connections import CONNECTION_NAME
+
+
+def netmiko_multiline(
+    task: Task,
+    commands: Sequence[Union[str, List[str]]],
+    use_timing: bool = False,
+    enable: bool = False,
+    **kwargs: Any
+) -> Result:
+    """
+    Execute Netmiko send_multiline method (or send_multiline_timing)
+
+    Arguments:
+        commands: List or list of lists (see Netmiko send_multiline)
+        use_timing: Set to True to switch to send_multiline_timing method.
+        enable: Set to True to force Netmiko .enable() call.
+        kwargs: Additional arguments to pass to send_multiline method.
+
+    Returns:
+        Result object with the following attributes set:
+          * result: String result showing you the output from commands
+    """
+    net_connect = task.host.get_connection(CONNECTION_NAME, task.nornir.config)
+    if enable:
+        net_connect.enable()
+    if use_timing:
+        result = net_connect.send_multiline_timing(commands, **kwargs)
+    else:
+        result = net_connect.send_multiline(commands, **kwargs)
+    return Result(host=task.host, result=result)