mirror.MikroTik/ansible-collections.community.routeros
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.routeros.git synced 2025-08-19 09:08:20 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

deploy: eda8f64e8d

Browse source
This commit is contained in:
ytimenkov 2023-12-03 17:08:54 +00:00
parent 3dd6909177
commit 3998ab66a2
20 changed files with 217 additions and 156 deletions
Download patch file Download diff file Expand all files Collapse all files

18
pr/226/api_facts_module.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -145,7 +147,7 @@
<h1>community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API<a class="headerlink" href="#community-routeros-api-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros-using-the-api" title="Link to this heading"></a></h1> <h1>community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API<a class="headerlink" href="#community-routeros-api-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros-using-the-api" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>. <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.

18
pr/226/api_find_and_modify_module.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.api_find_and_modify module – Find and modify information using the API &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.api_find_and_modify module – Find and modify information using the API &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -146,7 +148,7 @@
<h1>community.routeros.api_find_and_modify module – Find and modify information using the API<a class="headerlink" href="#community-routeros-api-find-and-modify-module-find-and-modify-information-using-the-api" title="Link to this heading"></a></h1> <h1>community.routeros.api_find_and_modify module – Find and modify information using the API<a class="headerlink" href="#community-routeros-api-find-and-modify-module-find-and-modify-information-using-the-api" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>. <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.

26
pr/226/api_info_module.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.api_info module – Retrieve information from API &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.api_info module – Retrieve information from API &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -145,7 +147,7 @@
<h1>community.routeros.api_info module – Retrieve information from API<a class="headerlink" href="#community-routeros-api-info-module-retrieve-information-from-api" title="Link to this heading"></a></h1> <h1>community.routeros.api_info module – Retrieve information from API<a class="headerlink" href="#community-routeros-api-info-module-retrieve-information-from-api" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>. <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.
@ -375,6 +377,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">config&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">config&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">lease&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">lease&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">network&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">network&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">option&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">option</span> <span class="pre">sets&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns</span> <span class="pre">static&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns</span> <span class="pre">static&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">firewall</span> <span class="pre">address-list&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">firewall</span> <span class="pre">address-list&quot;</span></code></p></li>
@ -407,6 +411,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">ipfix&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">ipfix&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">target&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">target&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">upnp&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">upnp&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">upnp</span> <span class="pre">interfaces&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">address&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">address&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-client&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-client&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-server&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-server&quot;</span></code></p></li>
@ -423,14 +428,17 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls</span> <span class="pre">ldp&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls</span> <span class="pre">ldp&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;port</span> <span class="pre">firmware&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;port</span> <span class="pre">firmware&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;port</span> <span class="pre">remote-access&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">aaa&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">aaa&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">profile&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">profile&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">interface&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">interface&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">tree&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">tree&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;radius</span> <span class="pre">incoming&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;radius</span> <span class="pre">incoming&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">bgp</span> <span class="pre">connection&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">bgp</span> <span class="pre">instance&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">bgp</span> <span class="pre">instance&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">rule&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">rule&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">select-rule&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">select-rule&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">id&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">mme&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">mme&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area</span> <span class="pre">range&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area</span> <span class="pre">range&quot;</span></code></p></li>
@ -463,6 +471,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">bandwidth-server&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">bandwidth-server&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">e-mail&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">e-mail&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing</span> <span class="pre">interface&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing</span> <span class="pre">resource&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">mac-winbox&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">mac-winbox&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">ping&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">ping&quot;</span></code></p></li>

43
pr/226/api_modify_module.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.api_modify module – Modify data at paths with API &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.api_modify module – Modify data at paths with API &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -146,7 +148,7 @@
<h1>community.routeros.api_modify module – Modify data at paths with API<a class="headerlink" href="#community-routeros-api-modify-module-modify-data-at-paths-with-api" title="Link to this heading"></a></h1> <h1>community.routeros.api_modify module – Modify data at paths with API<a class="headerlink" href="#community-routeros-api-modify-module-modify-data-at-paths-with-api" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>. <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.
@ -374,6 +376,18 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">sstp-server</span> <span class="pre">server&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">sstp-server</span> <span class="pre">server&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">vlan&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">vlan&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">vrrp&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">vrrp&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">aaa&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">access-list&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">cap&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">capsman&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">channel&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">configuration&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">datapath&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">interworking&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">provisioning&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">security&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">steering&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireguard&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireguard&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireguard</span> <span class="pre">peers&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireguard</span> <span class="pre">peers&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless&quot;</span></code></p></li>
@ -382,11 +396,6 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless</span> <span class="pre">security-profiles&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless</span> <span class="pre">security-profiles&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless</span> <span class="pre">sniffer&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless</span> <span class="pre">sniffer&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless</span> <span class="pre">snooper&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wireless</span> <span class="pre">snooper&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">channel&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">configuration&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">datapath&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;interface</span> <span class="pre">wifiwave2</span> <span class="pre">security&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;iot</span> <span class="pre">modbus&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;iot</span> <span class="pre">modbus&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">accounting&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">accounting&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">accounting</span> <span class="pre">web-access&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">accounting</span> <span class="pre">web-access&quot;</span></code></p></li>
@ -400,6 +409,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">config&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">config&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">lease&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">lease&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">network&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">network&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">option&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dhcp-server</span> <span class="pre">option</span> <span class="pre">sets&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns</span> <span class="pre">static&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">dns</span> <span class="pre">static&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">firewall</span> <span class="pre">address-list&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">firewall</span> <span class="pre">address-list&quot;</span></code></p></li>
@ -432,6 +443,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">ipfix&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">ipfix&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">target&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">traffic-flow</span> <span class="pre">target&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">upnp&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">upnp&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ip</span> <span class="pre">upnp</span> <span class="pre">interfaces&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">address&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">address&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-client&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-client&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-server&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ipv6</span> <span class="pre">dhcp-server&quot;</span></code></p></li>
@ -448,14 +460,17 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls</span> <span class="pre">ldp&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;mpls</span> <span class="pre">ldp&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;port</span> <span class="pre">firmware&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;port</span> <span class="pre">firmware&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;port</span> <span class="pre">remote-access&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">aaa&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">aaa&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">profile&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ppp</span> <span class="pre">profile&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">interface&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">interface&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">tree&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;queue</span> <span class="pre">tree&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;radius</span> <span class="pre">incoming&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;radius</span> <span class="pre">incoming&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">bgp</span> <span class="pre">connection&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">bgp</span> <span class="pre">instance&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">bgp</span> <span class="pre">instance&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">rule&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">rule&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">select-rule&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">filter</span> <span class="pre">select-rule&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">id&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">mme&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">mme&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area</span> <span class="pre">range&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;routing</span> <span class="pre">ospf</span> <span class="pre">area</span> <span class="pre">range&quot;</span></code></p></li>
@ -488,6 +503,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">bandwidth-server&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">bandwidth-server&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">e-mail&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">e-mail&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing</span> <span class="pre">interface&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">graphing</span> <span class="pre">resource&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">mac-winbox&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">mac-winbox&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">ping&quot;</span></code></p></li> <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;tool</span> <span class="pre">mac-server</span> <span class="pre">ping&quot;</span></code></p></li>

20
pr/226/api_module.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.api module – Ansible module for RouterOS API &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.api module – Ansible module for RouterOS API &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -146,7 +148,7 @@
<h1>community.routeros.api module – Ansible module for RouterOS API<a class="headerlink" href="#community-routeros-api-module-ansible-module-for-routeros-api" title="Link to this heading"></a></h1> <h1>community.routeros.api module – Ansible module for RouterOS API<a class="headerlink" href="#community-routeros-api-module-ansible-module-for-routeros-api" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>. <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.
@ -617,7 +619,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span> <span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;</span><span class="cp">{{</span> <span class="nv">extended_queryout</span> <span class="cp">}}</span><span class="s">&#39;</span> <span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;</span><span class="cp">{{</span> <span class="nv">extended_queryout</span> <span class="cp">}}</span><span class="s">&#39;</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Update example - ether2 ip addres with &quot;.id = *14&quot;</span> <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Update example - ether2 ip address with &quot;.id = *14&quot;</span>
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span> <span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span>
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">&quot;</span>
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">&quot;</span>

18
pr/226/command_module.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.command module – Run commands on remote devices running MikroTik RouterOS &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.command module – Run commands on remote devices running MikroTik RouterOS &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -145,7 +147,7 @@
<h1>community.routeros.command module – Run commands on remote devices running MikroTik RouterOS<a class="headerlink" href="#community-routeros-command-module-run-commands-on-remote-devices-running-mikrotik-routeros" title="Link to this heading"></a></h1> <h1>community.routeros.command module – Run commands on remote devices running MikroTik RouterOS<a class="headerlink" href="#community-routeros-command-module-run-commands-on-remote-devices-running-mikrotik-routeros" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>

22
pr/226/docsite/api-guide.html
View file

@ -1,14 +1,16 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>How to connect to RouterOS devices with the RouterOS API &mdash; Community.Routeros Collection documentation</title> <title>How to connect to RouterOS devices with the RouterOS API &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="../_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="../_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
<link rel="stylesheet" href="../_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
@ -135,7 +137,7 @@
<section id="how-to-connect-to-routeros-devices-with-the-routeros-api"> <section id="how-to-connect-to-routeros-devices-with-the-routeros-api">
<span id="ansible-collections-community-routeros-docsite-api-guide"></span><h1>How to connect to RouterOS devices with the RouterOS API<a class="headerlink" href="#how-to-connect-to-routeros-devices-with-the-routeros-api" title="Link to this heading"></a></h1> <span id="ansible-collections-community-routeros-docsite-api-guide"></span><h1>How to connect to RouterOS devices with the RouterOS API<a class="headerlink" href="#how-to-connect-to-routeros-devices-with-the-routeros-api" title="Link to this heading"></a></h1>
<p>You can use the <a class="reference internal" href="../api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">community.routeros.api module</span></a> to connect to a RouterOS device with the RouterOS API. More specific module to modify certain entries are the <a class="reference internal" href="../api_modify_module.html#ansible-collections-community-routeros-api-modify-module"><span class="std std-ref">community.routeros.api_modify</span></a> and <a class="reference internal" href="../api_find_and_modify_module.html#ansible-collections-community-routeros-api-find-and-modify-module"><span class="std std-ref">community.routeros.api_find_and_modify</span></a> modules. The <a class="reference internal" href="../api_info_module.html#ansible-collections-community-routeros-api-info-module"><span class="std std-ref">community.routeros.api_info module</span></a> allows to retrieve information on specific predefined paths that can be used as input for the <code class="docutils literal notranslate"><span class="pre">community.routeros.api_modify</span></code> module, and the <a class="reference internal" href="../api_facts_module.html#ansible-collections-community-routeros-api-facts-module"><span class="std std-ref">community.routeros.api_facts module</span></a> allows to retrieve Ansible facts using the RouterOS API.</p> <p>You can use the <a class="reference internal" href="../api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">community.routeros.api module</span></a> to connect to a RouterOS device with the RouterOS API. More specific module to modify certain entries are the <a class="reference internal" href="../api_modify_module.html#ansible-collections-community-routeros-api-modify-module"><span class="std std-ref">community.routeros.api_modify</span></a> and <a class="reference internal" href="../api_find_and_modify_module.html#ansible-collections-community-routeros-api-find-and-modify-module"><span class="std std-ref">community.routeros.api_find_and_modify</span></a> modules. The <a class="reference internal" href="../api_info_module.html#ansible-collections-community-routeros-api-info-module"><span class="std std-ref">community.routeros.api_info module</span></a> allows to retrieve information on specific predefined paths that can be used as input for the <a class="reference internal" href="../api_modify_module.html#ansible-collections-community-routeros-api-modify-module"><span class="std std-ref">community.routeros.api_modify</span></a> module, and the <a class="reference internal" href="../api_facts_module.html#ansible-collections-community-routeros-api-facts-module"><span class="std std-ref">community.routeros.api_facts module</span></a> allows to retrieve Ansible facts using the RouterOS API.</p>
<p>No special setup is needed; the module needs to be run on a host that can connect to the device’s API. The most common case is that the module is run on <code class="docutils literal notranslate"><span class="pre">localhost</span></code>, either by using <code class="docutils literal notranslate"><span class="pre">hosts:</span> <span class="pre">localhost</span></code> in the playbook, or by using <code class="docutils literal notranslate"><span class="pre">delegate_to:</span> <span class="pre">localhost</span></code> for the task. The following example shows how to run the equivalent of <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">print</span></code>:</p> <p>No special setup is needed; the module needs to be run on a host that can connect to the device’s API. The most common case is that the module is run on <code class="docutils literal notranslate"><span class="pre">localhost</span></code>, either by using <code class="docutils literal notranslate"><span class="pre">hosts:</span> <span class="pre">localhost</span></code> in the playbook, or by using <code class="docutils literal notranslate"><span class="pre">delegate_to:</span> <span class="pre">localhost</span></code> for the task. The following example shows how to run the equivalent of <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">print</span></code>:</p>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RouterOS test with API</span> <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RouterOS test with API</span>
@ -181,7 +183,7 @@
<span class="n">localhost</span> <span class="p">:</span> <span class="k">ok</span><span class="p">=</span><span class="mi">2</span> <span class="k">changed</span><span class="p">=</span><span class="mi">0</span> <span class="k">unreachable</span><span class="p">=</span><span class="mi">0</span> <span class="k">failed</span><span class="p">=</span><span class="mi">0</span> <span class="k">skipped</span><span class="p">=</span><span class="mi">0</span> <span class="k">rescued</span><span class="p">=</span><span class="mi">0</span> <span class="k">ignored</span><span class="p">=</span><span class="mi">0</span> <span class="n">localhost</span> <span class="p">:</span> <span class="k">ok</span><span class="p">=</span><span class="mi">2</span> <span class="k">changed</span><span class="p">=</span><span class="mi">0</span> <span class="k">unreachable</span><span class="p">=</span><span class="mi">0</span> <span class="k">failed</span><span class="p">=</span><span class="mi">0</span> <span class="k">skipped</span><span class="p">=</span><span class="mi">0</span> <span class="k">rescued</span><span class="p">=</span><span class="mi">0</span> <span class="k">ignored</span><span class="p">=</span><span class="mi">0</span>
</pre></div> </pre></div>
</div> </div>
<p>Check out the documenation of the <a class="reference internal" href="../api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">community.routeros.api module</span></a> for details on the options.</p> <p>Check out the documentation of the <a class="reference internal" href="../api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">community.routeros.api module</span></a> for details on the options.</p>
<section id="using-the-community-routeros-api-module-defaults-group"> <section id="using-the-community-routeros-api-module-defaults-group">
<h2>Using the <code class="docutils literal notranslate"><span class="pre">community.routeros.api</span></code> module defaults group<a class="headerlink" href="#using-the-community-routeros-api-module-defaults-group" title="Link to this heading"></a></h2> <h2>Using the <code class="docutils literal notranslate"><span class="pre">community.routeros.api</span></code> module defaults group<a class="headerlink" href="#using-the-community-routeros-api-module-defaults-group" title="Link to this heading"></a></h2>
<p>To avoid having to specify common parameters for all the API based modules in every task, you can use the <code class="docutils literal notranslate"><span class="pre">community.routeros.api</span></code> module defaults group:</p> <p>To avoid having to specify common parameters for all the API based modules in every task, you can use the <code class="docutils literal notranslate"><span class="pre">community.routeros.api</span></code> module defaults group:</p>
@ -234,7 +236,7 @@
<dd class="field-odd"><p>Setting to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> (default) disables hostname verification during certificate validation. This is needed if the hostnames specified in the certificate do not match the hostname used for connecting (usually the device’s IP). It is recommended to set up the certificate correctly and set this to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>; the default <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> is chosen for backwards compatibility to an older version of the module.</p> <dd class="field-odd"><p>Setting to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> (default) disables hostname verification during certificate validation. This is needed if the hostnames specified in the certificate do not match the hostname used for connecting (usually the device’s IP). It is recommended to set up the certificate correctly and set this to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>; the default <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> is chosen for backwards compatibility to an older version of the module.</p>
</dd> </dd>
<dt class="field-even">ca_path<span class="colon">:</span></dt> <dt class="field-even">ca_path<span class="colon">:</span></dt>
<dd class="field-even"><p>If you are not using a commerically trusted CA certificate to sign your device’s certificate, or have not included your CA certificate in Python’s truststore, you need to point this option to the CA certificate.</p> <dd class="field-even"><p>If you are not using a commercially trusted CA certificate to sign your device’s certificate, or have not included your CA certificate in Python’s truststore, you need to point this option to the CA certificate.</p>
</dd> </dd>
</dl> </dl>
<p>We recommend to create a CA certificate that is used to sign the certificates for your RouterOS devices, and have the certificates include the correct hostname(s), including the IP of the device. That way, you can fully enable TLS and be sure that you always talk to the correct device.</p> <p>We recommend to create a CA certificate that is used to sign the certificates for your RouterOS devices, and have the certificates include the correct hostname(s), including the IP of the device. That way, you can fully enable TLS and be sure that you always talk to the correct device.</p>
@ -245,7 +247,7 @@
<section id="installing-a-certificate-on-a-mikrotik-router"> <section id="installing-a-certificate-on-a-mikrotik-router">
<h3>Installing a certificate on a MikroTik router<a class="headerlink" href="#installing-a-certificate-on-a-mikrotik-router" title="Link to this heading"></a></h3> <h3>Installing a certificate on a MikroTik router<a class="headerlink" href="#installing-a-certificate-on-a-mikrotik-router" title="Link to this heading"></a></h3>
<p>Installing the certificate is best done with the SSH connection. (See the <a class="reference internal" href="ssh-guide.html#ansible-collections-community-routeros-docsite-ssh-guide"><span class="std std-ref">How to connect to RouterOS devices with SSH</span></a> guide for more information.) Once the certificate has been installed, and the HTTPS API enabled, it’s easier to work with the API, since it has a quite a few less problems, and returns data as JSON objects instead of text you first have to parse.</p> <p>Installing the certificate is best done with the SSH connection. (See the <a class="reference internal" href="ssh-guide.html#ansible-collections-community-routeros-docsite-ssh-guide"><span class="std std-ref">How to connect to RouterOS devices with SSH</span></a> guide for more information.) Once the certificate has been installed, and the HTTPS API enabled, it’s easier to work with the API, since it has a quite a few less problems, and returns data as JSON objects instead of text you first have to parse.</p>
<p>First you have to convert the certificate and its private key to a <a class="reference external" href="https://en.wikipedia.org/wiki/PKCS_12">PKCS #12 bundle</a>. This can be done with the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/community/crypto/openssl_pkcs12_module.html#ansible-collections-community-crypto-openssl-pkcs12-module" title="(in Ansible vdevel)"><span class="xref std std-ref">community.crypto.openssl_pkcs12</span></a>. The following playbook assumes that the certificate is available as <code class="docutils literal notranslate"><span class="pre">keys/{{</span> <span class="pre">inventory_hostname</span> <span class="pre">}}.pem</span></code>, and its private key is available as <code class="docutils literal notranslate"><span class="pre">keys/{{</span> <span class="pre">inventory_hostname</span> <span class="pre">}}.key</span></code>. It generates a random passphrase to protect the PKCS#12 file.</p> <p>First you have to convert the certificate and its private key to a <a class="reference external" href="https://en.wikipedia.org/wiki/PKCS_12">PKCS #12 bundle</a>. This can be done with the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/community/crypto/openssl_pkcs12_module.html#ansible-collections-community-crypto-openssl-pkcs12-module" title="(in Ansible vdevel)"><span>community.crypto.openssl_pkcs12</span></a>. The following playbook assumes that the certificate is available as <code class="docutils literal notranslate"><span class="pre">keys/{{</span> <span class="pre">inventory_hostname</span> <span class="pre">}}.pem</span></code>, and its private key is available as <code class="docutils literal notranslate"><span class="pre">keys/{{</span> <span class="pre">inventory_hostname</span> <span class="pre">}}.key</span></code>. It generates a random passphrase to protect the PKCS#12 file.</p>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install certificates on devices</span> <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install certificates on devices</span>
<span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">routers</span> <span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">routers</span>

14
pr/226/docsite/quoting.html
View file

@ -1,14 +1,16 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>How to quote and unquote commands and arguments &mdash; Community.Routeros Collection documentation</title> <title>How to quote and unquote commands and arguments &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="../_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="../_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
<link rel="stylesheet" href="../_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>

20
pr/226/docsite/ssh-guide.html
View file

@ -1,14 +1,16 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>How to connect to RouterOS devices with SSH &mdash; Community.Routeros Collection documentation</title> <title>How to connect to RouterOS devices with SSH &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="../_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="../_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
<link rel="stylesheet" href="../_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="../_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
@ -137,7 +139,7 @@
<li><p>The <a class="reference internal" href="../facts_module.html#ansible-collections-community-routeros-facts-module"><span class="std std-ref">community.routeros.facts module</span></a> gathers facts about a RouterOS device;</p></li> <li><p>The <a class="reference internal" href="../facts_module.html#ansible-collections-community-routeros-facts-module"><span class="std std-ref">community.routeros.facts module</span></a> gathers facts about a RouterOS device;</p></li>
<li><p>The <a class="reference internal" href="../command_module.html#ansible-collections-community-routeros-command-module"><span class="std std-ref">community.routeros.command module</span></a> executes commands on a RouterOS device.</p></li> <li><p>The <a class="reference internal" href="../command_module.html#ansible-collections-community-routeros-command-module"><span class="std std-ref">community.routeros.command module</span></a> executes commands on a RouterOS device.</p></li>
</ul> </ul>
<p>The modules need the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.netcommon.network_cli connection plugin</span></a> for this.</p> <p>The modules need the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span>ansible.netcommon.network_cli connection plugin</span></a> for this.</p>
<section id="important-notes"> <section id="important-notes">
<h2>Important notes<a class="headerlink" href="#important-notes" title="Link to this heading"></a></h2> <h2>Important notes<a class="headerlink" href="#important-notes" title="Link to this heading"></a></h2>
<ol class="arabic"> <ol class="arabic">
@ -151,7 +153,7 @@
</div> </div>
</li> </li>
<li><p>When using the <a class="reference internal" href="../command_module.html#ansible-collections-community-routeros-command-module"><span class="std std-ref">community.routeros.command module</span></a> module, make sure to not specify too long commands. Alternatively, add something like <code class="docutils literal notranslate"><span class="pre">+cet512w</span></code> to the username (replace <code class="docutils literal notranslate"><span class="pre">admin</span></code> with <code class="docutils literal notranslate"><span class="pre">admin+cet512w</span></code>) to tell RouterOS to not wrap before 512 characters in a line (<a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/6">see issue for details</a>).</p></li> <li><p>When using the <a class="reference internal" href="../command_module.html#ansible-collections-community-routeros-command-module"><span class="std std-ref">community.routeros.command module</span></a> module, make sure to not specify too long commands. Alternatively, add something like <code class="docutils literal notranslate"><span class="pre">+cet512w</span></code> to the username (replace <code class="docutils literal notranslate"><span class="pre">admin</span></code> with <code class="docutils literal notranslate"><span class="pre">admin+cet512w</span></code>) to tell RouterOS to not wrap before 512 characters in a line (<a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/6">see issue for details</a>).</p></li>
<li><p>The <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.netcommon.network_cli connection plugin</span></a> uses <a class="reference external" href="https://pypi.org/project/paramiko/">paramiko</a> by default to connect to devices with SSH. You can set its <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection-parameter-ssh-type" title="(in Ansible vdevel)"><span><span class="pre">ssh_type</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">libssh</span></code> to use <a class="reference external" href="https://pypi.org/project/ansible-pylibssh/">ansible-pylibssh</a> instead, which offers Python bindings to libssh. See its documentation for details.</p></li> <li><p>The <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span>ansible.netcommon.network_cli connection plugin</span></a> uses <a class="reference external" href="https://pypi.org/project/paramiko/">paramiko</a> by default to connect to devices with SSH. You can set its <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection-parameter-ssh-type" title="(in Ansible vdevel)"><span><span class="pre">ssh_type</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">libssh</span></code> to use <a class="reference external" href="https://pypi.org/project/ansible-pylibssh/">ansible-pylibssh</a> instead, which offers Python bindings to libssh. See its documentation for details.</p></li>
<li><p>User is <strong>not allowed</strong> to login via SSH by password to modern Mikrotik if SSH key for the user is added!</p></li> <li><p>User is <strong>not allowed</strong> to login via SSH by password to modern Mikrotik if SSH key for the user is added!</p></li>
</ol> </ol>
</section> </section>
@ -168,7 +170,7 @@
<span class="na">ansible_ssh_pass</span><span class="o">=</span><span class="s">test1234</span> <span class="na">ansible_ssh_pass</span><span class="o">=</span><span class="s">test1234</span>
</pre></div> </pre></div>
</div> </div>
<p>This tells Ansible that you have a RouterOS device called <code class="docutils literal notranslate"><span class="pre">router</span></code> with IP <code class="docutils literal notranslate"><span class="pre">192.168.2.1</span></code>. Ansible should use the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.netcommon.network_cli connection plugin</span></a> together with the the <a class="reference internal" href="../routeros_cliconf.html#ansible-collections-community-routeros-routeros-cliconf"><span class="std std-ref">community.routeros.routeros cliconf plugin</span></a>. The credentials are stored as <code class="docutils literal notranslate"><span class="pre">ansible_user</span></code> and <code class="docutils literal notranslate"><span class="pre">ansible_ssh_pass</span></code> in the inventory.</p> <p>This tells Ansible that you have a RouterOS device called <code class="docutils literal notranslate"><span class="pre">router</span></code> with IP <code class="docutils literal notranslate"><span class="pre">192.168.2.1</span></code>. Ansible should use the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span>ansible.netcommon.network_cli connection plugin</span></a> together with the the <a class="reference internal" href="../routeros_cliconf.html#ansible-collections-community-routeros-routeros-cliconf"><span class="std std-ref">community.routeros.routeros cliconf plugin</span></a>. The credentials are stored as <code class="docutils literal notranslate"><span class="pre">ansible_user</span></code> and <code class="docutils literal notranslate"><span class="pre">ansible_ssh_pass</span></code> in the inventory.</p>
</section> </section>
<section id="connecting-to-the-device"> <section id="connecting-to-the-device">
<h2>Connecting to the device<a class="headerlink" href="#connecting-to-the-device" title="Link to this heading"></a></h2> <h2>Connecting to the device<a class="headerlink" href="#connecting-to-the-device" title="Link to this heading"></a></h2>

16
pr/226/environment_variables.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index of all Collection Environment Variables &mdash; Community.Routeros Collection documentation</title> <title>Index of all Collection Environment Variables &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>

18
pr/226/facts_module.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -144,7 +146,7 @@
<h1>community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS<a class="headerlink" href="#community-routeros-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros" title="Link to this heading"></a></h1> <h1>community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS<a class="headerlink" href="#community-routeros-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>

18
pr/226/index.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Community.Routeros &mdash; Community.Routeros Collection documentation</title> <title>Community.Routeros &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -127,7 +129,7 @@
<section id="community-routeros"> <section id="community-routeros">
<span id="plugins-in-community-routeros"></span><h1>Community.Routeros<a class="headerlink" href="#community-routeros" title="Link to this heading"></a></h1> <span id="plugins-in-community-routeros"></span><h1>Community.Routeros<a class="headerlink" href="#community-routeros" title="Link to this heading"></a></h1>
<p>Collection version 2.10.0</p> <p>Collection version 2.11.0</p>
<nav class="contents local" id="contents"> <nav class="contents local" id="contents">
<ul class="simple"> <ul class="simple">
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li> <li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>

18
pr/226/join_filter.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.join filter – Join a list of arguments to a command &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.join filter – Join a list of arguments to a command &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -142,7 +144,7 @@
<h1>community.routeros.join filter – Join a list of arguments to a command<a class="headerlink" href="#community-routeros-join-filter-join-a-list-of-arguments-to-a-command" title="Link to this heading"></a></h1> <h1>community.routeros.join filter – Join a list of arguments to a command<a class="headerlink" href="#community-routeros-join-filter-join-a-list-of-arguments-to-a-command" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>

18
pr/226/list_to_dict_filter.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.list_to_dict filter – Convert a list of arguments to a dictionary &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.list_to_dict filter – Convert a list of arguments to a dictionary &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -143,7 +145,7 @@
<h1>community.routeros.list_to_dict filter – Convert a list of arguments to a dictionary<a class="headerlink" href="#community-routeros-list-to-dict-filter-convert-a-list-of-arguments-to-a-dictionary" title="Link to this heading"></a></h1> <h1>community.routeros.list_to_dict filter – Convert a list of arguments to a dictionary<a class="headerlink" href="#community-routeros-list-to-dict-filter-convert-a-list-of-arguments-to-a-dictionary" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>

18
pr/226/quote_argument_filter.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.quote_argument filter – Quote an argument &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.quote_argument filter – Quote an argument &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -142,7 +144,7 @@
<h1>community.routeros.quote_argument filter – Quote an argument<a class="headerlink" href="#community-routeros-quote-argument-filter-quote-an-argument" title="Link to this heading"></a></h1> <h1>community.routeros.quote_argument filter – Quote an argument<a class="headerlink" href="#community-routeros-quote-argument-filter-quote-an-argument" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>

18
pr/226/quote_argument_value_filter.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.quote_argument_value filter – Quote an argument value &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.quote_argument_value filter – Quote an argument value &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -142,7 +144,7 @@
<h1>community.routeros.quote_argument_value filter – Quote an argument value<a class="headerlink" href="#community-routeros-quote-argument-value-filter-quote-an-argument-value" title="Link to this heading"></a></h1> <h1>community.routeros.quote_argument_value filter – Quote an argument value<a class="headerlink" href="#community-routeros-quote-argument-value-filter-quote-an-argument-value" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>

18
pr/226/routeros_cliconf.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -139,7 +141,7 @@
<h1>community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform<a class="headerlink" href="#community-routeros-routeros-cliconf-use-routeros-cliconf-to-run-command-on-mikrotik-routeros-platform" title="Link to this heading"></a></h1> <h1>community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform<a class="headerlink" href="#community-routeros-routeros-cliconf-use-routeros-cliconf-to-run-command-on-mikrotik-routeros-platform" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This cliconf plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This cliconf plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>

12
pr/226/search.html
View file

@ -1,13 +1,15 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; Community.Routeros Collection documentation</title> <title>Search &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>

2
pr/226/searchindex.js
View file

File diff suppressed because one or more lines are too long

18
pr/226/split_filter.html
View file

@ -1,15 +1,17 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" data-content_root="./">
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.4.0" name="antsibull-docs" /> <meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.routeros.split filter – Split a command into arguments &mdash; Community.Routeros Collection documentation</title> <title>community.routeros.split filter – Split a command into arguments &mdash; Community.Routeros Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=35b70fdb" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/> <link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
@ -141,7 +143,7 @@
<h1>community.routeros.split filter – Split a command into arguments<a class="headerlink" href="#community-routeros-split-filter-split-a-command-into-arguments" title="Link to this heading"></a></h1> <h1>community.routeros.split filter – Split a command into arguments<a class="headerlink" href="#community-routeros-split-filter-split-a-command-into-arguments" title="Link to this heading"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/routeros">community.routeros collection</a> (version 2.10.0).</p> <p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.11.0).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>. <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p> To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p> <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>