.. _junos_pmtud:


junos_pmtud - Perform path MTU discovery on junos devices
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++

:Author: Martin Komon

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

Synopsis
--------

.. versionadded:: 2.4

perform path MTU discovery 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>dest_ip</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Destination IPv4 address or 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>max_range</td>
    <td>no</td>
    <td>512</td>
        <td><ul></ul></td>
        <td>Max range of path MTU discovery. Must be 2^n.</td>
    </tr>
            <tr>
    <td>max_size</td>
    <td>no</td>
    <td>1472</td>
        <td><ul></ul></td>
        <td>Start and max size for path MTU discovery.</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>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>source_ip</td>
    <td>no</td>
    <td></td>
        <td><ul></ul></td>
        <td>Source IPv4 address 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>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: "Check MTU on backup circuit"
          junos_pmtud:
            host={{ junos_host }}
            port={{ netconf_port }}
            user={{ ansible_ssh_user }}
            passwd={{ ansible_ssh_pass }}
            dest_ip=8.8.8.8
    
    # Using more parameters
      tasks:
        - name: "Check MTU on backup circuit"
          junos_pmtud:
            host={{ junos_host }}
            port={{ netconf_port }}
            user={{ ansible_ssh_user }}
            passwd={{ ansible_ssh_pass }}
            dest_ip=8.8.8.8
            routing_instance=internet
            max_range=128