.. Document meta

:orphan:

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

.. meta::
  :antsibull-docs: 2.23.0

.. Anchors

.. _ansible_collections.amnesh.soodar.soodar_interfaces_module:

.. Anchors: short name for ansible.builtin

.. Title

amnesh.soodar.soodar_interfaces module -- Manages interface attributes of Amnesh Soodar network devices
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

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

.. version_added


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

.. Deprecated


Synopsis
--------

.. Description

- This module manages the interface attributes of Amnesh Soodar network devices.

.. note::
    This module has a corresponding :ref:`action plugin <action_plugins>`.

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


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. raw:: latex

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

      .. _ansible_collections.amnesh.soodar.soodar_interfaces_module__parameter-config/description:

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

      **description**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/description" 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-cell">

      Interface description.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. raw:: latex

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

      .. _ansible_collections.amnesh.soodar.soodar_interfaces_module__parameter-config/enabled:

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

      **enabled**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/enabled" 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-cell">

      Administrative state of the interface.

      Set the value to :literal:`true` to administratively enable the interface or :literal:`false` to disable it.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. raw:: latex

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

      .. _ansible_collections.amnesh.soodar.soodar_interfaces_module__parameter-config/mac_address:

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

      **mac_address**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/mac_address" 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-cell">

      H.H.H MAC address.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. raw:: latex

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

      .. _ansible_collections.amnesh.soodar.soodar_interfaces_module__parameter-config/mtu:

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

      **mtu**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/mtu" 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-cell">

      MTU for a specific interface. Must be a number between 64 and 9600. Applicable for Ethernet interfaces only.


      .. 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_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 interface, e.g. ge0, tunnel20.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. raw:: latex

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

      .. _ansible_collections.amnesh.soodar.soodar_interfaces_module__parameter-config/service_policy:

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

      **service_policy**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/service_policy" 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-cell">

      Service policy configuration


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

      .. raw:: latex

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

      .. _ansible_collections.amnesh.soodar.soodar_interfaces_module__parameter-config/service_policy/input:

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

      **input**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/service_policy/input" 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-cell">

      Assign policy\-map to the input of an 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/service_policy/output"></div>

      .. raw:: latex

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

      .. _ansible_collections.amnesh.soodar.soodar_interfaces_module__parameter-config/service_policy/output:

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

      **output**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/service_policy/output" 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-cell">

      Assign policy\-map to the output of an interface


      .. raw:: html

        </div>



  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_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:`show 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_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 \| include 'ip route\|ipv6 route'` executed on device. For state :emphasis:`parsed` active connection to remote host is not required.

      The state :emphasis:`purged` negates virtual/logical interfaces that are specified in task from running\-config.


      .. 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:`"rendered"`
      - :ansible-option-choices-entry:`"gathered"`
      - :ansible-option-choices-entry:`"purged"`
      - :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`.
   - The module examples uses callback plugin (stdout\_callback = yaml) to generate task output in yaml format.

.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    # Using merged

    # Before state:
    # -------------
    #
    # Router# sh running-config | section interface
    # interface loopback888
    #  no ip address
    # interface loopback999
    #  no ip address
    # interface ge1
    #  ip address dhcp
    # interface ge2
    #  description Configured and Merged by Ansible Network
    #  ip address dhcp
    #  speed 1000
    # interface ge3
    #  no ip address
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown

    - name: Merge provided configuration with device configuration
      amnesh.soodar.soodar_interfaces:
        config:
          - name: ge2
            description: Configured and Merged by Ansible Network
            enabled: true
          - name: ge3
            description: Configured and Merged by Ansible Network
            mtu: 3800
            enabled: false
            speed: 100
        state: merged

    # Task Output
    # -----------
    #
    # before:
    # - enabled: true
    #   name: ge1
    # - description: Configured and Merged by Ansible Network
    #   enabled: true
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Merged by Ansible Network
    #   enabled: false
    #   mtu: 3800
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: true
    #   name: loopback888
    # - enabled: true
    #   name: loopback999
    # commands:
    # - interface ge3
    # - description Configured and Merged by Ansible Network
    # - speed 100
    # - mtu 3800
    # - shutdown
    # after:
    # - enabled: true
    #   name: ge1
    # - description: Configured and Merged by Ansible Network
    #   enabled: true
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Merged by Ansible Network
    #   enabled: true
    #   mtu: 2800
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: true
    #   name: loopback888
    # - enabled: true
    #   name: loopback999

    # After state:
    # ------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    # interface loopback999
    #  no ip address
    # interface ge1
    #  ip address dhcp
    # interface ge2
    #  description Configured and Merged by Ansible Network
    #  ip address dhcp
    #  speed 1000
    # interface ge3
    #  description Configured and Merged by Ansible Network
    #  mtu 3800
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown

    # Using merged - with mode attribute

    # Before state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface ge1
    #  description Configured by Ansible
    # interface ge2
    #  description This is test
    # interface ge3
    #  description This is test

    - name: Merge provided configuration with device configuration
      amnesh.soodar.soodar_interfaces:
        config:
          - name: ge2
            description: Configured and Merged by Ansible Network
            enabled: true
          - name: ge3
            description: Configured and Merged by Ansible Network
        state: merged

    # Task Output
    # -----------
    #
    # before:
    # - enabled: true
    #   name: ge1
    # - description: Configured and Merged by Ansible Network
    #   name: ge2
    # - description: Configured and Merged by Ansible Network
    #   name: ge3
    # commands:
    # - interface ge2
    # - description Configured and Merged by Ansible Network
    # - interface ge3
    # - description Configured and Merged by Ansible Network
    # after:
    # - enabled: true
    #   name: ge1
    # - description: Configured and Merged by Ansible Network
    #   enabled: true
    #   name: ge2
    # - description: Configured and Merged by Ansible Network
    #   name: ge3

    # After state:
    # ------------
    #
    # Router# show running-config | section ^interface
    # interface ge1
    #  description Configured by Ansible
    # interface ge2
    #  description Configured and Merged by Ansible Network
    # interface ge3
    #  description Configured and Merged by Ansible Network

    # Using replaced

    # Before state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    # interface loopback999
    #  no ip address
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  ip address dhcp
    #  speed 1000
    # interface ge3
    #  no ip address
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown
    #  negotiation auto
    # interface ge0.50
    #  ip address dhcp

    - name: Replaces device configuration of listed interfaces with provided configuration
      amnesh.soodar.soodar_interfaces:
        config:
          - name: ge3
            description: Configured and Replaced by Ansible Network
            enabled: false
            speed: 1000
        state: replaced

    # Task Output
    # -----------
    #
    # before:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: true
    #   name: ge2
    #   speed: '1000'
    # - enabled: true
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: true
    #   name: loopback888
    # - enabled: true
    #   name: loopback999
    # - enabled: true
    #   name: ge0.50
    # commands:
    # - interface ge3
    # - description Configured and Replaced by Ansible Network
    # - shutdown
    # after:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: true
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Replaced by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: true
    #   name: loopback888
    # - enabled: true
    #   name: loopback999
    # - enabled: true
    #   name: ge0.50

    # After state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    # interface loopback999
    #  no ip address
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  ip address dhcp
    #  speed 1000
    # interface ge3
    #  description Configured and Replaced by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown
    # interface ge0.50
    #  ip address dhcp

    # Using overridden

    # Before state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    # interface loopback999
    #  no ip address
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  ip address dhcp
    #  speed 1000
    # interface ge3
    #  description Configured and Replaced by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown
    # interface ge0.50
    #  ip address dhcp

    - name: Override device configuration of all interfaces with provided configuration
      amnesh.soodar.soodar_interfaces:
        config:
          - description: Management interface do not change
            enabled: true
            name: ge1
          - name: ge2
            description: Configured and Overridden by Ansible Network
            speed: 10000
          - name: ge3
            description: Configured and Overridden by Ansible Network
            enabled: false
        state: overridden

    # Task Output
    # -----------
    #
    # before:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: true
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Replaced by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: true
    #   name: loopback888
    # - enabled: true
    #   name: loopback999
    # - enabled: true
    #   name: ge0.50
    # commands:
    # - interface loopback888
    # - shutdown
    # - interface loopback999
    # - shutdown
    # - interface ge0.50
    # - shutdown
    # - interface ge2
    # - description Configured and Overridden by Ansible Network
    # - speed 10000
    # - interface ge3
    # - description Configured and Overridden by Ansible Network
    # - no speed 1000
    # after:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - description: Configured and Overridden by Ansible Network
    #   enabled: true
    #   name: ge2
    #   speed: '10000'
    # - description: Configured and Overridden by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: false
    #   name: loopback888
    # - enabled: false
    #   name: loopback999
    # - enabled: false
    #   name: ge0.50

    # After state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    #  shutdown
    # interface loopback999
    #  no ip address
    #  shutdown
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  description Configured and Overridden by Ansible Network
    #  ip address dhcp
    #  speed 10000
    # interface ge3
    #  description Configured and Overridden by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown
    # interface ge0.50
    #  ip address dhcp hostname testHostname
    #  shutdown

    # Using Deleted

    # Before state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    #  shutdown
    # interface loopback999
    #  no ip address
    #  shutdown
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  description Configured and Overridden by Ansible Network
    #  ip address dhcp
    #  speed 10000
    # interface ge3
    #  description Configured and Overridden by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown
    # interface ge0.50
    #  ip address dhcp hostname testHostname
    #  shutdown

    - name: "Delete interface attributes (Note: This won't delete the interface itself)"
      amnesh.soodar.soodar_interfaces:
        config:
          - name: ge2
        state: deleted

    # Task Output
    # -----------
    #
    # before:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - description: Configured and Overridden by Ansible Network
    #   enabled: true
    #   name: ge2
    #   speed: '10000'
    # - description: Configured and Overridden by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: false
    #   name: loopback888
    # - enabled: false
    #   name: loopback999
    # - enabled: false
    #   name: ge0.50
    # commands:
    # - interface ge2
    # - no description Configured and Overridden by Ansible Network
    # - no speed 10000
    # - shutdown
    # after:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: false
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Overridden by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: false
    #   name: loopback888
    # - enabled: false
    #   name: loopback999
    # - enabled: false
    #   name: ge0.50

    # After state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    #  shutdown
    # interface loopback999
    #  no ip address
    #  shutdown
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    #  negotiation auto
    # interface ge2
    #  ip address dhcp
    #  shutdown
    # interface ge3
    #  description Configured and Overridden by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    #  no negotiation auto
    # interface ge4
    #  no ip address
    #  shutdown
    #  negotiation auto
    # interface ge0.50
    #  ip address dhcp
    #  shutdown

    # Using Purged

    # Before state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback888
    #  no ip address
    #  shutdown
    # interface loopback999
    #  no ip address
    #  shutdown
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  ip address dhcp
    #  shutdown
    #  speed 1000
    # interface ge3
    #  description Configured and Overridden by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown
    # interface ge0.50
    #  ip address dhcp
    #  shutdown

    - name: "Purge given interfaces (Note: This will delete the interface itself)"
      amnesh.soodar.soodar_interfaces:
        config:
          - name: loopback888
          - name: ge0.50
        state: purged

    # Task Output
    # -----------
    #
    # before:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: false
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Overridden by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: false
    #   name: loopback888
    # - enabled: false
    #   name: loopback999
    # - enabled: false
    #   name: ge0.50
    # commands:
    # - no interface loopback888
    # - no interface ge0.50
    # after:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: false
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Overridden by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: false
    #   name: loopback999

    # After state:
    # -------------
    #
    # Router# show running-config | section ^interface
    # interface loopback999
    #  no ip address
    #  shutdown
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  ip address dhcp
    #  shutdown
    #  speed 1000
    # interface ge3
    #  description Configured and Overridden by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown

    # Using gathered

    # Before state:
    # -------------
    #
    # Router# sh running-config | section ^interface
    # interface loopback999
    #  no ip address
    #  shutdown
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  ip address dhcp
    #  shutdown
    #  speed 1000
    # interface ge3
    #  description Configured and Overridden by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown

    - name: Gather facts of interfaces
      amnesh.soodar.soodar_interfaces:
        config:
        state: gathered

    # Task Output
    # -----------
    #
    # gathered:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: false
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Overridden by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: false
    #   name: loopback999

    # Using rendered

    - name: Render the commands for provided configuration
      amnesh.soodar.soodar_interfaces:
        config:
          - name: ge1
            description: Configured by Ansible-Network
            mtu: 110
            enabled: true
          - name: ge2
            description: Configured by Ansible-Network
            mtu: 2800
            enabled: false
            speed: 100
        state: rendered

    # Task Output
    # -----------
    #
    # rendered:
    # - interface ge1
    # - description Configured by Ansible-Network
    # - mtu 110
    # - no shutdown
    # - interface ge2
    # - description Configured by Ansible-Network
    # - speed 100
    # - mtu 2800
    # - shutdown

    # Using parsed

    # File: parsed.cfg
    # ----------------
    #
    # interface loopback999
    #  no ip address
    #  shutdown
    # interface ge1
    #  description Management interface do not change
    #  ip address dhcp
    # interface ge2
    #  ip address dhcp
    #  shutdown
    #  speed 1000
    # interface ge3
    #  description Configured and Overridden by Ansible Network
    #  no ip address
    #  shutdown
    #  speed 1000
    # interface ge4
    #  no ip address
    #  shutdown

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

    # Task Output
    # -----------
    #
    # parsed:
    # - description: Management interface do not change
    #   enabled: true
    #   name: ge1
    # - enabled: false
    #   name: ge2
    #   speed: '1000'
    # - description: Configured and Overridden by Ansible Network
    #   enabled: false
    #   name: ge3
    #   speed: '1000'
    # - enabled: false
    #   name: ge4
    # - enabled: false
    #   name: loopback999



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

- Sumit Jaiswal (@justjais)
- Sagar Paul (@KB-perByte)
- 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