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

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

amnesh.soodar.soodar_config module -- Manage Amnesh Soodar configuration sections
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

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

.. version_added

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

New in amnesh.soodar 1.0.0

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

.. Deprecated


Synopsis
--------

.. Description

- Amnesh Soodar configurations use a simple block indent file syntax for segmenting configuration into sections.  This module provides an implementation for working with Soodar configuration sections in a deterministic way.

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

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-after:

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

      **after**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-after" title="Permalink to this option"></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 ordered set of commands to append to the end of the command stack if a change needs to be made.  Just like with \ :emphasis:`before`\  this allows the playbook designer to append a set of commands to be executed after the command set.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-backup:

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

      **backup**

      .. raw:: html

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

      This argument will cause the module to create a full backup of the current \ :literal:`running-config`\  from the remote device before any changes are made. If the \ :literal:`backup\_options`\  value is not given, the backup file is written to the \ :literal:`backup`\  folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.


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

      :ansible-option-choices:`Choices:`

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


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-backup_options:

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

      **backup_options**

      .. raw:: html

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

      This is a dict object containing configurable options related to backup file path. The value of this option is read only when \ :literal:`backup`\  is set to \ :emphasis:`yes`\ , if \ :literal:`backup`\  is set to \ :emphasis:`no`\  this option will be silently ignored.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-backup_options/dir_path"></div>

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-backup_options/dir_path:

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

      **dir_path**

      .. raw:: html

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

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

      :ansible-option-type:`path`

      .. raw:: html

        </div>

    - .. raw:: html

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

      This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of \ :literal:`filename`\  or default filename as described in \ :literal:`filename`\  options description. If the path value is not given in that case a \ :emphasis:`backup`\  directory will be created in the current working directory and backup configuration will be copied in \ :literal:`filename`\  within \ :emphasis:`backup`\  directory.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-backup_options/filename"></div>

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-backup_options/filename:

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

      **filename**

      .. raw:: html

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

      The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by \<hostname\>\_config.\<current-date\>@\<current-time\>


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-before:

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

      **before**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-before" title="Permalink to this option"></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 ordered set of commands to push on to the command stack if a change needs to be made.  This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-diff_against:

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

      **diff_against**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-diff_against" 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">

      When using the \ :literal:`ansible-playbook --diff`\  command line argument the module can generate diffs against different sources.

      When this option is configure as \ :emphasis:`startup`\ , the module will return the diff of the running-config against the startup-config.

      When this option is configured as \ :emphasis:`intended`\ , the module will return the diff of the running-config against the configuration provided in the \ :literal:`intended\_config`\  argument.

      When this option is configured as \ :emphasis:`running`\ , the module will return the before and after diff of the running-config with respect to any changes made to the device configuration.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"running"`
      - :ansible-option-choices-entry:`"startup"`
      - :ansible-option-choices-entry:`"intended"`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-diff_ignore_lines:

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

      **diff_ignore_lines**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-diff_ignore_lines" title="Permalink to this option"></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">

      Use this argument to specify one or more lines that should be ignored during the diff.  This is used for lines in the configuration that are automatically updated by the system.  This argument takes a list of regular expressions or exact line matches.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-intended_config:

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

      **intended_config**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-intended_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">

      The \ :literal:`intended\_config`\  provides the master configuration that the node should conform to and is used to check the final running-config against. This argument will not modify any settings on the remote device and is strictly used to check the compliance of the current device's configuration against.  When specifying this argument, the task should also modify the \ :literal:`diff\_against`\  value and set it to \ :emphasis:`intended`\ . The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-commands:
      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-lines:

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

      **lines**

      .. raw:: html

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

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

      :ansible-option-aliases:`aliases: commands`

      .. 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 ordered set of commands that should be configured in the section. The commands must be the exact same commands as found in the device running-config to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-match:

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

      **match**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-match" 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">

      Instructs the module on the way to perform the matching of the set of commands against the current device config.  If match is set to \ :emphasis:`line`\ , commands are matched line by line.  If match is set to \ :emphasis:`strict`\ , command lines are matched with respect to position.  If match is set to \ :emphasis:`exact`\ , command lines must be an equal match.  Finally, if match is set to \ :emphasis:`none`\ , the module will not attempt to compare the source configuration with the running configuration on the remote device.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"line"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"strict"`
      - :ansible-option-choices-entry:`"exact"`
      - :ansible-option-choices-entry:`"none"`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-parents:

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

      **parents**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-parents" title="Permalink to this option"></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 ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against.  If the parents argument is omitted, the commands are checked against the set of top level or global commands.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-replace:

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

      **replace**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-replace" 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">

      Instructs the module on the way to perform the configuration on the device. If the replace argument is set to \ :emphasis:`line`\  then the modified lines are pushed to the device in configuration mode.  If the replace argument is set to \ :emphasis:`block`\  then the entire command block is pushed to the device in configuration mode if any line is not correct.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"line"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"block"`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-config:
      .. _ansible_collections.amnesh.soodar.soodar_config_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-aliases:`aliases: config`

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

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook.  The \ :emphasis:`running\_config`\  argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-save_when:

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

      **save_when**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-save_when" 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">

      When changes are made to the device running-configuration, the changes are not copied to non-volatile storage by default.  Using this argument will change that before.  If the argument is set to \ :emphasis:`always`\ , then the running-config will always be copied to the startup-config and the \ :emphasis:`modified`\  flag will always be set to True.  If the argument is set to \ :emphasis:`modified`\ , then the running-config will only be copied to the startup-config if it has changed since the last save to startup-config.  If the argument is set to \ :emphasis:`never`\ , the running-config will never be copied to the startup-config.  If the argument is set to \ :emphasis:`changed`\ , then the running-config will only be copied to the startup-config if the task has made a change. \ :emphasis:`changed`\  was added in Ansible 2.5.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"always"`
      - :ansible-option-choices-entry-default:`"never"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"modified"`
      - :ansible-option-choices-entry:`"changed"`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__parameter-src:

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

      **src**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-src" 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">

      Specifies the source path to the file that contains the configuration or configuration template to load.  The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with \ :emphasis:`lines`\ , \ :emphasis:`parents`\ . The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff.


      .. raw:: html

        </div>


.. Attributes


.. Notes

Notes
-----

.. note::
   - Tested against Soodar 21.04
   - Abbreviated commands are NOT idempotent.
   - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation.

.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    - name: configure top level configuration
      amnesh.soodar.soodar_config:
        lines: hostname {{ inventory_hostname }}

    - name: configure interface settings
      amnesh.soodar.soodar_config:
        lines:
        - description test interface
        - ip address 172.31.1.1/24
        parents: interface ge1

    - name: configure ip MTU on multiple interfaces
      amnesh.soodar.soodar_config:
        lines:
        - ip mtu 2000
        parents: '{{ item }}'
      with_items:
      - interface ge1
      - interface ge2
      - interface tunnel20

    - name: configure policer in Scavenger class
      amnesh.soodar.soodar_config:
        lines:
        - police cir 64000 conform-action transmit exceed-action drop
        parents:
        - policy-map Foo
        - class Scavenger

    - name: load new acl into device
      amnesh.soodar.soodar_config:
        lines:
        - 10 permit ip 192.0.2.1/24 any
        - 20 permit ip 192.0.2.2/24 any
        - 30 permit ip 192.0.2.3/24 any
        - 40 permit ip 192.0.2.4/24 any
        - 50 permit ip 192.0.2.5/24 any
        parents: ip access-list test
        before: no ip access-list test
        match: exact

    - name: check the running-config against master config
      amnesh.soodar.soodar_config:
        diff_against: intended
        intended_config: "{{ lookup('file', 'master.cfg') }}"

    - name: check the startup-config against the running-config
      amnesh.soodar.soodar_config:
        diff_against: startup
        diff_ignore_lines:
        - ntp server .*

    - name: save running to startup when modified
      amnesh.soodar.soodar_config:
        save_when: modified

    - name: for idempotency, use full-form commands
      amnesh.soodar.soodar_config:
        lines:
          # - shut
        - shutdown
        parents: interface ge1

    - name: render a Jinja2 template onto a Soodar device
      amnesh.soodar.soodar_config:
        backup: yes
        src: ios_template.j2

    - name: configurable backup path
      amnesh.soodar.soodar_config:
        src: ios_template.j2
        backup: yes
        backup_options:
          filename: backup.cfg
          dir_path: /home/user




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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__return-backup_path:

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

      **backup_path**

      .. raw:: html

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

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

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The full path to the backup file


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

      :ansible-option-returned-bold:`Returned:` when backup is yes

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

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"/playbooks/ansible/backup/ios\_config.2016-07-16@22:28:34"`


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_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 that will be 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:`["hostname foo", "router ospf 1", "router-id 192.0.2.1"]`


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__return-date:

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

      **date**

      .. raw:: html

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

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

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The date extracted from the backup file name


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

      :ansible-option-returned-bold:`Returned:` when backup is yes

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

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"2020-07-16"`


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__return-filename:

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

      **filename**

      .. raw:: html

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

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

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The name of the backup file


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

      :ansible-option-returned-bold:`Returned:` when backup is yes and filename is not specified in backup options

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

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"ios\_config.2016-07-16@22:28:34"`


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__return-shortname:

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

      **shortname**

      .. raw:: html

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

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

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The full path to the backup file excluding the timestamp


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

      :ansible-option-returned-bold:`Returned:` when backup is yes and filename is not specified in backup options

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

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"/playbooks/ansible/backup/ios\_config"`


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__return-time:

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

      **time**

      .. raw:: html

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

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

      :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      The time extracted from the backup file name


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

      :ansible-option-returned-bold:`Returned:` when backup is yes

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

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"22:28:34"`


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_config_module__return-updates:

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

      **updates**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-updates" 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 that will be 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:`["hostname foo", "router ospf 1", "router-id 192.0.2.1"]`


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