.. _junos_ping:


junos_ping - execute ping on junos devices
++++++++++++++++++++++++++++++++++++++++++

:Author: Damien Garros, Juniper Networks

.. contents::
   :local:
   :depth: 1

Synopsis
--------

.. versionadded:: 1.3.1

execute ping on junos devices

Options
-------

.. raw:: html

    <table border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    <th class="head">comments</th>
    </tr>
            <tr>
    <td>acceptable_packet_loss</td>
    <td>no</td>
    <td>0</td>
        <td><ul></ul></td>
        <td>Number of packets lost that is acceptable to consider the test PASS</td>
    </tr>
            <tr>
    <td>count</td>
    <td>no</td>
    <td>5</td>
        <td><ul></ul></td>
        <td>Number of packet to send</td>
    </tr>
            <tr>
    <td>dest_ip</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Destination ip</td>
    </tr>
            <tr>
    <td>do_not_fragment</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set Don't Fragment bit</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</td>
    </tr>
            <tr>
    <td>interface</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>Interface used to send traffic out</td>
    </tr>
            <tr>
    <td>mode</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>mode of console connection (telnet/serial). If mode is not provided SSH connection is used.</td>
    </tr>
            <tr>
    <td>passwd</td>
    <td>no</td>
    <td>assumes ssh-key active</td>
        <td><ul></ul></td>
        <td>Login password</td>
    </tr>
            <tr>
    <td>port</td>
    <td>no</td>
    <td>830</td>
        <td><ul></ul></td>
        <td>port number to use when connecting to the device</td>
    </tr>
            <tr>
    <td>rapid</td>
    <td>no</td>
    <td>True</td>
        <td><ul></ul></td>
        <td>Execute ping at 100pps instead of 1pps</td>
    </tr>
            <tr>
    <td>routing_instance</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>Name of the routing instance to use to send the ping</td>
    </tr>
            <tr>
    <td>size</td>
    <td>no</td>
    <td>None (default size)</td>
        <td><ul></ul></td>
        <td>The size of the ICMP payload of the ping.</td>
    </tr>
            <tr>
    <td>source_ip</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>Source IP used to send the ping</td>
    </tr>
            <tr>
    <td>ssh_private_key_file</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment.  if your ssh-key requires a password, then you must provide it via **passwd**</td>
    </tr>
            <tr>
    <td>timeout</td>
    <td>no</td>
    <td>0</td>
        <td><ul></ul></td>
        <td>Extend the NETCONF RPC timeout beyond the default value of 30 seconds. Set this value to accommodate pings that might take longer than the default timeout interval.</td>
    </tr>
            <tr>
    <td>ttl</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>Maximum number of IP routers (IP hops) allowed between source and destination</td>
    </tr>
            <tr>
    <td>user</td>
    <td>no</td>
    <td>$USER</td>
        <td><ul></ul></td>
        <td>Login username</td>
    </tr>
        </table>


.. note:: Requires junos-eznc >= 1.2.2


Examples
--------

.. raw:: html

    <br/>


::

    
    # Simple example
      tasks:
        - name: "Execute ping peer"
          junos_ping:
            host={{ junos_host }}
            port={{ netconf_port }}
            user={{ ansible_ssh_user }}
            passwd={{ ansible_ssh_pass }}
            dest_ip=8.8.8.8
    
    # ping over console server connection using PyEZ >= 2.0
      tasks:
        - name: "Execute ping peer"
          junos_ping:
            host={{ inventory_hostname }}
            port=2011
            mode='telnet'
            user={{ ansible_ssh_user }}
            passwd={{ ansible_ssh_pass }}
            dest_ip=8.8.8.8
    
    # Using loop and more parameters
      tasks:
        - name: "Execute ping peer"
          junos_ping:
            host={{ junos_host }}
            port={{ netconf_port }}
            user={{ ansible_ssh_user }}
            passwd={{ ansible_ssh_pass }}
            dest_ip={{ item.peer_ip }}
            source_ip={{ item.local_ip }}
            do_not_fragment=True
            ttl=1
          with_items: "{{underlay.neighbors}}"