community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS
Note
This module is part of the community.routeros collection (version 2.5.0).
You might already have this collection installed if you are using the ansible
package.
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 community.routeros
.
To use it in a playbook, specify: community.routeros.facts
.
Synopsis
Collects a base set of device facts from a remote device that is running RouterOS. 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.
Parameters
Parameter |
Comments |
---|---|
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include Can specify a list of values to include a larger subset. Values can also be used with an initial Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
|
Support: full |
Action returns an |
|
Platform: RouterOS |
Target OS/families that can be operated against. |
See Also
See also
- How to connect to RouterOS devices with SSH
How to connect to RouterOS devices with SSH
Examples
- name: Collect all facts from the device
community.routeros.facts:
gather_subset: all
- name: Collect only the config and default facts
community.routeros.facts:
gather_subset:
- config
- name: Do not collect hardware facts
community.routeros.facts:
gather_subset:
- "!hardware"
Returned Facts
Facts returned by this module are added/updated in the hostvars
host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.
Key |
Description |
---|---|
All IPv4 addresses configured on the device. Returned: gather_subset contains |
|
All IPv6 addresses configured on the device. Returned: gather_subset contains |
|
The CPU architecture of the device. Returned: gather_subset contains |
|
A dictionary with BGP instance information. Returned: gather_subset contains |
|
A dictionary with BGP peer information. Returned: gather_subset contains |
|
A dictionary with BGP vpnv4 route information. Returned: gather_subset contains |
|
The current active config from the device. Returned: gather_subset contains |
|
The current active config from the device in minimal form. This value is idempotent in the sense that if the facts module is run twice and the device’s config was not changed between the runs, the value is identical. This is achieved by running Returned: gather_subset contains |
|
Current CPU load. Returned: gather_subset contains |
|
The list of fact subsets collected from the device. Returned: always |
|
The configured hostname of the device. Returned: gather_subset contains |
|
A hash of all interfaces running on the system. Returned: gather_subset contains |
|
The available free memory on the remote device in MiB. Returned: gather_subset contains |
|
The total memory on the remote device in MiB. Returned: gather_subset contains |
|
The model name returned from the device. Returned: gather_subset contains |
|
The list of neighbors from the remote device. Returned: gather_subset contains |
|
A dictionary with OSPF instances. Returned: gather_subset contains |
|
A dictionary with OSPF neighbors. Returned: gather_subset contains |
|
A dictionary for routes in all routing tables. Returned: gather_subset contains |
|
The serial number of the remote device. Returned: gather_subset contains |
|
The available disk space on the remote device in MiB. Returned: gather_subset contains |
|
The total disk space on the remote device in MiB. Returned: gather_subset contains |
|
The uptime of the device. Returned: gather_subset contains |
|
The operating system version running on the remote device. Returned: gather_subset contains |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication