napalm_ping.py (#472)

nornir/plugins/tasks/networking/__init__.py

@@ -12,6 +12,7 @@
 from .netmiko_send_config import netmiko_send_config
 from .netmiko_save_config import netmiko_save_config
 from .tcp_ping import tcp_ping
+from .napalm_ping import napalm_ping
 
 __all__ = (
     "napalm_cli",
@@ -28,4 +29,5 @@
     "netmiko_send_config",
     "netmiko_save_config",
     "tcp_ping",
+    "napalm_ping",
 )

nornir/plugins/tasks/networking/napalm_ping.py

@@ -0,0 +1,55 @@
+from typing import Optional
+from nornir.core.task import Result, Task
+
+
+def napalm_ping(
+    task: Task,
+    dest: str,
+    source: Optional[str] = None,
+    ttl: Optional[int] = 255,
+    timeout: Optional[int] = 2,
+    size: Optional[int] = 100,
+    count: Optional[int] = 5,
+    vrf: Optional[str] = None,
+) -> Result:
+    """
+    Executes ping on the device and returns a dictionary with the result.
+
+    Arguments:
+      dest(str) – Host or IP Address of the destination.
+      source(str, optional) – Source address of echo request.
+      ttl(int, optional) – Max number of hops.
+      timeout(int, optional) – Max seconds to wait after sending final packet.
+      size(int, optional) – Size of request in bytes.
+      count(int, optional) – Number of ping request to send.
+      vrf(str, optional) - Name of vrf.
+
+    Examples:
+
+      Simple example::
+            > nr.run(task=napalm_ping,
+            >        dest='10.1.1.1')
+
+      Passing some other optional arguments::
+            > nr.run(task=napalm_ping,
+            >        dest='10.1.1.1', source='10.1.1.2', size=1400, count=10)
+
+
+    Returns:
+       Result object with the following attributes set:
+       * result (``dict``): list of dictionary with the result of the ping response.
+         Output dictionary has one of following keys "success or error"
+
+
+    """
+    device = task.host.get_connection("napalm", task.nornir.config)
+    result = device.ping(
+        destination=dest,
+        source=source,
+        ttl=ttl,
+        timeout=timeout,
+        size=size,
+        count=count,
+        vrf=vrf,
+    )
+    return Result(host=task.host, result=result)