mirror.MikroTik/ansible-collections.community.routeros
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.routeros.git synced 2025-06-25 03:08:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

deploy: adff9bbf8c

Browse source
This commit is contained in:
felixfontein 2023-08-21 20:13:03 +00:00
parent 90f44f692d
commit ce40b34e16
24 changed files with 281 additions and 240 deletions
Download patch file Download diff file Expand all files Collapse all files

22
branch/main/_static/basic.css
View file

@ -237,6 +237,10 @@ a.headerlink {
visibility: hidden; visibility: hidden;
} }
a:visited {
color: #551A8B;
}
h1:hover > a.headerlink, h1:hover > a.headerlink,
h2:hover > a.headerlink, h2:hover > a.headerlink,
h3:hover > a.headerlink, h3:hover > a.headerlink,
@ -670,6 +674,16 @@ dd {
margin-left: 30px; margin-left: 30px;
} }
.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}
.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}
dl > dd:last-child, dl > dd:last-child,
dl > dd:last-child > :last-child { dl > dd:last-child > :last-child {
margin-bottom: 0; margin-bottom: 0;
@ -738,6 +752,14 @@ abbr, acronym {
cursor: help; cursor: help;
} }
.translated {
background-color: rgba(207, 255, 207, 0.2)
}
.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}
/* -- code displays --------------------------------------------------------- */ /* -- code displays --------------------------------------------------------- */
pre { pre {

3
branch/main/_static/documentation_options.js
View file

@ -1,5 +1,4 @@
var DOCUMENTATION_OPTIONS = { const DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '', VERSION: '',
LANGUAGE: 'en', LANGUAGE: 'en',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,

26
branch/main/_static/searchtools.js
View file

@ -57,12 +57,12 @@ const _removeChildren = (element) => {
const _escapeRegExp = (string) => const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
const _displayItem = (item, searchTerms) => { const _displayItem = (item, searchTerms, highlightTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;
const [docName, title, anchor, descr, score, _filename] = item; const [docName, title, anchor, descr, score, _filename] = item;
@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
if (dirname.match(/\/index\/$/)) if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6); dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = ""; else if (dirname === "index/") dirname = "";
requestUrl = docUrlRoot + dirname; requestUrl = contentRoot + dirname;
linkUrl = requestUrl; linkUrl = requestUrl;
} else { } else {
// normal html builders // normal html builders
requestUrl = docUrlRoot + docName + docFileSuffix; requestUrl = contentRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix; linkUrl = docName + docLinkSuffix;
} }
let linkEl = listItem.appendChild(document.createElement("a")); let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor; linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score; linkEl.dataset.score = score;
linkEl.innerHTML = title; linkEl.innerHTML = title;
if (descr) if (descr) {
listItem.appendChild(document.createElement("span")).innerHTML = listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")"; " (" + descr + ")";
// highlight search terms in the description
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}
else if (showSearchSummary) else if (showSearchSummary)
fetch(requestUrl) fetch(requestUrl)
.then((responseData) => responseData.text()) .then((responseData) => responseData.text())
@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
listItem.appendChild( listItem.appendChild(
Search.makeSearchSummary(data, searchTerms) Search.makeSearchSummary(data, searchTerms)
); );
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}); });
Search.output.appendChild(listItem); Search.output.appendChild(listItem);
}; };
@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
const _displayNextItem = ( const _displayNextItem = (
results, results,
resultCount, resultCount,
searchTerms searchTerms,
highlightTerms,
) => { ) => {
// results left, load the summary and display it // results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount) // this is intended to be dynamic (don't sub resultsCount)
if (results.length) { if (results.length) {
_displayItem(results.pop(), searchTerms); _displayItem(results.pop(), searchTerms, highlightTerms);
setTimeout( setTimeout(
() => _displayNextItem(results, resultCount, searchTerms), () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
5 5
); );
} }
@ -360,7 +368,7 @@ const Search = {
// console.info("search results:", Search.lastresults); // console.info("search results:", Search.lastresults);
// print the results // print the results
_displayNextItem(results, results.length, searchTerms); _displayNextItem(results, results.length, searchTerms, highlightTerms);
}, },
/** /**

16
branch/main/_static/sphinx_highlight.js
View file

@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
} }
span.appendChild(document.createTextNode(val.substr(pos, text.length))); span.appendChild(document.createTextNode(val.substr(pos, text.length)));
const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore( parent.insertBefore(
span, span,
parent.insertBefore( parent.insertBefore(
document.createTextNode(val.substr(pos + text.length)), rest,
node.nextSibling node.nextSibling
) )
); );
node.nodeValue = val.substr(0, pos); node.nodeValue = val.substr(0, pos);
/* There may be more occurrences of search term in this node. So call this
* function recursively on the remaining fragment.
*/
_highlight(rest, addItems, text, className);
if (isInSVG) { if (isInSVG) {
const rect = document.createElementNS( const rect = document.createElementNS(
@ -140,5 +145,10 @@ const SphinxHighlight = {
}, },
}; };
_ready(SphinxHighlight.highlightSearchWords); _ready(() => {
_ready(SphinxHighlight.initEscapeListener); /* Do not call highlightSearchWords() when we are on the search page.
* It will highlight words from the *previous* search query.
*/
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
SphinxHighlight.initEscapeListener();
});

30
branch/main/api_facts_module.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.api_find_and_modify module – Find and modify information using the API" href="api_find_and_modify_module.html" /> <link rel="next" title="community.routeros.api_find_and_modify module – Find and modify information using the API" href="api_find_and_modify_module.html" />
@ -141,7 +141,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-api-facts-module"></span><section id="community-routeros-api-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros-using-the-api"> <span class="target" id="ansible-collections-community-routeros-api-facts-module"></span><section id="community-routeros-api-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros-using-the-api">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -163,14 +163,14 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Collects a base set of device facts from a remote device that is running RouterOS. This module prepends all of the base network fact keys with <code class="docutils literal notranslate"><span class="pre">ansible_net_&lt;fact&gt;</span></code>. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.</p></li> <li><p>Collects a base set of device facts from a remote device that is running RouterOS. This module prepends all of the base network fact keys with <code class="docutils literal notranslate"><span class="pre">ansible_net_&lt;fact&gt;</span></code>. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.</p></li>
<li><p>As opposed to the <a class="reference internal" href="facts_module.html#ansible-collections-community-routeros-facts-module"><span class="std std-ref">community.routeros.facts</span></a> module, it uses the RouterOS API, similar to the <a class="reference internal" href="api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">community.routeros.api</span></a> module.</p></li> <li><p>As opposed to the <a class="reference internal" href="facts_module.html#ansible-collections-community-routeros-facts-module"><span class="std std-ref">community.routeros.facts</span></a> module, it uses the RouterOS API, similar to the <a class="reference internal" href="api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">community.routeros.api</span></a> module.</p></li>
</ul> </ul>
</section> </section>
<section id="requirements"> <section id="requirements">
<span id="ansible-collections-community-routeros-api-facts-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2> <span id="ansible-collections-community-routeros-api-facts-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<p>The below requirements are needed on the host that executes this module.</p> <p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple"> <ul class="simple">
<li><p>librouteros</p></li> <li><p>librouteros</p></li>
@ -178,7 +178,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
@ -314,7 +314,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
@ -369,7 +369,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="see-also"> <section id="see-also">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso"> <div class="admonition seealso">
<p class="admonition-title">See also</p> <p class="admonition-title">See also</p>
<dl class="simple"> <dl class="simple">
@ -389,7 +389,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Collect all facts from the device</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Collect all facts from the device</span>
<span class="w"> </span><span class="nt">community.routeros.api_facts</span><span class="p">:</span> <span class="w"> </span><span class="nt">community.routeros.api_facts</span><span class="p">:</span>
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.88.1</span> <span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.88.1</span>
@ -408,7 +408,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="returned-facts"> <section id="returned-facts">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Returned Facts</a><a class="headerlink" href="#returned-facts" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id7" role="doc-backlink">Returned Facts</a><a class="headerlink" href="#returned-facts" title="Link to this heading"></a></h2>
<p>Facts returned by this module are added/updated in the <code class="docutils literal notranslate"><span class="pre">hostvars</span></code> host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.</p> <p>Facts returned by this module are added/updated in the <code class="docutils literal notranslate"><span class="pre">hostvars</span></code> host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -596,7 +596,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Egor Zaitsev (&#64;heuels)</p></li> <li><p>Egor Zaitsev (&#64;heuels)</p></li>
<li><p>Nikolay Dachev (&#64;NikolayDachev)</p></li> <li><p>Nikolay Dachev (&#64;NikolayDachev)</p></li>
@ -604,7 +604,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

32
branch/main/api_find_and_modify_module.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.api_info module – Retrieve information from API" href="api_info_module.html" /> <link rel="next" title="community.routeros.api_info module – Retrieve information from API" href="api_info_module.html" />
@ -142,7 +142,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-api-find-and-modify-module"></span><section id="community-routeros-api-find-and-modify-module-find-and-modify-information-using-the-api"> <span class="target" id="ansible-collections-community-routeros-api-find-and-modify-module"></span><section id="community-routeros-api-find-and-modify-module-find-and-modify-information-using-the-api">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -165,14 +165,14 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Allows to find entries for a path by conditions and modify the values of these entries.</p></li> <li><p>Allows to find entries for a path by conditions and modify the values of these entries.</p></li>
<li><p>Use the <a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module"><span class="std std-ref">community.routeros.api_find_and_modify</span></a> module to set all entries of a path to specific values, or change multiple entries in different ways in one step.</p></li> <li><p>Use the <a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module"><span class="std std-ref">community.routeros.api_find_and_modify</span></a> module to set all entries of a path to specific values, or change multiple entries in different ways in one step.</p></li>
</ul> </ul>
</section> </section>
<section id="requirements"> <section id="requirements">
<span id="ansible-collections-community-routeros-api-find-and-modify-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2> <span id="ansible-collections-community-routeros-api-find-and-modify-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<p>The below requirements are needed on the host that executes this module.</p> <p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple"> <ul class="simple">
<li><p>librouteros</p></li> <li><p>librouteros</p></li>
@ -180,7 +180,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
@ -364,7 +364,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
@ -409,7 +409,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="notes"> <section id="notes">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<ul class="simple"> <ul class="simple">
@ -418,7 +418,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="see-also"> <section id="see-also">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id6" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso"> <div class="admonition seealso">
<p class="admonition-title">See also</p> <p class="admonition-title">See also</p>
<dl class="simple"> <dl class="simple">
@ -436,7 +436,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id7" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<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">Rename bridge from &#39;bridge&#39; to &#39;my-bridge&#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">Rename bridge from &#39;bridge&#39; to &#39;my-bridge&#39;</span>
<span class="w"> </span><span class="nt">community.routeros.api_find_and_modify</span><span class="p">:</span> <span class="w"> </span><span class="nt">community.routeros.api_find_and_modify</span><span class="p">:</span>
@ -467,7 +467,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id8" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -515,13 +515,13 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

31
branch/main/api_info_module.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.api_modify module – Modify data at paths with API" href="api_modify_module.html" /> <link rel="next" title="community.routeros.api_modify module – Modify data at paths with API" href="api_modify_module.html" />
@ -141,7 +141,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-api-info-module"></span><section id="community-routeros-api-info-module-retrieve-information-from-api"> <span class="target" id="ansible-collections-community-routeros-api-info-module"></span><section id="community-routeros-api-info-module-retrieve-information-from-api">
<h1>community.routeros.api_info module – Retrieve information from API<a class="headerlink" href="#community-routeros-api-info-module-retrieve-information-from-api" title="Permalink 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.9.0).</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.9.0).</p>
@ -163,7 +163,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Allows to retrieve information for a path using the API.</p></li> <li><p>Allows to retrieve information for a path using the API.</p></li>
<li><p>This can be used to backup a path to restore it with 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.</p></li> <li><p>This can be used to backup a path to restore it with 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.</p></li>
@ -172,7 +172,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="requirements"> <section id="requirements">
<span id="ansible-collections-community-routeros-api-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2> <span id="ansible-collections-community-routeros-api-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<p>The below requirements are needed on the host that executes this module.</p> <p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple"> <ul class="simple">
<li><p>librouteros</p></li> <li><p>librouteros</p></li>
@ -180,7 +180,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
@ -342,6 +342,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;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>
<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">align&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">align&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">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">wireless</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">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;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>
@ -538,7 +539,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
@ -585,7 +586,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="see-also"> <section id="see-also">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso"> <div class="admonition seealso">
<p class="admonition-title">See also</p> <p class="admonition-title">See also</p>
<dl class="simple"> <dl class="simple">
@ -603,7 +604,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<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">Get IP addresses</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">Get IP addresses</span>
<span class="w"> </span><span class="nt">community.routeros.api_info</span><span class="p">:</span> <span class="w"> </span><span class="nt">community.routeros.api_info</span><span class="p">:</span>
@ -620,7 +621,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -641,13 +642,13 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

31
branch/main/api_modify_module.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.command module – Run commands on remote devices running MikroTik RouterOS" href="command_module.html" /> <link rel="next" title="community.routeros.command module – Run commands on remote devices running MikroTik RouterOS" href="command_module.html" />
@ -141,7 +141,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-api-modify-module"></span><section id="community-routeros-api-modify-module-modify-data-at-paths-with-api"> <span class="target" id="ansible-collections-community-routeros-api-modify-module"></span><section id="community-routeros-api-modify-module-modify-data-at-paths-with-api">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -163,7 +163,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Allows to modify information for a path using the API.</p></li> <li><p>Allows to modify information for a path using the API.</p></li>
<li><p>Use the <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> module to modify one or multiple entries in a controlled way depending on some search conditions.</p></li> <li><p>Use the <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> module to modify one or multiple entries in a controlled way depending on some search conditions.</p></li>
@ -173,7 +173,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="requirements"> <section id="requirements">
<span id="ansible-collections-community-routeros-api-modify-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2> <span id="ansible-collections-community-routeros-api-modify-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<p>The below requirements are needed on the host that executes this module.</p> <p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple"> <ul class="simple">
<li><p>Needs <a class="reference external" href="https://pypi.org/project/ordereddict">ordereddict</a> for Python 2.6</p></li> <li><p>Needs <a class="reference external" href="https://pypi.org/project/ordereddict">ordereddict</a> for Python 2.6</p></li>
@ -182,7 +182,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
@ -339,6 +339,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;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>
<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">align&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">align&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">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">wireless</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">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;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>
@ -522,7 +523,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
@ -567,7 +568,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="see-also"> <section id="see-also">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso"> <div class="admonition seealso">
<p class="admonition-title">See also</p> <p class="admonition-title">See also</p>
<dl class="simple"> <dl class="simple">
@ -585,7 +586,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<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">Setup DHCP server networks</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">Setup DHCP server networks</span>
<span class="w"> </span><span class="c1"># Ensures that we have exactly two DHCP server networks (in the specified order)</span> <span class="w"> </span><span class="c1"># Ensures that we have exactly two DHCP server networks (in the specified order)</span>
@ -627,7 +628,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -657,13 +658,13 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

32
branch/main/api_module.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API" href="api_facts_module.html" /> <link rel="next" title="community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API" href="api_facts_module.html" />
@ -142,7 +142,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-api-module"></span><section id="community-routeros-api-module-ansible-module-for-routeros-api"> <span class="target" id="ansible-collections-community-routeros-api-module"></span><section id="community-routeros-api-module-ansible-module-for-routeros-api">
<h1>community.routeros.api module – Ansible module for RouterOS API<a class="headerlink" href="#community-routeros-api-module-ansible-module-for-routeros-api" title="Permalink 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.9.0).</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.9.0).</p>
@ -164,14 +164,14 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Ansible module for RouterOS API with the Python <code class="docutils literal notranslate"><span class="pre">librouteros</span></code> library.</p></li> <li><p>Ansible module for RouterOS API with the Python <code class="docutils literal notranslate"><span class="pre">librouteros</span></code> library.</p></li>
<li><p>This module can add, remove, update, query and execute arbitrary command in RouterOS via API.</p></li> <li><p>This module can add, remove, update, query and execute arbitrary command in RouterOS via API.</p></li>
</ul> </ul>
</section> </section>
<section id="requirements"> <section id="requirements">
<span id="ansible-collections-community-routeros-api-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2> <span id="ansible-collections-community-routeros-api-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<p>The below requirements are needed on the host that executes this module.</p> <p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple"> <ul class="simple">
<li><p>librouteros</p></li> <li><p>librouteros</p></li>
@ -179,7 +179,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</ul> </ul>
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
@ -471,7 +471,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
@ -517,7 +517,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</table> </table>
</section> </section>
<section id="notes"> <section id="notes">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<ul class="simple"> <ul class="simple">
@ -527,7 +527,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="see-also"> <section id="see-also">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id6" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso"> <div class="admonition seealso">
<p class="admonition-title">See also</p> <p class="admonition-title">See also</p>
<dl class="simple"> <dl class="simple">
@ -547,7 +547,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id7" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Get example - ip address print</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Get example - ip address print</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>
@ -649,7 +649,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</div> </div>
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id8" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -670,13 +670,13 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Nikolay Dachev (&#64;NikolayDachev)</p></li> <li><p>Nikolay Dachev (&#64;NikolayDachev)</p></li>
</ul> </ul>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

30
branch/main/command_module.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS" href="facts_module.html" /> <link rel="next" title="community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS" href="facts_module.html" />
@ -141,7 +141,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-command-module"></span><section id="community-routeros-command-module-run-commands-on-remote-devices-running-mikrotik-routeros"> <span class="target" id="ansible-collections-community-routeros-command-module"></span><section id="community-routeros-command-module-run-commands-on-remote-devices-running-mikrotik-routeros">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -160,14 +160,14 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Sends arbitrary commands to an RouterOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.</p></li> <li><p>Sends arbitrary commands to an RouterOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.</p></li>
<li><p>The module always indicates a (changed) status. You can use <a class="reference external" href="https://docs.ansible.com/ansible/devel/playbook_guide/playbooks_error_handling.html#override-the-changed-result" title="(in Ansible vdevel)"><span class="xref std std-ref">the changed_when task property</span></a> to determine whether a command task actually resulted in a change or not.</p></li> <li><p>The module always indicates a (changed) status. You can use <a class="reference external" href="https://docs.ansible.com/ansible/devel/playbook_guide/playbooks_error_handling.html#override-the-changed-result" title="(in Ansible vdevel)"><span class="xref std std-ref">the changed_when task property</span></a> to determine whether a command task actually resulted in a change or not.</p></li>
</ul> </ul>
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
@ -221,7 +221,7 @@
</table> </table>
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
@ -259,7 +259,7 @@
</table> </table>
</section> </section>
<section id="notes"> <section id="notes">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<ul class="simple"> <ul class="simple">
@ -268,7 +268,7 @@
</div> </div>
</section> </section>
<section id="see-also"> <section id="see-also">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso"> <div class="admonition seealso">
<p class="admonition-title">See also</p> <p class="admonition-title">See also</p>
<dl class="simple"> <dl class="simple">
@ -280,7 +280,7 @@
</div> </div>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Run command on remote devices</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Run command on remote devices</span>
<span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span> <span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span>
<span class="w"> </span><span class="nt">commands</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system routerboard print</span> <span class="w"> </span><span class="nt">commands</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system routerboard print</span>
@ -308,7 +308,7 @@
</div> </div>
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -347,13 +347,13 @@
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Egor Zaitsev (&#64;heuels)</p></li> <li><p>Egor Zaitsev (&#64;heuels)</p></li>
</ul> </ul>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

20
branch/main/docsite/api-guide.html
View file

@ -14,11 +14,11 @@
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="../_static/jquery.js"></script> <script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/documentation_options.js?v=7f41d439"></script>
<script src="../_static/doctools.js"></script> <script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script> <script src="../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../search.html" /> <link rel="search" title="Search" href="../search.html" />
<link rel="next" title="How to connect to RouterOS devices with SSH" href="ssh-guide.html" /> <link rel="next" title="How to connect to RouterOS devices with SSH" href="ssh-guide.html" />
@ -134,7 +134,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<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="Permalink 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 <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>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>
@ -183,7 +183,7 @@
</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 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>
<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="Permalink 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>
<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>
@ -221,7 +221,7 @@
<p>Here all three tasks will use the options set for the module defaults group.</p> <p>Here all three tasks will use the options set for the module defaults group.</p>
</section> </section>
<section id="setting-up-encryption"> <section id="setting-up-encryption">
<h2>Setting up encryption<a class="headerlink" href="#setting-up-encryption" title="Permalink to this heading"></a></h2> <h2>Setting up encryption<a class="headerlink" href="#setting-up-encryption" title="Link to this heading"></a></h2>
<p>It is recommended to always use <code class="ansible-option-value docutils literal notranslate"><span><span class="pre">tls=true</span></span></code> when connecting with the API, even if you are only connecting to the device through a trusted network. The following options control how TLS/SSL is used:</p> <p>It is recommended to always use <code class="ansible-option-value docutils literal notranslate"><span><span class="pre">tls=true</span></span></code> when connecting with the API, even if you are only connecting to the device through a trusted network. The following options control how TLS/SSL is used:</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">force_no_cert<span class="colon">:</span></dt> <dt class="field-odd">force_no_cert<span class="colon">:</span></dt>
@ -239,11 +239,11 @@
</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>
<section id="setting-up-a-pki"> <section id="setting-up-a-pki">
<h3>Setting up a PKI<a class="headerlink" href="#setting-up-a-pki" title="Permalink to this heading"></a></h3> <h3>Setting up a PKI<a class="headerlink" href="#setting-up-a-pki" title="Link to this heading"></a></h3>
<p>Please follow the instructions in the <code class="docutils literal notranslate"><span class="pre">community.crypto</span></code> <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/community/crypto/docsite/guide_ownca.html#ansible-collections-community-crypto-docsite-guide-ownca" title="(in Ansible vdevel)"><span>How to create a small CA</span></a> guide to set up a CA certificate and sign a certificate for your router. You should add a Subject Alternative Name for the IP address (for example <code class="docutils literal notranslate"><span class="pre">IP:192.168.1.1</span></code>) and - if available - for the DNS name (for example <code class="docutils literal notranslate"><span class="pre">DNS:router.local</span></code>) to the certificate.</p> <p>Please follow the instructions in the <code class="docutils literal notranslate"><span class="pre">community.crypto</span></code> <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/community/crypto/docsite/guide_ownca.html#ansible-collections-community-crypto-docsite-guide-ownca" title="(in Ansible vdevel)"><span>How to create a small CA</span></a> guide to set up a CA certificate and sign a certificate for your router. You should add a Subject Alternative Name for the IP address (for example <code class="docutils literal notranslate"><span class="pre">IP:192.168.1.1</span></code>) and - if available - for the DNS name (for example <code class="docutils literal notranslate"><span class="pre">DNS:router.local</span></code>) to the certificate.</p>
</section> </section>
<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="Permalink 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 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>
<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>

12
branch/main/docsite/quoting.html
View file

@ -14,11 +14,11 @@
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="../_static/jquery.js"></script> <script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/documentation_options.js?v=7f41d439"></script>
<script src="../_static/doctools.js"></script> <script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script> <script src="../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../search.html" /> <link rel="search" title="Search" href="../search.html" />
<link rel="next" title="community.routeros.api module – Ansible module for RouterOS API" href="../api_module.html" /> <link rel="next" title="community.routeros.api module – Ansible module for RouterOS API" href="../api_module.html" />
@ -126,7 +126,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<section id="how-to-quote-and-unquote-commands-and-arguments"> <section id="how-to-quote-and-unquote-commands-and-arguments">
<span id="ansible-collections-community-routeros-docsite-quoting"></span><h1>How to quote and unquote commands and arguments<a class="headerlink" href="#how-to-quote-and-unquote-commands-and-arguments" title="Permalink to this heading"></a></h1> <span id="ansible-collections-community-routeros-docsite-quoting"></span><h1>How to quote and unquote commands and arguments<a class="headerlink" href="#how-to-quote-and-unquote-commands-and-arguments" title="Link to this heading"></a></h1>
<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> or 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> modules, you need to pass text data in quoted form. While in some cases quoting is not needed (when passing IP addresses or names without spaces, for example), in other cases it is required, like when passing a comment which contains a space.</p> <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> or 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> modules, you need to pass text data in quoted form. While in some cases quoting is not needed (when passing IP addresses or names without spaces, for example), in other cases it is required, like when passing a comment which contains a space.</p>
<p>The community.routeros collection provides a set of Jinja2 filter plugins which helps you with these tasks:</p> <p>The community.routeros collection provides a set of Jinja2 filter plugins which helps you with these tasks:</p>
<ul class="simple"> <ul class="simple">

18
branch/main/docsite/ssh-guide.html
View file

@ -14,11 +14,11 @@
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="../_static/jquery.js"></script> <script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/documentation_options.js?v=7f41d439"></script>
<script src="../_static/doctools.js"></script> <script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script> <script src="../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../search.html" /> <link rel="search" title="Search" href="../search.html" />
<link rel="next" title="How to quote and unquote commands and arguments" href="quoting.html" /> <link rel="next" title="How to quote and unquote commands and arguments" href="quoting.html" />
@ -131,7 +131,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<section id="how-to-connect-to-routeros-devices-with-ssh"> <section id="how-to-connect-to-routeros-devices-with-ssh">
<span id="ansible-collections-community-routeros-docsite-ssh-guide"></span><h1>How to connect to RouterOS devices with SSH<a class="headerlink" href="#how-to-connect-to-routeros-devices-with-ssh" title="Permalink to this heading"></a></h1> <span id="ansible-collections-community-routeros-docsite-ssh-guide"></span><h1>How to connect to RouterOS devices with SSH<a class="headerlink" href="#how-to-connect-to-routeros-devices-with-ssh" title="Link to this heading"></a></h1>
<p>The collection offers two modules to connect to RouterOS devies with SSH:</p> <p>The collection offers two modules to connect to RouterOS devies with SSH:</p>
<ul class="simple"> <ul class="simple">
<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>
@ -139,7 +139,7 @@
</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 class="xref std std-ref">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="Permalink 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">
<li><p>The SSH-based modules do not support arbitrary symbols in the router’s identity. If you are having trouble connecting to your device, please make sure that your MikroTik’s identity contains only alphanumeric characters and dashes. Also make sure that the identity string is not longer than 19 characters (<a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/31">see issue for details</a>). Similar problems can happen for unsupported characters in your username.</p></li> <li><p>The SSH-based modules do not support arbitrary symbols in the router’s identity. If you are having trouble connecting to your device, please make sure that your MikroTik’s identity contains only alphanumeric characters and dashes. Also make sure that the identity string is not longer than 19 characters (<a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/31">see issue for details</a>). Similar problems can happen for unsupported characters in your username.</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> does not support nesting commands and expects every command to start with a forward slash (<code class="docutils literal notranslate"><span class="pre">/</span></code>). Running the following command will produce an error:</p> <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> does not support nesting commands and expects every command to start with a forward slash (<code class="docutils literal notranslate"><span class="pre">/</span></code>). Running the following command will produce an error:</p>
@ -155,7 +155,7 @@
</ol> </ol>
</section> </section>
<section id="setting-up-an-inventory"> <section id="setting-up-an-inventory">
<h2>Setting up an inventory<a class="headerlink" href="#setting-up-an-inventory" title="Permalink to this heading"></a></h2> <h2>Setting up an inventory<a class="headerlink" href="#setting-up-an-inventory" title="Link to this heading"></a></h2>
<p>An example inventory <code class="docutils literal notranslate"><span class="pre">hosts</span></code> file for a RouterOS device is as follows:</p> <p>An example inventory <code class="docutils literal notranslate"><span class="pre">hosts</span></code> file for a RouterOS device is as follows:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[routers]</span> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[routers]</span>
<span class="na">router ansible_host</span><span class="o">=</span><span class="s">192.168.2.1</span> <span class="na">router ansible_host</span><span class="o">=</span><span class="s">192.168.2.1</span>
@ -170,7 +170,7 @@
<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 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>
</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="Permalink 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>
<p>With the above inventory, you can use the following playbook to execute <code class="docutils literal notranslate"><span class="pre">/system</span> <span class="pre">resource</span> <span class="pre">print</span></code> on the device</p> <p>With the above inventory, you can use the following playbook to execute <code class="docutils literal notranslate"><span class="pre">/system</span> <span class="pre">resource</span> <span class="pre">print</span></code> on the device</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 network_cli connection</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 network_cli connection</span>

12
branch/main/environment_variables.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme --> <link rel="search" title="Search" href="search.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -124,7 +124,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<section id="index-of-all-collection-environment-variables"> <section id="index-of-all-collection-environment-variables">
<span id="list-of-collection-env-vars"></span><h1>Index of all Collection Environment Variables<a class="headerlink" href="#index-of-all-collection-environment-variables" title="Permalink to this heading"></a></h1> <span id="list-of-collection-env-vars"></span><h1>Index of all Collection Environment Variables<a class="headerlink" href="#index-of-all-collection-environment-variables" title="Link to this heading"></a></h1>
<p>The following index documents all environment variables declared by plugins in collections. <p>The following index documents all environment variables declared by plugins in collections.
Environment variables used by the ansible-core configuration are documented in <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/config.html#ansible-configuration-settings" title="(in Ansible vdevel)"><span>Ansible Configuration Settings</span></a>.</p> Environment variables used by the ansible-core configuration are documented in <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/config.html#ansible-configuration-settings" title="(in Ansible vdevel)"><span>Ansible Configuration Settings</span></a>.</p>
<p>No environment variables have been defined.</p> <p>No environment variables have been defined.</p>

28
branch/main/facts_module.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform" href="routeros_cliconf.html" /> <link rel="next" title="community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform" href="routeros_cliconf.html" />
@ -140,7 +140,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-facts-module"></span><section id="community-routeros-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros"> <span class="target" id="ansible-collections-community-routeros-facts-module"></span><section id="community-routeros-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -158,13 +158,13 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Collects a base set of device facts from a remote device that is running RouterOS. This module prepends all of the base network fact keys with <code class="docutils literal notranslate"><span class="pre">ansible_net_&lt;fact&gt;</span></code>. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.</p></li> <li><p>Collects a base set of device facts from a remote device that is running RouterOS. This module prepends all of the base network fact keys with <code class="docutils literal notranslate"><span class="pre">ansible_net_&lt;fact&gt;</span></code>. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.</p></li>
</ul> </ul>
</section> </section>
<section id="parameters"> <section id="parameters">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th> <tr class="row-odd"><th class="head"><p>Parameter</p></th>
@ -185,7 +185,7 @@
</table> </table>
</section> </section>
<section id="attributes"> <section id="attributes">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th> <tr class="row-odd"><th class="head"><p>Attribute</p></th>
@ -232,7 +232,7 @@
</table> </table>
</section> </section>
<section id="see-also"> <section id="see-also">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso"> <div class="admonition seealso">
<p class="admonition-title">See also</p> <p class="admonition-title">See also</p>
<dl class="simple"> <dl class="simple">
@ -242,7 +242,7 @@
</div> </div>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Collect all facts from the device</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Collect all facts from the device</span>
<span class="w"> </span><span class="nt">community.routeros.facts</span><span class="p">:</span> <span class="w"> </span><span class="nt">community.routeros.facts</span><span class="p">:</span>
<span class="w"> </span><span class="nt">gather_subset</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">all</span> <span class="w"> </span><span class="nt">gather_subset</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">all</span>
@ -260,7 +260,7 @@
</div> </div>
</section> </section>
<section id="returned-facts"> <section id="returned-facts">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Returned Facts</a><a class="headerlink" href="#returned-facts" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id6" role="doc-backlink">Returned Facts</a><a class="headerlink" href="#returned-facts" title="Link to this heading"></a></h2>
<p>Facts returned by this module are added/updated in the <code class="docutils literal notranslate"><span class="pre">hostvars</span></code> host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.</p> <p>Facts returned by this module are added/updated in the <code class="docutils literal notranslate"><span class="pre">hostvars</span></code> host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -466,13 +466,13 @@
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Egor Zaitsev (&#64;heuels)</p></li> <li><p>Egor Zaitsev (&#64;heuels)</p></li>
</ul> </ul>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

26
branch/main/index.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="How to connect to RouterOS devices with the RouterOS API" href="docsite/api-guide.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme --> <link rel="next" title="How to connect to RouterOS devices with the RouterOS API" href="docsite/api-guide.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -125,7 +125,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<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="Permalink 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.9.0</p> <p>Collection version 2.9.0</p>
<nav class="contents local" id="contents"> <nav class="contents local" id="contents">
<ul class="simple"> <ul class="simple">
@ -136,7 +136,7 @@
</ul> </ul>
</nav> </nav>
<section id="description"> <section id="description">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Description</a><a class="headerlink" href="#description" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Description</a><a class="headerlink" href="#description" title="Link to this heading"></a></h2>
<p>Modules for MikroTik RouterOS</p> <p>Modules for MikroTik RouterOS</p>
<p><strong>Authors:</strong></p> <p><strong>Authors:</strong></p>
<ul class="simple"> <ul class="simple">
@ -155,7 +155,7 @@
<a href="https://github.com/ansible-collections/community.routeros/issues/new?assignees=&amp;labels=&amp;template=feature_request.md" aria-role="button" target="_blank" rel="noopener external">Request a feature</a> <a href="https://github.com/ansible-collections/community.routeros/issues/new?assignees=&amp;labels=&amp;template=feature_request.md" aria-role="button" target="_blank" rel="noopener external">Request a feature</a>
</p></section> </p></section>
<section id="communication"> <section id="communication">
<span id="communication-for-community-routeros"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Communication</a><a class="headerlink" href="#communication" title="Permalink to this heading"></a></h2> <span id="communication-for-community-routeros"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Communication</a><a class="headerlink" href="#communication" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Matrix room <code class="docutils literal notranslate"><span class="pre">#users:ansible.im</span></code>: <a class="reference external" href="https://matrix.to/#/#users:ansible.im">General usage and support questions</a>.</p></li> <li><p>Matrix room <code class="docutils literal notranslate"><span class="pre">#users:ansible.im</span></code>: <a class="reference external" href="https://matrix.to/#/#users:ansible.im">General usage and support questions</a>.</p></li>
<li><p>IRC channel <code class="docutils literal notranslate"><span class="pre">#ansible</span></code> (Libera network): <li><p>IRC channel <code class="docutils literal notranslate"><span class="pre">#ansible</span></code> (Libera network):
@ -167,7 +167,7 @@
</div> </div>
</section> </section>
<section id="guides"> <section id="guides">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Guides</a><a class="headerlink" href="#guides" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Guides</a><a class="headerlink" href="#guides" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="docsite/api-guide.html">How to connect to RouterOS devices with the RouterOS API</a></li> <li class="toctree-l1"><a class="reference internal" href="docsite/api-guide.html">How to connect to RouterOS devices with the RouterOS API</a></li>
@ -177,10 +177,10 @@
</div> </div>
</section> </section>
<section id="plugin-index"> <section id="plugin-index">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Plugin Index</a><a class="headerlink" href="#plugin-index" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Plugin Index</a><a class="headerlink" href="#plugin-index" title="Link to this heading"></a></h2>
<p>These are the plugins in the community.routeros collection:</p> <p>These are the plugins in the community.routeros collection:</p>
<section id="modules"> <section id="modules">
<h3>Modules<a class="headerlink" href="#modules" title="Permalink to this heading"></a></h3> <h3>Modules<a class="headerlink" href="#modules" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference internal" href="api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">api module</span></a> – Ansible module for RouterOS API</p></li> <li><p><a class="reference internal" href="api_module.html#ansible-collections-community-routeros-api-module"><span class="std std-ref">api module</span></a> – Ansible module for RouterOS API</p></li>
<li><p><a class="reference internal" href="api_facts_module.html#ansible-collections-community-routeros-api-facts-module"><span class="std std-ref">api_facts module</span></a> – Collect facts from remote devices running MikroTik RouterOS using the API</p></li> <li><p><a class="reference internal" href="api_facts_module.html#ansible-collections-community-routeros-api-facts-module"><span class="std std-ref">api_facts module</span></a> – Collect facts from remote devices running MikroTik RouterOS using the API</p></li>
@ -194,7 +194,7 @@
</div> </div>
</section> </section>
<section id="cliconf-plugins"> <section id="cliconf-plugins">
<h3>Cliconf Plugins<a class="headerlink" href="#cliconf-plugins" title="Permalink to this heading"></a></h3> <h3>Cliconf Plugins<a class="headerlink" href="#cliconf-plugins" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference internal" href="routeros_cliconf.html#ansible-collections-community-routeros-routeros-cliconf"><span class="std std-ref">routeros cliconf</span></a> – Use routeros cliconf to run command on MikroTik RouterOS platform</p></li> <li><p><a class="reference internal" href="routeros_cliconf.html#ansible-collections-community-routeros-routeros-cliconf"><span class="std std-ref">routeros cliconf</span></a> – Use routeros cliconf to run command on MikroTik RouterOS platform</p></li>
</ul> </ul>
@ -202,7 +202,7 @@
</div> </div>
</section> </section>
<section id="filter-plugins"> <section id="filter-plugins">
<h3>Filter Plugins<a class="headerlink" href="#filter-plugins" title="Permalink to this heading"></a></h3> <h3>Filter Plugins<a class="headerlink" href="#filter-plugins" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference internal" href="join_filter.html#ansible-collections-community-routeros-join-filter"><span class="std std-ref">join filter</span></a> – Join a list of arguments to a command</p></li> <li><p><a class="reference internal" href="join_filter.html#ansible-collections-community-routeros-join-filter"><span class="std std-ref">join filter</span></a> – Join a list of arguments to a command</p></li>
<li><p><a class="reference internal" href="list_to_dict_filter.html#ansible-collections-community-routeros-list-to-dict-filter"><span class="std std-ref">list_to_dict filter</span></a> – Convert a list of arguments to a dictionary</p></li> <li><p><a class="reference internal" href="list_to_dict_filter.html#ansible-collections-community-routeros-list-to-dict-filter"><span class="std std-ref">list_to_dict filter</span></a> – Convert a list of arguments to a dictionary</p></li>

24
branch/main/join_filter.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.list_to_dict filter – Convert a list of arguments to a dictionary" href="list_to_dict_filter.html" /> <link rel="next" title="community.routeros.list_to_dict filter – Convert a list of arguments to a dictionary" href="list_to_dict_filter.html" />
@ -138,7 +138,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-join-filter"></span><section id="community-routeros-join-filter-join-a-list-of-arguments-to-a-command"> <span class="target" id="ansible-collections-community-routeros-join-filter"></span><section id="community-routeros-join-filter-join-a-list-of-arguments-to-a-command">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -155,13 +155,13 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Join and quotes a list of arguments to a command.</p></li> <li><p>Join and quotes a list of arguments to a command.</p></li>
</ul> </ul>
</section> </section>
<section id="input"> <section id="input">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Link to this heading"></a></h2>
<p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.join</span></code>.</p> <p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.join</span></code>.</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -181,7 +181,7 @@
</table> </table>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Join arguments for a RouterOS CLI command</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Join arguments for a RouterOS CLI command</span>
<span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span> <span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span>
<span class="w"> </span><span class="nt">arguments</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">&#39;foo=bar&#39;</span><span class="o">,</span> <span class="s1">&#39;comment=foo is bar&#39;</span><span class="o">]</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.join</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="w"> </span><span class="nt">arguments</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">&#39;foo=bar&#39;</span><span class="o">,</span> <span class="s1">&#39;comment=foo is bar&#39;</span><span class="o">]</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.join</span> <span class="cp">}}</span><span class="s">&quot;</span>
@ -190,7 +190,7 @@
</div> </div>
</section> </section>
<section id="return-value"> <section id="return-value">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
@ -209,7 +209,7 @@
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
@ -219,7 +219,7 @@
</div> </div>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

26
branch/main/list_to_dict_filter.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.quote_argument filter – Quote an argument" href="quote_argument_filter.html" /> <link rel="next" title="community.routeros.quote_argument filter – Quote an argument" href="quote_argument_filter.html" />
@ -139,7 +139,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-list-to-dict-filter"></span><section id="community-routeros-list-to-dict-filter-convert-a-list-of-arguments-to-a-dictionary"> <span class="target" id="ansible-collections-community-routeros-list-to-dict-filter"></span><section id="community-routeros-list-to-dict-filter-convert-a-list-of-arguments-to-a-dictionary">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -157,13 +157,13 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Convert a list of arguments to a dictionary.</p></li> <li><p>Convert a list of arguments to a dictionary.</p></li>
</ul> </ul>
</section> </section>
<section id="input"> <section id="input">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Link to this heading"></a></h2>
<p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.list_to_dict</span></code>.</p> <p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.list_to_dict</span></code>.</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -183,7 +183,7 @@
</table> </table>
</section> </section>
<section id="keyword-parameters"> <section id="keyword-parameters">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Keyword parameters</a><a class="headerlink" href="#keyword-parameters" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Keyword parameters</a><a class="headerlink" href="#keyword-parameters" title="Link to this heading"></a></h2>
<p>This describes keyword parameters of the filter. These are the values <code class="docutils literal notranslate"><span class="pre">key1=value1</span></code>, <code class="docutils literal notranslate"><span class="pre">key2=value2</span></code> and so on in the following <p>This describes keyword parameters of the filter. These are the values <code class="docutils literal notranslate"><span class="pre">key1=value1</span></code>, <code class="docutils literal notranslate"><span class="pre">key2=value2</span></code> and so on in the following
example: <code class="docutils literal notranslate"><span class="pre">input</span> <span class="pre">|</span> <span class="pre">community.routeros.list_to_dict(key1=value1,</span> <span class="pre">key2=value2,</span> <span class="pre">...)</span></code></p> example: <code class="docutils literal notranslate"><span class="pre">input</span> <span class="pre">|</span> <span class="pre">community.routeros.list_to_dict(key1=value1,</span> <span class="pre">key2=value2,</span> <span class="pre">...)</span></code></p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
@ -221,7 +221,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
</table> </table>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Convert a list to a dictionary</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Convert a list to a dictionary</span>
<span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span> <span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span>
<span class="w"> </span><span class="nt">dictionary</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">&#39;foo=bar&#39;</span><span class="o">,</span> <span class="s1">&#39;comment=foo is bar&#39;</span><span class="o">]</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.list_to_dict</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="w"> </span><span class="nt">dictionary</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">&#39;foo=bar&#39;</span><span class="o">,</span> <span class="s1">&#39;comment=foo is bar&#39;</span><span class="o">]</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.list_to_dict</span> <span class="cp">}}</span><span class="s">&quot;</span>
@ -230,7 +230,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
</div> </div>
</section> </section>
<section id="return-value"> <section id="return-value">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
@ -249,7 +249,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
@ -259,7 +259,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
</div> </div>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

24
branch/main/quote_argument_filter.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.quote_argument_value filter – Quote an argument value" href="quote_argument_value_filter.html" /> <link rel="next" title="community.routeros.quote_argument_value filter – Quote an argument value" href="quote_argument_value_filter.html" />
@ -138,7 +138,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-quote-argument-filter"></span><section id="community-routeros-quote-argument-filter-quote-an-argument"> <span class="target" id="ansible-collections-community-routeros-quote-argument-filter"></span><section id="community-routeros-quote-argument-filter-quote-an-argument">
<h1>community.routeros.quote_argument filter – Quote an argument<a class="headerlink" href="#community-routeros-quote-argument-filter-quote-an-argument" title="Permalink 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.9.0).</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.9.0).</p>
@ -155,13 +155,13 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Quote an argument.</p></li> <li><p>Quote an argument.</p></li>
</ul> </ul>
</section> </section>
<section id="input"> <section id="input">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Link to this heading"></a></h2>
<p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.quote_argument</span></code>.</p> <p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.quote_argument</span></code>.</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -181,7 +181,7 @@
</table> </table>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Quote a RouterOS CLI command argument</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Quote a RouterOS CLI command argument</span>
<span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span> <span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span>
<span class="w"> </span><span class="nt">quoted</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="s1">&#39;comment=this is a &quot;comment&quot;&#39;</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="w"> </span><span class="nt">quoted</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="s1">&#39;comment=this is a &quot;comment&quot;&#39;</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument</span> <span class="cp">}}</span><span class="s">&quot;</span>
@ -190,7 +190,7 @@
</div> </div>
</section> </section>
<section id="return-value"> <section id="return-value">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
@ -209,7 +209,7 @@
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
@ -219,7 +219,7 @@
</div> </div>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

24
branch/main/quote_argument_value_filter.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.split filter – Split a command into arguments" href="split_filter.html" /> <link rel="next" title="community.routeros.split filter – Split a command into arguments" href="split_filter.html" />
@ -138,7 +138,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-quote-argument-value-filter"></span><section id="community-routeros-quote-argument-value-filter-quote-an-argument-value"> <span class="target" id="ansible-collections-community-routeros-quote-argument-value-filter"></span><section id="community-routeros-quote-argument-value-filter-quote-an-argument-value">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -155,13 +155,13 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Quote an argument value.</p></li> <li><p>Quote an argument value.</p></li>
</ul> </ul>
</section> </section>
<section id="input"> <section id="input">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Link to this heading"></a></h2>
<p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.quote_argument_value</span></code>.</p> <p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.quote_argument_value</span></code>.</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -181,7 +181,7 @@
</table> </table>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Quote a RouterOS CLI command argument&#39;s value</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Quote a RouterOS CLI command argument&#39;s value</span>
<span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span> <span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span>
<span class="w"> </span><span class="nt">quoted</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="s1">&#39;this is a &quot;comment&quot;&#39;</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument_value</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="w"> </span><span class="nt">quoted</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="s1">&#39;this is a &quot;comment&quot;&#39;</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument_value</span> <span class="cp">}}</span><span class="s">&quot;</span>
@ -190,7 +190,7 @@
</div> </div>
</section> </section>
<section id="return-value"> <section id="return-value">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
@ -209,7 +209,7 @@
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
@ -219,7 +219,7 @@
</div> </div>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

18
branch/main/routeros_cliconf.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.join filter – Join a list of arguments to a command" href="join_filter.html" /> <link rel="next" title="community.routeros.join filter – Join a list of arguments to a command" href="join_filter.html" />
@ -135,7 +135,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-routeros-cliconf"></span><section id="community-routeros-routeros-cliconf-use-routeros-cliconf-to-run-command-on-mikrotik-routeros-platform"> <span class="target" id="ansible-collections-community-routeros-routeros-cliconf"></span><section id="community-routeros-routeros-cliconf-use-routeros-cliconf-to-run-command-on-mikrotik-routeros-platform">
<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="Permalink 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.9.0).</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.9.0).</p>
@ -148,12 +148,12 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>This routeros plugin provides low level abstraction apis for sending and receiving CLI commands from MikroTik RouterOS network devices.</p></li> <li><p>This routeros plugin provides low level abstraction apis for sending and receiving CLI commands from MikroTik RouterOS network devices.</p></li>
</ul> </ul>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Egor Zaitsev (&#64;heuels)</p></li> <li><p>Egor Zaitsev (&#64;heuels)</p></li>
</ul> </ul>
@ -163,7 +163,7 @@
</div> </div>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>

10
branch/main/search.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/searchtools.js"></script> <script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/language_data.js"></script>

2
branch/main/searchindex.js
View file

File diff suppressed because one or more lines are too long

24
branch/main/split_filter.html
View file

@ -14,11 +14,11 @@
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="prev" title="community.routeros.quote_argument_value filter – Quote an argument value" href="quote_argument_value_filter.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme --> <link rel="prev" title="community.routeros.quote_argument_value filter – Quote an argument value" href="quote_argument_value_filter.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -137,7 +137,7 @@
<div itemprop="articleBody"> <div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-split-filter"></span><section id="community-routeros-split-filter-split-a-command-into-arguments"> <span class="target" id="ansible-collections-community-routeros-split-filter"></span><section id="community-routeros-split-filter-split-a-command-into-arguments">
<h1>community.routeros.split filter – Split a command into arguments<a class="headerlink" href="#community-routeros-split-filter-split-a-command-into-arguments" title="Permalink 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.9.0).</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.9.0).</p>
@ -154,13 +154,13 @@
</ul> </ul>
</nav> </nav>
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Split a command into arguments.</p></li> <li><p>Split a command into arguments.</p></li>
</ul> </ul>
</section> </section>
<section id="input"> <section id="input">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id2" role="doc-backlink">Input</a><a class="headerlink" href="#input" title="Link to this heading"></a></h2>
<p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.split</span></code>.</p> <p>This describes the input of the filter, the value before <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">community.routeros.split</span></code>.</p>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
@ -180,7 +180,7 @@
</table> </table>
</section> </section>
<section id="examples"> <section id="examples">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Split command into list of arguments</span> <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Split command into list of arguments</span>
<span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span> <span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span>
<span class="w"> </span><span class="nt">argument_list</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="s1">&#39;foo=bar comment=&quot;foo is bar&quot; baz&#39;</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.split</span> <span class="cp">}}</span><span class="s">&quot;</span> <span class="w"> </span><span class="nt">argument_list</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;</span><span class="cp">{{</span> <span class="s1">&#39;foo=bar comment=&quot;foo is bar&quot; baz&#39;</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.split</span> <span class="cp">}}</span><span class="s">&quot;</span>
@ -189,7 +189,7 @@
</div> </div>
</section> </section>
<section id="return-value"> <section id="return-value">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2> <h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Value</a><a class="headerlink" href="#return-value" title="Link to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%"> <table class="ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"><th class="head"><p>Key</p></th> <tr class="row-odd"><th class="head"><p>Key</p></th>
@ -208,7 +208,7 @@
</tbody> </tbody>
</table> </table>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Felix Fontein (&#64;felixfontein)</p></li> <li><p>Felix Fontein (&#64;felixfontein)</p></li>
</ul> </ul>
@ -218,7 +218,7 @@
</div> </div>
</section> </section>
<section id="collection-links"> <section id="collection-links">
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3> <h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
<p class="ansible-links"> <p class="ansible-links">
<a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/ansible-collections/community.routeros/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> <a href="https://github.com/ansible-collections/community.routeros" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>