.. Document meta

:orphan:

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

.. meta::
  :antsibull-docs: 2.23.0

.. Anchors

.. _ansible_collections.amnesh.soodar.soodar_cliconf:

.. Anchors: short name for ansible.builtin

.. Title

amnesh.soodar.soodar cliconf -- Use soodar cliconf to run command on Amnesh Soodar platform
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This cliconf plugin 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`.

.. version_added


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

.. Deprecated


Synopsis
--------

.. Description

- This soodar plugin provides low level abstraction apis for sending and receiving CLI commands from Amnesh Soodar network devices.


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

      .. _ansible_collections.amnesh.soodar.soodar_cliconf__parameter-config_commands:

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

      **config_commands**

      .. raw:: html

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

      .. ansible-option-type-line::

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




      .. raw:: html

        </div>

    - .. raw:: html

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

      Specifies a list of commands that can make configuration changes to the target device.

      When \`ansible\_network\_single\_user\_mode\` is enabled, if a command sent to the device is present in this list, the existing cache is invalidated.


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

      :ansible-option-default-bold:`Default:` :ansible-option-default:`[]`

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

      :ansible-option-configuration:`Configuration:`

      - Variable: ansible\_soodar\_config\_commands


      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso


.. Examples



.. Facts


.. Return values


..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Ansible Networking Team


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