.. Document meta

:orphan:

.. |antsibull-internal-nbsp| unicode:: 0xA0
    :trim:

.. meta::
  :antsibull-docs: 2.23.0

.. Anchors

.. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module:

.. Anchors: short name for ansible.builtin

.. Title

amnesh.soodar.soodar_ospf_interfaces module -- Resource module to configure OSPF interfaces.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This module is part of the `amnesh.soodar collection <https://soodar.ir>`_ (version 2.0.0).

    It is not included in ``ansible-core``.
    To check whether it is installed, run :code:`ansible-galaxy collection list`.

    To install it, use: :code:`ansible\-galaxy collection install https://soodar.ir/ansible/amnesh.soodar.tar.gz`.

    To use it in a playbook, specify: :code:`amnesh.soodar.soodar_ospf_interfaces`.

.. version_added


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

.. Deprecated


Synopsis
--------

.. Description

- Manages and configures Open Shortest Path First (OSPF) version 2 and it's attributes over interface on Soodar platforms.


.. Aliases


.. Requirements






.. Options

Parameters
----------

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Parameter
    - Comments

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config:

      .. rst-class:: ansible-option-title

      **config**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      A dictionary of OSPF interfaces options.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family:

      .. rst-class:: ansible-option-title

      **address_family**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      OSPF interfaces settings on the interfaces in address\-family context.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/afi"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/afi:

      .. rst-class:: ansible-option-title

      **afi**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/afi" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Address Family Identifier (AFI) for OSPF interfaces settings on the interfaces.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"ipv4"`
      - :ansible-option-choices-entry:`"ipv6"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/authentication"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/authentication:

      .. rst-class:: ansible-option-title

      **authentication**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/authentication" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Enable authentication


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/authentication/key_chain"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/authentication/key_chain:

      .. rst-class:: ansible-option-title

      **key_chain**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/authentication/key_chain" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Use a key\-chain for cryptographic authentication keys


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/authentication/message_digest"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/authentication/message_digest:

      .. rst-class:: ansible-option-title

      **message_digest**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/authentication/message_digest" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Use message\-digest authentication


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/authentication/null"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/authentication/null:

      .. rst-class:: ansible-option-title

      **null**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/authentication/null" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Use no authentication


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/bfd"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/bfd:

      .. rst-class:: ansible-option-title

      **bfd**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/bfd" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      BFD configuration commands

      Enable/Disable BFD on this interface


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/cost"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/cost:

      .. rst-class:: ansible-option-title

      **cost**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/cost" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Interface cost


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/cost/interface_cost"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/cost/interface_cost:

      .. rst-class:: ansible-option-title

      **interface_cost**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/cost/interface_cost" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Interface cost or Route cost of this interface


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/dead_interval"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/dead_interval:

      .. rst-class:: ansible-option-title

      **dead_interval**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/dead_interval" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Interval after which a neighbor is declared dead


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/dead_interval/minimal"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/dead_interval/minimal:

      .. rst-class:: ansible-option-title

      **minimal**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/dead_interval/minimal" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Set to 1 second and set multiplier for Hellos

      Number of Hellos sent within 1 second. Please refer vendor documentation of Valid values.

      Valid only with IP OSPF config


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/dead_interval/time"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/dead_interval/time:

      .. rst-class:: ansible-option-title

      **time**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/dead_interval/time" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      time in seconds


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/hello_interval"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/hello_interval:

      .. rst-class:: ansible-option-title

      **hello_interval**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/hello_interval" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Time between HELLO packets

      Please refer vendor documentation of Valid values.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/mtu_ignore"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/mtu_ignore:

      .. rst-class:: ansible-option-title

      **mtu_ignore**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/mtu_ignore" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Ignores the MTU in DBD packets


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/network"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/network:

      .. rst-class:: ansible-option-title

      **network**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/network" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Network type


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/network/broadcast"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/network/broadcast:

      .. rst-class:: ansible-option-title

      **broadcast**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/network/broadcast" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Specify OSPF broadcast multi\-access network


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/network/non_broadcast"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/network/non_broadcast:

      .. rst-class:: ansible-option-title

      **non_broadcast**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/network/non_broadcast" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Specify OSPF NBMA network


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/network/point_to_multipoint"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/network/point_to_multipoint:

      .. rst-class:: ansible-option-title

      **point_to_multipoint**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/network/point_to_multipoint" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Specify OSPF point\-to\-multipoint network


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/network/point_to_point"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/network/point_to_point:

      .. rst-class:: ansible-option-title

      **point_to_point**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/network/point_to_point" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Specify OSPF point\-to\-point network


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/priority"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/priority:

      .. rst-class:: ansible-option-title

      **priority**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/priority" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Router priority. Please refer vendor documentation of Valid values.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/process"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/process:

      .. rst-class:: ansible-option-title

      **process**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/process" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      OSPF interfaces process config


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/process/area_id"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/process/area_id:

      .. rst-class:: ansible-option-title

      **area_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/process/area_id" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      OSPF interfaces area ID as a decimal value. Please refer vendor documentation of Valid values.

      OSPF interfaces area ID in IP address format(e.g. A.B.C.D)


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/process/id"></div>

      .. raw:: latex

        \hspace{0.06\textwidth}\begin{minipage}[t]{0.26\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/process/id:

      .. rst-class:: ansible-option-title

      **id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/process/id" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Address Family Identifier (AFI) for OSPF interfaces settings on the interfaces. Please refer vendor documentation of Valid values.


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/retransmit_interval"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/retransmit_interval:

      .. rst-class:: ansible-option-title

      **retransmit_interval**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/retransmit_interval" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Time between retransmitting lost link state advertisements. Please refer vendor documentation of Valid values.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/address_family/transmit_delay"></div>

      .. raw:: latex

        \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/address_family/transmit_delay:

      .. rst-class:: ansible-option-title

      **transmit_delay**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/address_family/transmit_delay" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Link state transmit delay. Please refer vendor documentation of Valid values.


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/name"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-config/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/name" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Full name of the interface i.e. ge0.


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-running_config"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-running_config:

      .. rst-class:: ansible-option-title

      **running_config**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-running_config" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      This option is used only with state :emphasis:`parsed`.

      The value of this option should be the output received from the Soodar device by executing the command :strong:`sh running\-config \| section ^interface`.

      The state :emphasis:`parsed` reads the configuration from :literal:`running\_config` option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the :emphasis:`parsed` key within the result.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-state"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__parameter-state:

      .. rst-class:: ansible-option-title

      **state**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The state the configuration should be left in

      The states :emphasis:`rendered`\ , :emphasis:`gathered` and :emphasis:`parsed` does not perform any change on the device.

      The state :emphasis:`rendered` will transform the configuration in :literal:`config` option to platform specific CLI commands which will be returned in the :emphasis:`rendered` key within the result. For state :emphasis:`rendered` active connection to remote host is not required.

      The state :emphasis:`gathered` will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the :emphasis:`gathered` key within the result.

      The state :emphasis:`parsed` reads the configuration from :literal:`running\_config` option and transforms it into JSON format as per the resource module parameters and the value is returned in the :emphasis:`parsed` key within the result. The value of :literal:`running\_config` option should be the same format as the output of command :emphasis:`show running\-config \| section ^interface` executed on device. For state :emphasis:`parsed` active connection to remote host is not required.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"replaced"`
      - :ansible-option-choices-entry:`"overridden"`
      - :ansible-option-choices-entry:`"deleted"`
      - :ansible-option-choices-entry:`"gathered"`
      - :ansible-option-choices-entry:`"rendered"`
      - :ansible-option-choices-entry:`"parsed"`


      .. raw:: html

        </div>


.. Attributes


.. Notes

Notes
-----

.. note::
   - Tested against Soodar Version 23.11
   - This module works with connection :literal:`amnesh.soodar.network\_cli`.

.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    # Using deleted

    # Before state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ipv6 ospf priority 20
    #  ipv6 ospf area 105
    #  ipv6 ospf transmit-delay 30
    # interface ge2
    #  ip ospf priority 40
    #  ip ospf 10 area 20
    #  ip ospf cost 30

    - name: Delete provided OSPF Interface config
      amnesh.soodar.soodar_ospf_interfaces:
        config:
          - name: ge1
        state: deleted

    # Task Output:
    # ------------

    # before:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv6
    #       priority: 20
    #       process:
    #         area_id: '105'
    #       transmit_delay: 30
    #     name: ge1
    #   - address_family:
    #     - adjacency: true
    #       afi: ipv4
    #       cost:
    #         interface_cost: 30
    #       priority: 40
    #       process:
    #         id: 10
    #         area_id: '20'
    #     name: ge2
    #
    # commands:
    # - interface ge1
    # - no ipv6 ospf area 105
    # - no ipv6 ospf priority 20
    # - no ipv6 ospf transmit-delay 30
    #
    # after:
    #   - name: ge0
    #   - name: ge1
    #   - address_family:
    #     - adjacency: true
    #       afi: ipv4
    #       cost:
    #         interface_cost: 30
    #       priority: 40
    #       process:
    #         area_id: '20'
    #         id: 10
    #     name: ge2
    #

    # After state:
    # -------------
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    # interface ge2
    #  ip ospf priority 40
    #  ip ospf 10 area 20
    #  ip ospf cost 30

    # Using deleted without any config passed (NOTE: This will delete all OSPF Interfaces configuration from device)

    # Before state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ipv6 ospf 55 area 105
    #  ipv6 ospf priority 20
    #  ipv6 ospf transmit-delay 30
    # interface ge2
    #  ip ospf priority 40
    #  ip ospf 10 area 20
    #  ip ospf cost 30


    - name: Delete all OSPF config from interfaces
      amnesh.soodar.soodar_ospf_interfaces:
        state: deleted

    # Task Output:
    # ------------

    # before:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv6
    #       priority: 20
    #       process:
    #         area_id: '105'
    #         id: 55
    #       transmit_delay: 30
    #     name: ge1
    #   - address_family:
    #       afi: ipv4
    #       cost:
    #         interface_cost: 30
    #       priority: 40
    #       process:
    #         area_id: '20'
    #         id: 10
    #     name: ge2
    #
    # commands:
    # - interface ge2
    # - no ip ospf 10 area 20
    # - no ip ospf cost 30
    # - no ip ospf priority 40
    # - interface ge1
    # - no ipv6 ospf 55 area 105
    # - no ipv6 ospf priority 20
    # - no ipv6 ospf transmit-delay 30
    #
    # after:
    #   - name: ge0
    #   - name: ge1
    #   - name: ge2

    # After state:
    # -------------
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    # interface ge2


    # Using merged

    # Before state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # soodar#

    - name: Merge provided OSPF Interfaces configuration
      amnesh.soodar.soodar_ospf_interfaces:
        config:
          - name: ge1
            address_family:
              - afi: ipv4
                process:
                  id: 10
                  area_id: 30
                bfd: true
                cost:
                  interface_cost: 5
                dead_interval:
                  time: 5
                network:
                  broadcast: true
                priority: 25
              - afi: ipv6
                priority: 55
                transmit_delay: 45
        state: merged

    # Task Output:
    # ------------
    # before: []
    #
    # commands:
    # - interface ge1
    # - ip ospf 10 area 30
    # - ip ospf bfd
    # - ip ospf cost 5
    # - ip ospf dead-interval 5
    # - ip ospf network broadcast
    # - ip ospf priority 25
    # - ipv6 ospf priority 55
    # - ipv6 ospf transmit-delay 45
    #
    # after:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv4
    #       bfd: true
    #       cost:
    #         interface_cost: 5
    #       dead_interval:
    #         time: 5
    #       network:
    #         broadcast: true
    #       priority: 25
    #       process:
    #         area_id: '30'
    #         id: 10
    #       afi: ipv6
    #       priority: 55
    #       transmit_delay: 45
    #     name: ge1
    #   - name: ge2

    # After state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ip ospf network broadcast
    #  ip ospf dead-interval 5
    #  ip ospf priority 25
    #  ip ospf bfd
    #  ip ospf 10 area 30
    #  ip ospf cost 5
    #  ipv6 ospf priority 55
    #  ipv6 ospf transmit-delay 45
    # interface ge2


    # Using replaced

    # Before state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ip ospf network broadcast
    #  ip ospf dead-interval 5
    #  ip ospf priority 25
    #  ip ospf bfd
    #  ip ospf 10 area 30
    #  ip ospf cost 5
    #  ipv6 ospf priority 55
    #  ipv6 ospf transmit-delay 45
    # interface ge2

    - name: Replaced provided OSPF Interfaces configuration
      amnesh.soodar.soodar_ospf_interfaces:
        config:
          - name: ge2
            address_family:
              - afi: ipv6
                priority: 20
                transmit_delay: 30
        state: replaced

    # Task Output:
    # ------------
    #
    # before:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv4
    #       bfd: true
    #       cost:
    #         interface_cost: 5
    #       dead_interval:
    #         time: 5
    #       network:
    #         broadcast: true
    #       priority: 25
    #       process:
    #         area_id: '30'
    #         id: 10
    #       afi: ipv6
    #       priority: 55
    #       process:
    #         area_id: '45'
    #         id: 35
    #       transmit_delay: 45
    #     name: ge1
    #   - name: ge2
    #
    # commands:
    # - interface ge2
    # - ipv6 ospf 55 area 105
    # - ipv6 ospf priority 20
    # - ipv6 ospf transmit-delay 30
    #
    # after:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv4
    #       bfd: true
    #       cost:
    #         interface_cost: 5
    #       dead_interval:
    #         time: 5
    #       network:
    #         broadcast: true
    #       priority: 25
    #       process:
    #         area_id: '30'
    #         id: 10
    #       afi: ipv6
    #       priority: 55
    #       process:
    #         area_id: '45'
    #         id: 35
    #       transmit_delay: 45
    #     name: ge1
    #   - address_family:
    #       afi: ipv6
    #       priority: 20
    #       process:
    #         area_id: '105'
    #         id: 55
    #       transmit_delay: 30
    #     name: ge2

    # After state:
    # -------------
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ip ospf network broadcast
    #  ip ospf dead-interval 5
    #  ip ospf priority 25
    #  ip ospf bfd
    #  ip ospf 10 area 30
    #  ip ospf cost 5
    #  ipv6 ospf priority 55
    #  ipv6 ospf transmit-delay 45
    # interface ge2
    #  ipv6 ospf priority 20
    #  ipv6 ospf transmit-delay 30


    # Using overridden

    # Before state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ip ospf network broadcast
    #  ip ospf dead-interval 5
    #  ip ospf priority 25
    #  ip ospf bfd
    #  ip ospf 10 area 30
    #  ip ospf cost 5
    #  ipv6 ospf priority 55
    #  ipv6 ospf transmit-delay 45
    # interface ge2

    - name: Override running config with provided OSPF Interfaces configuration
      amnesh.soodar.soodar_ospf_interfaces:
        config:
          - name: ge1
            address_family:
              - afi: ipv6
                priority: 20
                transmit_delay: 30
          - name: ge2
            address_family:
              - afi: ipv4
                process:
                  id: 10
                  area_id: 20
                cost:
                  interface_cost: 30
                priority: 40
        state: overridden

    # Task Output:
    # ------------
    #
    # before:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv4
    #       bfd: true
    #       cost:
    #         interface_cost: 5
    #       dead_interval:
    #         time: 5
    #       network:
    #         broadcast: true
    #       priority: 25
    #       process:
    #         area_id: '30'
    #         id: 10
    #       afi: ipv6
    #       priority: 55
    #       process:
    #         area_id: '45'
    #         id: 35
    #       transmit_delay: 45
    #     name: ge1
    #   - name: ge2
    #
    # commands:
    # - interface ge2
    # - ip ospf 10 area 20
    # - ip ospf cost 30
    # - ip ospf priority 40
    # - interface ge1
    # - ipv6 ospf 55 area 105
    # - ipv6 ospf priority 20
    # - ipv6 ospf transmit-delay 30
    # - no ip ospf 10 area 30
    # - no ip ospf bfd
    # - no ip ospf cost 5
    # - no ip ospf dead-interval 5
    # - no ip ospf network broadcast
    # - no ip ospf priority 25
    #
    # parsed:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv6
    #       priority: 20
    #       process:
    #         area_id: '105'
    #         id: 55
    #       transmit_delay: 30
    #     name: ge1
    #   - address_family:
    #       afi: ipv4
    #       cost:
    #         interface_cost: 30
    #       priority: 40
    #       process:
    #         area_id: '20'
    #         id: 10
    #     name: ge2

    # After state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ipv6 ospf 55 area 105
    #  ipv6 ospf priority 20
    #  ipv6 ospf transmit-delay 30
    # interface ge2
    #  ip ospf priority 40
    #  ip ospf 10 area 20
    #  ip ospf cost 30


    # Using Gathered

    # Before state:
    # -------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ip ospf network broadcast
    #  ip ospf dead-interval 5
    #  ip ospf priority 25
    #  ip ospf bfd
    #  ip ospf 10 area 30
    #  ip ospf cost 5
    #  ipv6 ospf priority 55
    #  ipv6 ospf transmit-delay 45
    # interface ge2

    - name: Gather OSPF Interfaces provided configurations
      amnesh.soodar.soodar_ospf_interfaces:
        config:
        state: gathered

    # Task Output:
    # ------------
    #
    # gathered:
    #   - name: ge0
    #   - address_family:
    #       afi: ipv4
    #       bfd: true
    #       cost:
    #         interface_cost: 5
    #       dead_interval:
    #         time: 5
    #       network:
    #         broadcast: true
    #       priority: 25
    #       process:
    #         area_id: '30'
    #         id: 10
    #       afi: ipv6
    #       priority: 55
    #       process:
    #         area_id: '45'
    #         id: 35
    #       transmit_delay: 45
    #     name: ge1
    #   - name: ge2

    # After state:
    # ------------
    #
    # soodar# sh running-config | section ^interface
    # interface ge0
    # interface ge1
    #  ip ospf network broadcast
    #  ip ospf dead-interval 5
    #  ip ospf priority 25
    #  ip ospf bfd
    #  ip ospf 10 area 30
    #  ip ospf cost 5
    #  ipv6 ospf priority 55
    #  ipv6 ospf transmit-delay 45
    # interface ge2


    # Using Rendered

    - name: Render the commands for provided  configuration
      amnesh.soodar.soodar_ospf_interfaces:
        config:
          - name: ge1
            address_family:
              - afi: ipv4
                process:
                  id: 10
                  area_id: 30
                adjacency: true
                bfd: true
                cost:
                  interface_cost: 5
                dead_interval:
                  time: 5
                network:
                  broadcast: true
                priority: 25
                resync_timeout: 10
              - afi: ipv6
                adjacency: true
                priority: 55
                transmit_delay: 45
        state: rendered

    # Task Output:
    # ------------
    #
    # rendered:
    # - interface GigabitEthernet0/1
    # - ip ospf 10 area 30
    # - ip ospf bfd
    # - ip ospf cost 5
    # - ip ospf dead-interval 5
    # - ip ospf network broadcast
    # - ip ospf priority 25
    # - ipv6 ospf 35 area 45
    # - ipv6 ospf priority 55
    # - ipv6 ospf transmit-delay 45


    # Using Parsed

    # File: parsed.cfg
    # ----------------
    #
    # interface ge2
    # interface ge1
    #  ip ospf network broadcast
    #  ip ospf dead-interval 5
    #  ip ospf priority 25
    #  ip ospf bfd
    #  ip ospf 10 area 30
    #  ip ospf cost 5
    #  ipv6 ospf 35 area 45
    #  ipv6 ospf priority 55
    #  ipv6 ospf transmit-delay 45
    # interface ge0

    - name: Parse the provided configuration with the existing running configuration
      amnesh.soodar.soodar_ospf_interfaces:
        running_config: "{{ lookup('file', 'parsed.cfg') }}"
        state: parsed

    # Task Output:
    # ------------
    #
    # parsed:
    #   - name: ge2
    #   - address_family:
    #       afi: ipv4
    #       bfd: true
    #       cost:
    #         interface_cost: 5
    #       dead_interval:
    #         time: 5
    #       network:
    #         broadcast: true
    #       priority: 25
    #       process:
    #         area_id: '30'
    #         id: 10
    #       afi: ipv6
    #       priority: 55
    #       process:
    #         area_id: '45'
    #         id: 35
    #       transmit_delay: 45
    #     name: ge1
    #   - name: ge0



.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Key
    - Description

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-after"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__return-after:

      .. rst-class:: ansible-option-title

      **after**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-after" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The resulting configuration after module execution.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when changed

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"This output will always be in the same format as the module argspec.\\n"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-before"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__return-before:

      .. rst-class:: ansible-option-title

      **before**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-before" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The configuration prior to the module execution.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when :emphasis:`state` is :literal:`merged`\ , :literal:`replaced`\ , :literal:`overridden`\ , :literal:`deleted` or :literal:`purged`

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"This output will always be in the same format as the module argspec.\\n"`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-commands"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__return-commands:

      .. rst-class:: ansible-option-title

      **commands**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-commands" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The set of commands pushed to the remote device.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when :emphasis:`state` is :literal:`merged`\ , :literal:`replaced`\ , :literal:`overridden`\ , :literal:`deleted` or :literal:`purged`

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["sample command 1", "sample command 2", "sample command 3"]`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-gathered"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__return-gathered:

      .. rst-class:: ansible-option-title

      **gathered**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-gathered" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Facts about the network resource gathered from the remote device as structured data.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when :emphasis:`state` is :literal:`gathered`

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["This output will always be in the same format as the module argspec.\\n"]`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-parsed"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__return-parsed:

      .. rst-class:: ansible-option-title

      **parsed**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-parsed" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The device native config provided in :emphasis:`running\_config` option parsed into structured data as per module argspec.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when :emphasis:`state` is :literal:`parsed`

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["This output will always be in the same format as the module argspec.\\n"]`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-rendered"></div>

      .. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module__return-rendered:

      .. rst-class:: ansible-option-title

      **rendered**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-rendered" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The provided configuration in the task rendered in device\-native format (offline).


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when :emphasis:`state` is :literal:`rendered`

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["sample command 1", "sample command 2", "sample command 3"]`


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Sagar Paul (@KB-perByte)
- Sumit Jaiswal (@justjais)
- Mahdi Varasteh (@m-varasteh)


.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. ansible-links::

  - title: "Issue Tracker"
    url: "http://soodar.ir/issue/tracker"
    external: true
  - title: "Homepage"
    url: "http://soodar.ir"
    external: true


.. Parsing errors