.. Document meta

:orphan:

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

.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. role:: ansible-option-type
.. role:: ansible-option-elements
.. role:: ansible-option-required
.. role:: ansible-option-versionadded
.. role:: ansible-option-aliases
.. role:: ansible-option-choices
.. role:: ansible-option-choices-default-mark
.. role:: ansible-option-default-bold
.. role:: ansible-option-configuration
.. role:: ansible-option-returned-bold
.. role:: ansible-option-sample-bold

.. Anchors

.. _ansible_collections.amnesh.soodar.soodar_ospf_interfaces_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

amnesh.soodar.soodar_ospf_interfaces module -- OSPF\_interfaces resource module.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

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

    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

.. rst-class:: ansible-version-added

New in amnesh.soodar 1.0

.. 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
----------

.. rst-class:: ansible-option-table

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1

  * - 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>

      .. rst-class:: 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>

      .. _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>

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

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

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

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

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. 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/message_digest"></div>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. 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/instance_id"></div>

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

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

      **instance_id**

      .. raw:: html

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

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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 the OSPF instance based on ID

      Valid only with IPv6 OSPF config


      .. 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>

      .. _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>

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. 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>

      .. _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>

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

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

      .. raw:: html

        </div>

    - .. raw:: html

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

      Full name of the interface e.g. ge1.


      .. 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>

      .. rst-class:: 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>

      .. rst-class:: 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 | include ip route|ipv6 route`\  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 21.04

.. 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 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

    #  Commands Fired:
    #  ---------------
    #
    #  "commands": [
    #         "interface ge1",
    #         "no ipv6 ospf priority 20",
    #         "no ipv6 ospf transmit-delay 30"
    #     ]

    # 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 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

    # Commands Fired:
    # ---------------
    #
    #  "commands": [
    #         "interface ge2",
    #         "no ip ospf 10 area 20",
    #         "no ip ospf cost 30",
    #         "no ip ospf priority 40",
    #         "interface ge1",
    #         "no ipv6 ospf priority 20",
    #         "no ipv6 ospf transmit-delay 30"
    #     ]

    # 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

    #  Commands Fired:
    #  ---------------
    #
    #   "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 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

    # Commands Fired:
    # ---------------
    #  "commands": [
    #         "interface ge2",
    #         "ipv6 ospf priority 20",
    #         "ipv6 ospf transmit-delay 30"
    #     ]

    # 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 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

    # Commands Fired:
    # ---------------
    #
    #  "commands": [
    #         "interface ge2",
    #         "ip ospf 10 area 20",
    #         "ip ospf cost 30",
    #         "ip ospf priority 40",
    #         "interface ge1",
    #         "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",
    #         "no ip ospf shutdown",
    #     ]

    # 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
    #  ipv6 ospf adjacency stagger disable
    # interface ge2
    #  ip ospf priority 40
    #  ip ospf adjacency stagger disable
    #  ip ospf ttl-security hops 50
    #  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

    # Module Execution Result:
    # ------------------------
    #
    #  "gathered": [
    #         {
    #             "name": "ge2"
    #         },
    #         {
    #             "address_family": [
    #                 {
    #                     "adjacency": true,
    #                     "afi": "ipv4",
    #                     "bfd": true,
    #                     "cost": {
    #                         "interface_cost": 5
    #                     },
    #                     "dead_interval": {
    #                         "time": 5
    #                     },
    #                     "network": {
    #                         "broadcast": true
    #                     },
    #                     "priority": 25,
    #                     "process": {
    #                         "area_id": "30",
    #                         "id": 10
    #                     },
    #                     "resync_timeout": 10,
    #                 },
    #                 {
    #                     "adjacency": true,
    #                     "afi": "ipv6",
    #                     "priority": 55,
    #                     "transmit_delay": 45
    #                 }
    #             ],
    #             "name": "ge1"
    #         },
    #         {
    #             "name": "ge0"
    #         }
    #  ]

    # 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

    # Module Execution Result:
    # ------------------------
    #
    #  "rendered": [
    #         "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",
    #         "ip ospf resync-timeout 10",
    #         "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

    # Module Execution Result:
    # ------------------------
    #
    #  "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:

.. rst-class:: ansible-option-table

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1

  * - 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>

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The resulting configuration model invocation.


      .. 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:`"The configuration returned will always be in the same format of the parameters above.\\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>

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

      :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The configuration prior to the model invocation.


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

      :ansible-option-returned-bold:`Returned:` always

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

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"The configuration returned will always be in the same format of the parameters above.\\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>

      .. rst-class:: 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:` always

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

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["interface ge1", "ip ospf 10 area 30", "ip ospf cost 5", "ip ospf priority 25"]`


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Mahdi Varasteh (@m-varasteh)



.. Extra links

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

.. raw:: html

  <p class="ansible-links">
    <a href="http://soodar.ir/issue/tracker" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
    <a href="http://soodar.ir" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
  </p>

.. Parsing errors