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

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

amnesh.soodar.soodar_facts module -- Collect facts from remote devices running Amnesh SoodarOS
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

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

.. version_added

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

New in amnesh.soodar 1.0.0

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

.. Deprecated


Synopsis
--------

.. Description

- Collects a base set of device facts from a remote device that is running Soodar.  This module prepends all of the base network fact keys with \ :literal:`ansible\_net\_\<fact\>`\ .  The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__parameter-available_network_resources:

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

      **available_network_resources**

      .. raw:: html

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

      When 'True' a list of network resources for which resource modules are available will be provided.


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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__parameter-gather_network_resources:

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

      **gather_network_resources**

      .. raw:: html

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

      When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces, acls etc. Can specify a list of values to include a larger subset. Values can also be used with an initial \ :literal:`M(!`\ ) to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'ospfv2', 'ospf\_interfaces' 'l3\_interfaces', 'acl\_interfaces', 'static\_routes', 'acls'.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__parameter-gather_subset:

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

      **gather_subset**

      .. raw:: html

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

      When supplied, this argument restricts the facts collected to a given subset.

      Possible values for this argument include \ :literal:`all`\ , \ :literal:`config`\ , and \ :literal:`interfaces`\ .

      Specify a list of values to include a larger subset.

      Use a value with an initial \ :literal:`!`\  to collect all facts except that subset.


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

      :ansible-option-default-bold:`Default:` :ansible-option-default:`["!config"]`

      .. raw:: html

        </div>


.. Attributes


.. Notes

Notes
-----

.. note::
   - Tested against SoodarOS 21.04

.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    - name: Gather all legacy facts
      amnesh.soodar.soodar_facts:
        gather_subset: all

    - name: Gather only the config and default facts
      amnesh.soodar.soodar_facts:
        gather_subset:
        - config

    - name: Do not gather interface facts
      amnesh.soodar.soodar_facts:
        gather_subset:
        - '!interfaces'

    - name: Gather legacy and resource facts
      amnesh.soodar.soodar_facts:
        gather_subset: all
        gather_network_resources: all

    - name: Gather only the interfaces resource facts and no legacy facts
      amnesh.soodar.soodar_facts:
        gather_subset:
        - '!all'
        - '!min'
        gather_network_resources:
        - interfaces

    - name: Gather interfaces resource and minimal legacy facts
      amnesh.soodar.soodar_facts:
        gather_subset: min
        gather_network_resources: interfaces

    - name: Gather L2 interfaces resource and minimal legacy facts
      amnesh.soodar.soodar_facts:
        gather_subset: min
        gather_network_resources: ospf_interfaces

    - name: Gather L3 interfaces resource and minimal legacy facts
      amnesh.soodar.soodar_facts:
        gather_subset: min
        gather_network_resources: l3_interfaces






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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_all_ipv4_addresses:

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

      **ansible_net_all_ipv4_addresses**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_all_ipv4_addresses" 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">

      All IPv4 addresses configured on the device


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

      :ansible-option-returned-bold:`Returned:` when interfaces is configured


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_all_ipv6_addresses:

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

      **ansible_net_all_ipv6_addresses**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_all_ipv6_addresses" 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">

      All IPv6 addresses configured on the device


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

      :ansible-option-returned-bold:`Returned:` when interfaces is configured


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_api:

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

      **ansible_net_api**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_api" 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 transport


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_config:

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

      **ansible_net_config**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_config" 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 current active config from the device


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

      :ansible-option-returned-bold:`Returned:` when config is configured


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_gather_network_resources:

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

      **ansible_net_gather_network_resources**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_gather_network_resources" 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 list of fact for network resource subsets collected from the device


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

      :ansible-option-returned-bold:`Returned:` when the resource is configured


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_gather_subset:

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

      **ansible_net_gather_subset**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_gather_subset" 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 list of fact subsets collected from the device


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_hostname:

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

      **ansible_net_hostname**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_hostname" 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 configured hostname of the device


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_interfaces:

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

      **ansible_net_interfaces**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_interfaces" 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">

      A hash of all interfaces running on the system


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

      :ansible-option-returned-bold:`Returned:` when interfaces is configured


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_model:

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

      **ansible_net_model**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_model" 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 model name returned from the device


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_python_version:

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

      **ansible_net_python_version**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_python_version" 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 Python version Ansible controller is using


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.amnesh.soodar.soodar_facts_module__return-ansible_net_version:

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

      **ansible_net_version**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_net_version" 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 operating system version running on the remote device


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

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


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