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

Note

This module is part of the amnesh.soodar collection (version 2.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install https://soodar.ir/ansible/amnesh.soodar.tar.gz.

To use it in a playbook, specify: amnesh.soodar.soodar_facts.

Synopsis

  • 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 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 action plugin.

Parameters

Parameter

Comments

available_network_resources

boolean

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

Choices:

  • false ← (default)

  • true

gather_network_resources

list / elements=string

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

gather_subset

list / elements=string

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

Possible values for this argument include all, config, and interfaces.

Specify a list of values to include a larger subset.

Use a value with an initial ! to collect all facts except that subset.

Default: ["!config"]

Notes

Note

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

ansible_net_gather_network_resources

list / elements=string

The list of fact for network resource subsets collected from the device

Returned: when the resource is configured

ansible_net_gather_subset

list / elements=string

The list of fact subsets collected from the device

Returned: always

Authors

  • Peter Sprygada (@privateip)

  • Sumit Jaiswal (@justjais)

  • Mahdi Varasteh (@m-varasteh)