Support: partial
+
Support: partial
The module claims to support check mode, but it simply always executes the command.
|
Can run in check_mode and return changed status prediction without modifying target.
@@ -242,7 +245,7 @@
|
-Support: none
+ |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.
|
@@ -250,7 +253,7 @@
|
-Platform:Β RouterOS
+ |
Target OS/families that can be operated against.
|
@@ -310,7 +313,7 @@
Common return values are documented here, the following are the fields unique to this module:
-
+
Key |
Description |
@@ -322,8 +325,8 @@
list / elements=string
The list of conditionals that have failed
- Returned: failed
- Sample: ["...", "..."]
+ Returned: failed
+ Sample: ["...", "..."]
|
|---|
@@ -331,8 +334,8 @@
list / elements=string
|
The set of responses from the commands
- Returned: always apart from low level errors (such as action plugin)
- Sample: ["...", "..."]
+ Returned: always apart from low level errors (such as action plugin)
+ Sample: ["...", "..."]
|
@@ -340,8 +343,8 @@
list / elements=string
|
The value of stdout split into a list
- Returned: always apart from low level errors (such as action plugin)
- Sample: [["...", "..."], ["..."], ["..."]]
+ Returned: always apart from low level errors (such as action plugin)
+ Sample: [["...", "..."], ["..."], ["..."]]
|
@@ -354,13 +357,14 @@
+
+
diff --git a/branch/main/environment_variables.html b/branch/main/environment_variables.html
index a7fcce7..be529c0 100644
--- a/branch/main/environment_variables.html
+++ b/branch/main/environment_variables.html
@@ -2,6 +2,7 @@
+
Index of all Collection Environment Variables — Community.Routeros Collection documentation
diff --git a/branch/main/facts_module.html b/branch/main/facts_module.html
index 1342101..57921d9 100644
--- a/branch/main/facts_module.html
+++ b/branch/main/facts_module.html
@@ -2,6 +2,7 @@
+
community.routeros.facts module β Collect facts from remote devices running MikroTik RouterOS — Community.Routeros Collection documentation
@@ -144,6 +145,8 @@
Note
This module is part of the community.routeros collection (version 2.10.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 community.routeros.
To use it in a playbook, specify: community.routeros.facts.
@@ -165,7 +168,7 @@
-
+
Parameter |
Comments |
@@ -178,7 +181,7 @@
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, interfaces, and routing.
Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
- Default: ["!config"]
+ Default: ["!config"]
|
|---|
@@ -186,7 +189,7 @@
-
+
Attribute |
Support |
@@ -197,7 +200,7 @@
|---|
|
-Support: full
+ Support: full
This action does not modify state.
|
Can run in check_mode and return changed status prediction without modifying target.
@@ -206,7 +209,7 @@
|
-Support: N/A
+ Support: N/A
This action does not modify state.
|
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.
@@ -215,7 +218,7 @@
|
-Support: full
+ |
Action returns an ansible_facts dictionary that will update existing host facts.
|
@@ -223,7 +226,7 @@
|
-Platform:Β RouterOS
+ |
Target OS/families that can be operated against.
|
@@ -262,7 +265,7 @@
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 |
@@ -274,7 +277,7 @@
list / elements=string
All IPv4 addresses configured on the device.
- Returned: gather_subset contains interfaces
+ Returned: gather_subset contains interfaces
|
|---|
@@ -282,7 +285,7 @@
list / elements=string
|
All IPv6 addresses configured on the device.
- Returned: gather_subset contains interfaces
+ Returned: gather_subset contains interfaces
|
@@ -290,7 +293,7 @@
string
|
|
@@ -298,7 +301,7 @@
dictionary
|
|
@@ -306,7 +309,7 @@
dictionary
|
|
@@ -314,7 +317,7 @@
dictionary
|
A dictionary with BGP vpnv4 route information.
- Returned: gather_subset contains routing
+ Returned: gather_subset contains routing
|
@@ -322,17 +325,17 @@
string
|
|
string
- added in community.routeros 1.2.0
+ added in community.routeros 1.2.0
|
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 /export and stripping the timestamp from the comment in the first line.
- Returned: gather_subset contains config
+ Returned: gather_subset contains config
|
@@ -340,7 +343,7 @@
string
|
|
@@ -348,7 +351,7 @@
list / elements=string
|
The list of fact subsets collected from the device.
- Returned: always
+ Returned: always
|
@@ -356,7 +359,7 @@
string
|
|
@@ -364,7 +367,7 @@
dictionary
|
A hash of all interfaces running on the system.
- Returned: gather_subset contains interfaces
+ Returned: gather_subset contains interfaces
|
@@ -372,7 +375,7 @@
integer
|
The available free memory on the remote device in MiB.
- Returned: gather_subset contains hardware
+ Returned: gather_subset contains hardware
|
@@ -380,7 +383,7 @@
integer
|
The total memory on the remote device in MiB.
- Returned: gather_subset contains hardware
+ Returned: gather_subset contains hardware
|
@@ -388,7 +391,7 @@
string
|
|
@@ -396,7 +399,7 @@
dictionary
|
The list of neighbors from the remote device.
- Returned: gather_subset contains interfaces
+ Returned: gather_subset contains interfaces
|
@@ -404,7 +407,7 @@
dictionary
|
|
@@ -412,7 +415,7 @@
dictionary
|
|
@@ -420,7 +423,7 @@
dictionary
|
A dictionary for routes in all routing tables.
- Returned: gather_subset contains routing
+ Returned: gather_subset contains routing
|
@@ -428,7 +431,7 @@
string
|
|
@@ -436,7 +439,7 @@
dictionary
|
The available disk space on the remote device in MiB.
- Returned: gather_subset contains hardware
+ Returned: gather_subset contains hardware
|
@@ -444,7 +447,7 @@
dictionary
|
The total disk space on the remote device in MiB.
- Returned: gather_subset contains hardware
+ Returned: gather_subset contains hardware
|
@@ -452,7 +455,7 @@
string
|
|
@@ -460,7 +463,7 @@
string
|
The operating system version running on the remote device.
- Returned: gather_subset contains default
+ Returned: gather_subset contains default
|
@@ -473,13 +476,14 @@
+
+
diff --git a/branch/main/index.html b/branch/main/index.html
index 9804706..9f5394e 100644
--- a/branch/main/index.html
+++ b/branch/main/index.html
@@ -2,6 +2,7 @@
+
Community.Routeros — Community.Routeros Collection documentation
@@ -148,12 +149,13 @@
-
- Issue Tracker
- Repository (Sources)
- Submit a bug report
- Request a feature
-
+
+
diff --git a/branch/main/join_filter.html b/branch/main/join_filter.html
index 9efc402..af360fa 100644
--- a/branch/main/join_filter.html
+++ b/branch/main/join_filter.html
@@ -2,6 +2,7 @@
+
community.routeros.join filter β Join a list of arguments to a command — Community.Routeros Collection documentation
@@ -142,6 +143,8 @@
Note
This filter plugin is part of the community.routeros collection (version 2.10.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 community.routeros.
To use it in a playbook, specify: community.routeros.join.
@@ -163,7 +166,7 @@
| | | | | | | | |