mirror of
https://github.com/ansible-collections/community.routeros.git
synced 2025-07-13 19:54:35 +02:00
deploy: f38b01d7bb
This commit is contained in:
parent
045c3ac273
commit
29cd5249a5
15 changed files with 368 additions and 362 deletions
|
@ -387,20 +387,20 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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="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">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</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="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="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">Do not collect hardware facts</span><span class="w"></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">Do not collect hardware facts</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api_facts</span><span class="p">:</span><span class="w"></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="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">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||||
<span class="w"> </span><span class="nt">gather_subset</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">gather_subset</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"!hardware"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"!hardware"</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -434,32 +434,32 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id7">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id7">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></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 'bridge' to 'my-bridge'</span><span class="w"></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 'bridge' to 'my-bridge'</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="w"> </span><span class="nt">community.routeros.api_find_and_modify</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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">interface bridge</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">interface bridge</span>
|
||||||
<span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">find</span><span class="p">:</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">bridge</span><span class="w"></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">bridge</span>
|
||||||
<span class="w"> </span><span class="nt">values</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">values</span><span class="p">:</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">my-bridge</span><span class="w"></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">my-bridge</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">Change IP address to 192.168.1.1 for interface bridge - assuming there is only one</span><span class="w"></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">Change IP address to 192.168.1.1 for interface bridge - assuming there is only one</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="w"> </span><span class="nt">community.routeros.api_find_and_modify</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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip address</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip address</span>
|
||||||
<span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">find</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">interface</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bridge</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">interface</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bridge</span>
|
||||||
<span class="w"> </span><span class="nt">values</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">values</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.1.1/24"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.1.1/24"</span>
|
||||||
<span class="w"> </span><span class="c1"># If there are zero entries, or more than one: fail! We expected that</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># If there are zero entries, or more than one: fail! We expected that</span>
|
||||||
<span class="w"> </span><span class="c1"># exactly one is configured.</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># exactly one is configured.</span>
|
||||||
<span class="w"> </span><span class="nt">require_matches_min</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">require_matches_min</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
|
||||||
<span class="w"> </span><span class="nt">require_matches_max</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">require_matches_max</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -340,6 +340,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">"ip</span> <span class="pre">accounting"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">accounting"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">accounting</span> <span class="pre">web-access"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">accounting</span> <span class="pre">web-access"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">address"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">address"</span></code></p></li>
|
||||||
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">arp"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud</span> <span class="pre">advanced"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud</span> <span class="pre">advanced"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">dhcp-client"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">dhcp-client"</span></code></p></li>
|
||||||
|
@ -355,6 +356,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">"ip</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">nat"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">nat"</span></code></p></li>
|
||||||
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">raw"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">service-port"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">service-port"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">hotspot</span> <span class="pre">service-port"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">hotspot</span> <span class="pre">service-port"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">ipsec</span> <span class="pre">identity"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">ipsec</span> <span class="pre">identity"</span></code></p></li>
|
||||||
|
@ -384,6 +386,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">"ipv6</span> <span class="pre">firewall</span> <span class="pre">address-list"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">address-list"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
||||||
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">raw"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd</span> <span class="pre">prefix</span> <span class="pre">default"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd</span> <span class="pre">prefix</span> <span class="pre">default"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">route"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">route"</span></code></p></li>
|
||||||
|
@ -588,18 +591,18 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></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="w"></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="w"> </span><span class="nt">community.routeros.api_info</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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip address</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip address</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip_addresses</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">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">Print data for IP addresses</span><span class="w"></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">Print data for IP addresses</span>
|
||||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip_addresses.result</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip_addresses.result</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -337,6 +337,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">"ip</span> <span class="pre">accounting"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">accounting"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">accounting</span> <span class="pre">web-access"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">accounting</span> <span class="pre">web-access"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">address"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">address"</span></code></p></li>
|
||||||
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">arp"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud</span> <span class="pre">advanced"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">cloud</span> <span class="pre">advanced"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">dhcp-client"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">dhcp-client"</span></code></p></li>
|
||||||
|
@ -352,6 +353,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">"ip</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">nat"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">nat"</span></code></p></li>
|
||||||
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">raw"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">service-port"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">firewall</span> <span class="pre">service-port"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">hotspot</span> <span class="pre">service-port"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">hotspot</span> <span class="pre">service-port"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">ipsec</span> <span class="pre">identity"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip</span> <span class="pre">ipsec</span> <span class="pre">identity"</span></code></p></li>
|
||||||
|
@ -381,6 +383,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">"ipv6</span> <span class="pre">firewall</span> <span class="pre">address-list"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">address-list"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">filter"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">mangle"</span></code></p></li>
|
||||||
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">firewall</span> <span class="pre">raw"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd</span> <span class="pre">prefix</span> <span class="pre">default"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">nd</span> <span class="pre">prefix</span> <span class="pre">default"</span></code></p></li>
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">route"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ipv6</span> <span class="pre">route"</span></code></p></li>
|
||||||
|
@ -570,43 +573,43 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></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="w"></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="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="nt">community.routeros.api_modify</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">community.routeros.api_modify</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip dhcp-server network</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip dhcp-server network</span>
|
||||||
<span class="w"> </span><span class="nt">handle_absent_entries</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">remove</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">handle_absent_entries</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">remove</span>
|
||||||
<span class="w"> </span><span class="nt">handle_entries_content</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">remove_as_much_as_possible</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">handle_entries_content</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">remove_as_much_as_possible</span>
|
||||||
<span class="w"> </span><span class="nt">ensure_order</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ensure_order</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">data</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.88.0/24</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.88.0/24</span>
|
||||||
<span class="w"> </span><span class="nt">comment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin network</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">comment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin network</span>
|
||||||
<span class="w"> </span><span class="nt">dns-server</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="w"> </span><span class="nt">dns-server</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">gateway</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="w"> </span><span class="nt">gateway</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="p p-Indicator">-</span><span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.0/24</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.0/24</span>
|
||||||
<span class="w"> </span><span class="nt">comment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">customer network 1</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">comment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">customer network 1</span>
|
||||||
<span class="w"> </span><span class="nt">dns-server</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.1</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">dns-server</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.1</span>
|
||||||
<span class="w"> </span><span class="nt">gateway</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.1</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">gateway</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.1</span>
|
||||||
<span class="w"> </span><span class="nt">netmask</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">24</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">netmask</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">24</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">Adjust NAT</span><span class="w"></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">Adjust NAT</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api_modify</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">community.routeros.api_modify</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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip firewall nat</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip firewall nat</span>
|
||||||
<span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">data</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">action</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">masquerade</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">action</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">masquerade</span>
|
||||||
<span class="w"> </span><span class="nt">chain</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">srcnat</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">chain</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">srcnat</span>
|
||||||
<span class="w"> </span><span class="nt">comment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">NAT to WAN</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">comment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">NAT to WAN</span>
|
||||||
<span class="w"> </span><span class="nt">out-interface-list</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">WAN</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">out-interface-list</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">WAN</span>
|
||||||
<span class="w"> </span><span class="c1"># Three ways to unset values:</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Three ways to unset values:</span>
|
||||||
<span class="w"> </span><span class="c1"># - nothing after `:`</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># - nothing after `:`</span>
|
||||||
<span class="w"> </span><span class="c1"># - "empty" value (null/~/None)</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># - "empty" value (null/~/None)</span>
|
||||||
<span class="w"> </span><span class="c1"># - prepend '!'</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># - prepend '!'</span>
|
||||||
<span class="w"> </span><span class="nt">out-interface</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">out-interface</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">to-addresses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">to-addresses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~</span>
|
||||||
<span class="w"> </span><span class="s">'!to-ports'</span><span class="p p-Indicator">:</span><span class="w"></span>
|
<span class="w"> </span><span class="s">'!to-ports'</span><span class="p p-Indicator">:</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -545,103 +545,103 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id7">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id7">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ipaddrd_printout</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ipaddrd_printout</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">Dump "Get example" output</span><span class="w"></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">Dump "Get example" output</span>
|
||||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">ipaddrd_printout</span> <span class="cp">}}</span><span class="s">'</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">ipaddrd_printout</span> <span class="cp">}}</span><span class="s">'</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">Add example - ip address</span><span class="w"></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">Add example - ip address</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
<span class="w"> </span><span class="nt">add</span><span class="p">:</span><span class="w"> </span><span class="s">"address=192.168.255.10/24</span><span class="nv"> </span><span class="s">interface=ether2"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">add</span><span class="p">:</span><span class="w"> </span><span class="s">"address=192.168.255.10/24</span><span class="nv"> </span><span class="s">interface=ether2"</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">Query example - ".id, address" in "ip address WHERE address == 192.168.255.10/24"</span><span class="w"></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">Query example - ".id, address" in "ip address WHERE address == 192.168.255.10/24"</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
<span class="w"> </span><span class="nt">query</span><span class="p">:</span><span class="w"> </span><span class="s">".id</span><span class="nv"> </span><span class="s">address</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">address</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="cp">{{</span> <span class="nv">ip2</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">query</span><span class="p">:</span><span class="w"> </span><span class="s">".id</span><span class="nv"> </span><span class="s">address</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">address</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="cp">{{</span> <span class="nv">ip2</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">queryout</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">queryout</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">Dump "Query example" output</span><span class="w"></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">Dump "Query example" output</span>
|
||||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">queryout</span> <span class="cp">}}</span><span class="s">'</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">queryout</span> <span class="cp">}}</span><span class="s">'</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">Extended query example - ".id,address,network" where address is not 192.168.255.10/24 or is 10.20.36.20/24</span><span class="w"></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">Extended query example - ".id,address,network" where address is not 192.168.255.10/24 or is 10.20.36.20/24</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
<span class="w"> </span><span class="nt">extended_query</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">extended_query</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">attributes</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">attributes</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">network</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">network</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">address</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">address</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.id</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.id</span>
|
||||||
<span class="w"> </span><span class="nt">where</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">where</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"network"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"network"</span>
|
||||||
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"=="</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"=="</span>
|
||||||
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.255.0"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.255.0"</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">or</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">or</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"address"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"address"</span>
|
||||||
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"!="</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"!="</span>
|
||||||
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.255.10/24"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.255.10/24"</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"address"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"address"</span>
|
||||||
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"eq"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"eq"</span>
|
||||||
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">"10.20.36.20/24"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">"10.20.36.20/24"</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"network"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">attribute</span><span class="p">:</span><span class="w"> </span><span class="s">"network"</span>
|
||||||
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"in"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">is</span><span class="p">:</span><span class="w"> </span><span class="s">"in"</span>
|
||||||
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">value</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"10.20.36.0"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"10.20.36.0"</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"192.168.255.0"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"192.168.255.0"</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">extended_queryout</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">extended_queryout</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">Dump "Extended query example" output</span><span class="w"></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">Dump "Extended query example" output</span>
|
||||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">extended_queryout</span> <span class="cp">}}</span><span class="s">'</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">extended_queryout</span> <span class="cp">}}</span><span class="s">'</span>
|
||||||
|
|
||||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Update example - ether2 ip addres with ".id = *14"</span><span class="w"></span>
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Update example - ether2 ip addres with ".id = *14"</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
<span class="w"> </span><span class="nt">update</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">>-</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">update</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">>-</span>
|
||||||
<span class="w"> </span><span class="no">.id=*14</span><span class="w"></span>
|
<span class="w"> </span><span class="no">.id=*14</span>
|
||||||
<span class="w"> </span><span class="no">address=192.168.255.20/24</span><span class="w"></span>
|
<span class="w"> </span><span class="no">address=192.168.255.20/24</span>
|
||||||
<span class="w"> </span><span class="no">comment=</span><span class="cp">{{</span> <span class="s1">'Update 192.168.255.10/24 to 192.168.255.20/24 on ether2'</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument_value</span> <span class="cp">}}</span><span class="w"></span>
|
<span class="w"> </span><span class="no">comment=</span><span class="cp">{{</span> <span class="s1">'Update 192.168.255.10/24 to 192.168.255.20/24 on ether2'</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument_value</span> <span class="cp">}}</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">Remove example - ether2 ip 192.168.255.20/24 with ".id = *14"</span><span class="w"></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">Remove example - ether2 ip 192.168.255.20/24 with ".id = *14"</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
<span class="w"> </span><span class="nt">remove</span><span class="p">:</span><span class="w"> </span><span class="s">"*14"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">remove</span><span class="p">:</span><span class="w"> </span><span class="s">"*14"</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">Arbitrary command example "/system identity print"</span><span class="w"></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">Arbitrary command example "/system identity print"</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"system</span><span class="nv"> </span><span class="s">identity"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"system</span><span class="nv"> </span><span class="s">identity"</span>
|
||||||
<span class="w"> </span><span class="nt">cmd</span><span class="p">:</span><span class="w"> </span><span class="s">"print"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">cmd</span><span class="p">:</span><span class="w"> </span><span class="s">"print"</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arbitraryout</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arbitraryout</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">Dump "Arbitrary command example" output</span><span class="w"></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">Dump "Arbitrary command example" output</span>
|
||||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">arbitraryout</span> <span class="cp">}}</span><span class="s">'</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">arbitraryout</span> <span class="cp">}}</span><span class="s">'</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -278,29 +278,29 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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="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="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 and check to see if output contains routeros</span><span class="w"></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 and check to see if output contains routeros</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span><span class="w"></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 resource print</span><span class="w"></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 resource print</span>
|
||||||
<span class="w"> </span><span class="nt">wait_for</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result[0] contains MikroTik</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">wait_for</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result[0] contains MikroTik</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 multiple commands on remote nodes</span><span class="w"></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 multiple commands on remote nodes</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">commands</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system routerboard print</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system routerboard print</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system identity print</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system identity print</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 multiple commands and evaluate the output</span><span class="w"></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 multiple commands and evaluate the output</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">commands</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system routerboard print</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system routerboard print</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/interface ethernet print</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/interface ethernet print</span>
|
||||||
<span class="w"> </span><span class="nt">wait_for</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">wait_for</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result[0] contains x86</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result[0] contains x86</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result[1] contains ether1</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result[1] contains ether1</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -134,33 +134,33 @@
|
||||||
<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="Permalink 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><span class="w"></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="w"></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="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
|
||||||
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||||
<span class="w"> </span><span class="nt">vars</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">vars</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.1.1</span><span class="w"></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.1.1</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test1234</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test1234</span>
|
||||||
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span>
|
||||||
<span class="w"> </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 address print"</span><span class="w"></span>
|
<span class="w"> </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 address print"</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></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">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">hostname</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">username</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
<span class="w"> </span><span class="c1"># The following options configure TLS/SSL.</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># The following options configure TLS/SSL.</span>
|
||||||
<span class="w"> </span><span class="c1"># Depending on your setup, these options need different values:</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Depending on your setup, these options need different values:</span>
|
||||||
<span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">validate_cert_hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">validate_cert_hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="c1"># If you are using your own PKI, specify the path to your CA certificate here:</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># If you are using your own PKI, specify the path to your CA certificate here:</span>
|
||||||
<span class="w"> </span><span class="c1"># ca_path: /path/to/ca-certificate.pem</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># ca_path: /path/to/ca-certificate.pem</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">print_path</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">print_path</span>
|
||||||
|
|
||||||
<span class="w"> </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">Show IP address of first interface</span><span class="w"></span>
|
<span class="w"> </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">Show IP address of first interface</span>
|
||||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">print_path.msg</span><span class="o">[</span><span class="m">0</span><span class="o">]</span><span class="nv">.address</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">print_path.msg</span><span class="o">[</span><span class="m">0</span><span class="o">]</span><span class="nv">.address</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>This results in the following output:</p>
|
<p>This results in the following output:</p>
|
||||||
|
@ -182,37 +182,37 @@
|
||||||
<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="Permalink 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><span class="w"></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="w"></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="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
|
||||||
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||||
<span class="w"> </span><span class="nt">module_defaults</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">module_defaults</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">group/community.routeros.api</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">group/community.routeros.api</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hostname</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.1</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hostname</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.1</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test1234</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test1234</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"># The following options configure TLS/SSL.</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"># The following options configure TLS/SSL.</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"># Depending on your setup, these options need different values</span><span class="p p-Indicator">:</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"># Depending on your setup, these options need different values</span><span class="p p-Indicator">:</span>
|
||||||
<span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">validate_cert_hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">validate_cert_hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="c1"># If you are using your own PKI, specify the path to your CA certificate here:</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># If you are using your own PKI, specify the path to your CA certificate here:</span>
|
||||||
<span class="w"> </span><span class="c1"># ca_path: /path/to/ca-certificate.pem</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># ca_path: /path/to/ca-certificate.pem</span>
|
||||||
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span>
|
||||||
<span class="w"> </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">Gather facts"</span><span class="w"></span>
|
<span class="w"> </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">Gather facts"</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api_facts</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">community.routeros.api_facts</span><span class="p">:</span>
|
||||||
|
|
||||||
<span class="w"> </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 address print"</span><span class="w"></span>
|
<span class="w"> </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 address print"</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">community.routeros.api</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"ip</span><span class="nv"> </span><span class="s">address"</span>
|
||||||
|
|
||||||
<span class="w"> </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">Change IP address to 192.168.1.1 for interface bridge</span><span class="w"></span>
|
<span class="w"> </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">Change IP address to 192.168.1.1 for interface bridge</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="w"> </span><span class="nt">community.routeros.api_find_and_modify</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip address</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ip address</span>
|
||||||
<span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">find</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">interface</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bridge</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">interface</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bridge</span>
|
||||||
<span class="w"> </span><span class="nt">values</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">values</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.1.1/24"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="s">"192.168.1.1/24"</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<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>
|
||||||
|
@ -243,71 +243,71 @@
|
||||||
<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="Permalink 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><span class="w"></span>
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span>
|
||||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install certificates on devices</span><span class="w"></span>
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install certificates on devices</span>
|
||||||
<span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">routers</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">routers</span>
|
||||||
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||||
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">block</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">block</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">set_fact</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">set_fact</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">random_password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'community.general.random_string'</span><span class="o">,</span> <span class="nv">length</span><span class="o">=</span><span class="m">32</span><span class="o">,</span> <span class="nv">override_all</span><span class="o">=</span><span class="s1">'0123456789abcdefghijklmnopqrstuvwxyz'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">random_password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'community.general.random_string'</span><span class="o">,</span> <span class="nv">length</span><span class="o">=</span><span class="m">32</span><span class="o">,</span> <span class="nv">override_all</span><span class="o">=</span><span class="s1">'0123456789abcdefghijklmnopqrstuvwxyz'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
|
|
||||||
<span class="w"> </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">Create PKCS#12 bundle</span><span class="w"></span>
|
<span class="w"> </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">Create PKCS#12 bundle</span>
|
||||||
<span class="w"> </span><span class="nt">openssl_pkcs12</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">openssl_pkcs12</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12</span>
|
||||||
<span class="w"> </span><span class="nt">certificate_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.pem</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">certificate_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.pem</span>
|
||||||
<span class="w"> </span><span class="nt">privatekey_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.key</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">privatekey_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.key</span>
|
||||||
<span class="w"> </span><span class="nt">friendly_name</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="s">'</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">friendly_name</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="s">'</span>
|
||||||
<span class="w"> </span><span class="nt">passphrase</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">random_password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">passphrase</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">random_password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="nt">mode</span><span class="p">:</span><span class="w"> </span><span class="s">"0600"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">mode</span><span class="p">:</span><span class="w"> </span><span class="s">"0600"</span>
|
||||||
<span class="w"> </span><span class="nt">changed_when</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">changed_when</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||||
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
|
||||||
|
|
||||||
<span class="w"> </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">Copy router certificate onto router</span><span class="w"></span>
|
<span class="w"> </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">Copy router certificate onto router</span>
|
||||||
<span class="w"> </span><span class="nt">ansible.netcommon.net_put</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ansible.netcommon.net_put</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="s">'keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="s">.p12'</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="s">'keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="s">.p12'</span>
|
||||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="s">.p12'</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="s">.p12'</span>
|
||||||
|
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install router certificate and clean up</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install router certificate and clean up</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">commands</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="c1"># Import certificate:</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Import certificate:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/certificate import name=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> file-name=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12 passphrase="</span><span class="cp">{{</span> <span class="nv">random_password</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/certificate import name=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> file-name=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12 passphrase="</span><span class="cp">{{</span> <span class="nv">random_password</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
|
||||||
<span class="w"> </span><span class="c1"># Remove PKCS12 bundle:</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Remove PKCS12 bundle:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/file remove </span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/file remove </span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12</span>
|
||||||
<span class="w"> </span><span class="c1"># Show certificates</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Show certificates</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/certificate print</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/certificate print</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output</span>
|
||||||
|
|
||||||
<span class="w"> </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">Show result of certificate import</span><span class="w"></span>
|
<span class="w"> </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">Show result of certificate import</span>
|
||||||
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output.stdout_lines[0]</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output.stdout_lines[0]</span>
|
||||||
|
|
||||||
<span class="w"> </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">Show certificates</span><span class="w"></span>
|
<span class="w"> </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">Show certificates</span>
|
||||||
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output.stdout_lines[2]</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output.stdout_lines[2]</span>
|
||||||
|
|
||||||
<span class="w"> </span><span class="nt">always</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">always</span><span class="p">:</span>
|
||||||
<span class="w"> </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">Wipe PKCS12 bundle</span><span class="w"></span>
|
<span class="w"> </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">Wipe PKCS12 bundle</span>
|
||||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">wipe keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">wipe keys/</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">.p12</span>
|
||||||
<span class="w"> </span><span class="nt">changed_when</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">changed_when</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||||
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">delegate_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
|
||||||
|
|
||||||
<span class="w"> </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">Use certificate</span><span class="w"></span>
|
<span class="w"> </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">Use certificate</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">commands</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ip service set www-ssl address=</span><span class="cp">{{</span> <span class="nv">admin_network</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> certificate=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> disabled=no tls-version=only-1.2</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ip service set www-ssl address=</span><span class="cp">{{</span> <span class="nv">admin_network</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> certificate=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> disabled=no tls-version=only-1.2</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ip service set api-ssl address=</span><span class="cp">{{</span> <span class="nv">admin_network</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> certificate=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> tls-version=only-1.2</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ip service set api-ssl address=</span><span class="cp">{{</span> <span class="nv">admin_network</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> certificate=</span><span class="cp">{{</span> <span class="nv">inventory_hostname</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> tls-version=only-1.2</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>The playbook also assumes that <code class="docutils literal notranslate"><span class="pre">admin_network</span></code> describes the network from which the HTTPS and API interface can be accessed. This can be for example <code class="docutils literal notranslate"><span class="pre">192.168.1.0/24</span></code>.</p>
|
<p>The playbook also assumes that <code class="docutils literal notranslate"><span class="pre">admin_network</span></code> describes the network from which the HTTPS and API interface can be accessed. This can be for example <code class="docutils literal notranslate"><span class="pre">192.168.1.0/24</span></code>.</p>
|
||||||
<p>When this playbook completed successfully, you should be able to use the HTTPS admin interface (reachable in a browser from <code class="docutils literal notranslate"><span class="pre">https://192.168.1.1/</span></code>, with the correct IP inserted), as well as 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> module with TLS and certificate validation enabled:</p>
|
<p>When this playbook completed successfully, you should be able to use the HTTPS admin interface (reachable in a browser from <code class="docutils literal notranslate"><span class="pre">https://192.168.1.1/</span></code>, with the correct IP inserted), as well as 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> module with TLS and certificate validation enabled:</p>
|
||||||
<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">community.routeros.api</span><span class="p">:</span><span class="w"></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">community.routeros.api</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tls</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tls</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">validate_cert_hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">validate_cert_hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||||
<span class="w"> </span><span class="nt">ca_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/ca-certificate.pem</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">ca_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/ca-certificate.pem</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -140,10 +140,10 @@
|
||||||
<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>
|
||||||
<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">community.routeros.command</span><span class="p">:</span><span class="w"></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">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="w"> </span><span class="nt">commands</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ip</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ip</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">print</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">print</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
|
@ -154,14 +154,14 @@
|
||||||
<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="Permalink 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><span class="w"></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="w"></span>
|
<span class="na">router ansible_host</span><span class="o">=</span><span class="s">192.168.2.1</span>
|
||||||
|
|
||||||
<span class="k">[routers:vars]</span><span class="w"></span>
|
<span class="k">[routers:vars]</span>
|
||||||
<span class="na">ansible_connection</span><span class="o">=</span><span class="s">ansible.netcommon.network_cli</span><span class="w"></span>
|
<span class="na">ansible_connection</span><span class="o">=</span><span class="s">ansible.netcommon.network_cli</span>
|
||||||
<span class="na">ansible_network_os</span><span class="o">=</span><span class="s">community.routeros.routeros</span><span class="w"></span>
|
<span class="na">ansible_network_os</span><span class="o">=</span><span class="s">community.routeros.routeros</span>
|
||||||
<span class="na">ansible_user</span><span class="o">=</span><span class="s">admin</span><span class="w"></span>
|
<span class="na">ansible_user</span><span class="o">=</span><span class="s">admin</span>
|
||||||
<span class="na">ansible_ssh_pass</span><span class="o">=</span><span class="s">test1234</span><span class="w"></span>
|
<span class="na">ansible_ssh_pass</span><span class="o">=</span><span class="s">test1234</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>This tells Ansible that you have a RouterOS device called <code class="docutils literal notranslate"><span class="pre">router</span></code> with IP <code class="docutils literal notranslate"><span class="pre">192.168.2.1</span></code>. Ansible should use the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.netcommon.network_cli connection plugin</span></a> together with the the <a class="reference internal" href="../routeros_cliconf.html#ansible-collections-community-routeros-routeros-cliconf"><span class="std std-ref">community.routeros.routeros cliconf plugin</span></a>. The credentials are stored as <code class="docutils literal notranslate"><span class="pre">ansible_user</span></code> and <code class="docutils literal notranslate"><span class="pre">ansible_ssh_pass</span></code> in the inventory.</p>
|
<p>This tells Ansible that you have a RouterOS device called <code class="docutils literal notranslate"><span class="pre">router</span></code> with IP <code class="docutils literal notranslate"><span class="pre">192.168.2.1</span></code>. Ansible should use the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span 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>
|
||||||
|
@ -169,28 +169,28 @@
|
||||||
<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="Permalink 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><span class="w"></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="w"></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="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">routers</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">routers</span>
|
||||||
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">gather_facts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||||
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span>
|
||||||
|
|
||||||
<span class="w"> </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">Gather system resources</span><span class="w"></span>
|
<span class="w"> </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">Gather system resources</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.command</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">commands</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system resource print</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/system resource print</span>
|
||||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">system_resource_print</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">system_resource_print</span>
|
||||||
|
|
||||||
<span class="w"> </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">Show system resources</span><span class="w"></span>
|
<span class="w"> </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">Show system resources</span>
|
||||||
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">system_resource_print.stdout_lines</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">system_resource_print.stdout_lines</span>
|
||||||
|
|
||||||
<span class="w"> </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">Gather facts</span><span class="w"></span>
|
<span class="w"> </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">Gather facts</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.facts</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">community.routeros.facts</span><span class="p">:</span>
|
||||||
|
|
||||||
<span class="w"> </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">Show a fact</span><span class="w"></span>
|
<span class="w"> </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">Show a fact</span>
|
||||||
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">"First</span><span class="nv"> </span><span class="s">IP</span><span class="nv"> </span><span class="s">address:</span><span class="nv"> </span><span class="cp">{{</span> <span class="nv">ansible_net_all_ipv4_addresses</span><span class="o">[</span><span class="m">0</span><span class="o">]</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">"First</span><span class="nv"> </span><span class="s">IP</span><span class="nv"> </span><span class="s">address:</span><span class="nv"> </span><span class="cp">{{</span> <span class="nv">ansible_net_all_ipv4_addresses</span><span class="o">[</span><span class="m">0</span><span class="o">]</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>This results in the following output:</p>
|
<p>This results in the following output:</p>
|
||||||
|
|
|
@ -240,19 +240,19 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id5">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id5">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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="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="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 only the config and default facts</span><span class="w"></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 only the config and default facts</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.facts</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">gather_subset</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">config</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">config</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">Do not collect hardware facts</span><span class="w"></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">Do not collect hardware facts</span>
|
||||||
<span class="w"> </span><span class="nt">community.routeros.facts</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">gather_subset</span><span class="p">:</span>
|
||||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"!hardware"</span><span class="w"></span>
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"!hardware"</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -179,10 +179,10 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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">"</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">'foo=bar'</span><span class="o">,</span> <span class="s1">'comment=foo is bar'</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">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">arguments</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">'foo=bar'</span><span class="o">,</span> <span class="s1">'comment=foo is bar'</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">"</span>
|
||||||
<span class="w"> </span><span class="c1"># Should result in 'foo=bar comment="foo is bar"'</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Should result in 'foo=bar comment="foo is bar"'</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -218,10 +218,10 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id4">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id4">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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">"</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">'foo=bar'</span><span class="o">,</span> <span class="s1">'comment=foo is bar'</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">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">dictionary</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="o">[</span><span class="s1">'foo=bar'</span><span class="o">,</span> <span class="s1">'comment=foo is bar'</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">"</span>
|
||||||
<span class="w"> </span><span class="c1"># dictionary == {'foo': 'bar', 'comment': 'foo is bar'}</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># dictionary == {'foo': 'bar', 'comment': 'foo is bar'}</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -179,10 +179,10 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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">"</span><span class="cp">{{</span> <span class="s1">'comment=this is a "comment"'</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">quoted</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="s1">'comment=this is a "comment"'</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.quote_argument</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="c1"># Should result in 'comment="this is a \"comment\""'</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Should result in 'comment="this is a \"comment\""'</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -179,10 +179,10 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink 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's value</span><span class="w"></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'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="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">"</span><span class="cp">{{</span> <span class="s1">'this is a "comment"'</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">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">quoted</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="s1">'this is a "comment"'</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">"</span>
|
||||||
<span class="w"> </span><span class="c1"># Should result in '"this is a \"comment\""'</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Should result in '"this is a \"comment\""'</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
File diff suppressed because one or more lines are too long
|
@ -178,10 +178,10 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="examples">
|
<section id="examples">
|
||||||
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink 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><span class="w"></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="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">"</span><span class="cp">{{</span> <span class="s1">'foo=bar comment="foo is bar" baz'</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.split</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
<span class="w"> </span><span class="nt">argument_list</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="s1">'foo=bar comment="foo is bar" baz'</span> <span class="o">|</span> <span class="nf">community</span><span class="nv">.routeros.split</span> <span class="cp">}}</span><span class="s">"</span>
|
||||||
<span class="w"> </span><span class="c1"># Should result in ['foo=bar', 'comment=foo is bar', 'baz']</span><span class="w"></span>
|
<span class="w"> </span><span class="c1"># Should result in ['foo=bar', 'comment=foo is bar', 'baz']</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue