mirror.MikroTik/ansible-collections.community.routeros
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.routeros.git synced 2025-07-10 10:14:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

deploy: 1e0c582b98

Browse source
This commit is contained in:
felixfontein 2024-12-28 15:53:48 +00:00
parent 5aeaf693d1
commit aa38b1a5b5
7 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

2
branch/main/api_facts_module.html
View file

@ -251,7 +251,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-facts-module-parameter-port"><strong>port</strong></p> <div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-facts-module-parameter-port"><strong>port</strong></p>
<a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>RouterOS api port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p> <td><div class="ansible-option-cell"><p>RouterOS API port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p>
<p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p> <p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p>
</div></td> </div></td>
</tr> </tr>

2
branch/main/api_find_and_modify_module.html
View file

@ -275,7 +275,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-find-and-modify-module-parameter-port"><strong>port</strong></p> <div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-find-and-modify-module-parameter-port"><strong>port</strong></p>
<a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>RouterOS api port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p> <td><div class="ansible-option-cell"><p>RouterOS API port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p>
<p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p> <p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p>
</div></td> </div></td>
</tr> </tr>

2
branch/main/api_info_module.html
View file

@ -545,7 +545,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-info-module-parameter-port"><strong>port</strong></p> <div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-info-module-parameter-port"><strong>port</strong></p>
<a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>RouterOS api port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p> <td><div class="ansible-option-cell"><p>RouterOS API port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p>
<p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p> <p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p>
</div></td> </div></td>
</tr> </tr>

2
branch/main/api_modify_module.html
View file

@ -565,7 +565,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-port"><strong>port</strong></p> <div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-port"><strong>port</strong></p>
<a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>RouterOS api port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p> <td><div class="ansible-option-cell"><p>RouterOS API port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p>
<p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p> <p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p>
</div></td> </div></td>
</tr> </tr>

10
branch/main/api_module.html
View file

@ -171,7 +171,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Ansible module for RouterOS API with the Python <code class="docutils literal notranslate"><span class="pre">librouteros</span></code> library.</p></li> <li><p>Ansible module for RouterOS API with the Python <code class="docutils literal notranslate"><span class="pre">librouteros</span></code> library.</p></li>
<li><p>This module can add, remove, update, query and execute arbitrary command in RouterOS via API.</p></li> <li><p>This module can add, remove, update, query, and execute arbitrary command in RouterOS through the API.</p></li>
</ul> </ul>
</section> </section>
<section id="requirements"> <section id="requirements">
@ -367,7 +367,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p> <a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Main path for all other arguments.</p> <td><div class="ansible-option-cell"><p>Main path for all other arguments.</p>
<p>If other arguments are not set, api will return all items in selected path.</p> <p>If other arguments are not set, the module will return all items in selected path.</p>
<p>Example <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. Equivalent of RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">print</span></code>.</p> <p>Example <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. Equivalent of RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">print</span></code>.</p>
</div></td> </div></td>
</tr> </tr>
@ -375,7 +375,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-parameter-port"><strong>port</strong></p> <div class="ansibleOptionAnchor" id="parameter-port"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-parameter-port"><strong>port</strong></p>
<a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> <a class="ansibleOptionLink" href="#parameter-port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>RouterOS api port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p> <td><div class="ansible-option-cell"><p>RouterOS API port. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-tls"><span class="std std-ref"><span class="pre">tls</span></span></a></strong></code> is set, port will apply to TLS/SSL connection.</p>
<p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p> <p>Defaults are <code class="ansible-value docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="ansible-value docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</p>
</div></td> </div></td>
</tr> </tr>
@ -430,7 +430,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<a class="ansibleOptionLink" href="#parameter-update" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> <a class="ansibleOptionLink" href="#parameter-update" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>Update config/value in RouterOS by ‘.id’ in selected path.</p> <td><div class="ansible-option-cell"><p>Update config/value in RouterOS by ‘.id’ in selected path.</p>
<p>Example <code class="ansible-value docutils literal notranslate"><span class="pre">.id=*03</span> <span class="pre">address=1.1.1.3/32</span></code> and path <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> will replace existing ip address with <code class="docutils literal notranslate"><span class="pre">.id=*03</span></code>.</p> <p>Example <code class="ansible-value docutils literal notranslate"><span class="pre">.id=*03</span> <span class="pre">address=1.1.1.3/32</span></code> and path <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> will replace the existing IP address with <code class="docutils literal notranslate"><span class="pre">.id=*03</span></code>.</p>
<p>Equivalent in RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">set</span> <span class="pre">address=1.1.1.3/32</span> <span class="pre">numbers=1</span></code>.</p> <p>Equivalent in RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">set</span> <span class="pre">address=1.1.1.3/32</span> <span class="pre">numbers=1</span></code>.</p>
<p>Note <code class="docutils literal notranslate"><span class="pre">number</span></code> in RouterOS CLI is different from <code class="docutils literal notranslate"><span class="pre">.id</span></code>.</p> <p>Note <code class="docutils literal notranslate"><span class="pre">number</span></code> in RouterOS CLI is different from <code class="docutils literal notranslate"><span class="pre">.id</span></code>.</p>
</div></td> </div></td>
@ -666,7 +666,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
<div class="ansibleOptionAnchor" id="return-message"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-return-message"><strong>message</strong></p> <div class="ansibleOptionAnchor" id="return-message"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-return-message"><strong>message</strong></p>
<a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p> <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td> </div></td>
<td><div class="ansible-option-cell"><p>All outputs are in list with dictionary elements returned from RouterOS api.</p> <td><div class="ansible-option-cell"><p>All outputs are in list with dictionary elements returned from RouterOS API.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> <p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{&quot;address&quot;:</span> <span class="pre">&quot;1.2.3.4&quot;},</span> <span class="pre">{&quot;address&quot;:</span> <span class="pre">&quot;2.3.4.5&quot;}]</span></code></p> <p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{&quot;address&quot;:</span> <span class="pre">&quot;1.2.3.4&quot;},</span> <span class="pre">{&quot;address&quot;:</span> <span class="pre">&quot;2.3.4.5&quot;}]</span></code></p>
</div></td> </div></td>

2
branch/main/routeros_cliconf.html
View file

@ -154,7 +154,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<section id="synopsis"> <section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>This routeros plugin provides low level abstraction apis for sending and receiving CLI commands from MikroTik RouterOS network devices.</p></li> <li><p>This routeros plugin provides low level abstraction APIs for sending and receiving CLI commands from MikroTik RouterOS network devices.</p></li>
</ul> </ul>
<section id="authors"> <section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3> <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>

2
branch/main/searchindex.js
View file

File diff suppressed because one or more lines are too long