community.general.routeros_facts (0.1.1) — module

Collect facts from remote devices running MikroTik RouterOS

Authors: Egor Zaitsev (@heuels)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Collects a base set of device facts from a remote device that is running RotuerOS. This module prepends all of the base network fact keys with C(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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Collect all facts from the device
- routeros_facts:
    gather_subset: all
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Collect only the config and default facts
- routeros_facts:
    gather_subset:
      - config
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Do not collect hardware facts
- routeros_facts:
    gather_subset:
      - "!hardware"

Inputs

    
gather_subset:
    default: '!config'
    description:
    - When supplied, this argument will restrict the facts collected to a given subset.  Possible
      values for this argument include C(all), C(hardware), C(config), and C(interfaces).  Can
      specify a list of values to include a larger subset.  Values can also be used with
      an initial C(!) to specify that a specific subset should not be collected.
    required: false

Outputs

ansible_net_all_ipv4_addresses:
  description: All IPv4 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_all_ipv6_addresses:
  description: All IPv6 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_config:
  description: The current active config from the device
  returned: when config is configured
  type: str
ansible_net_gather_subset:
  description: The list of fact subsets collected from the device
  returned: always
  type: list
ansible_net_hostname:
  description: The configured hostname of the device
  returned: always
  type: str
ansible_net_interfaces:
  description: A hash of all interfaces running on the system
  returned: when interfaces is configured
  type: dict
ansible_net_memfree_mb:
  description: The available free memory on the remote device in MiB
  returned: when hardware is configured
  type: int
ansible_net_memtotal_mb:
  description: The total memory on the remote device in MiB
  returned: when hardware is configured
  type: int
ansible_net_model:
  description: The model name returned from the device
  returned: always
  type: str
ansible_net_neighbors:
  description: The list of neighbors from the remote device
  returned: when interfaces is configured
  type: dict
ansible_net_serialnum:
  description: The serial number of the remote device
  returned: always
  type: str
ansible_net_spacefree_mb:
  description: The available disk space on the remote device in MiB
  returned: when hardware is configured
  type: dict
ansible_net_spacetotal_mb:
  description: The total disk space on the remote device in MiB
  returned: when hardware is configured
  type: dict
ansible_net_version:
  description: The operating system version running on the remote device
  returned: always
  type: str