mirror of
https://github.com/ansible-collections/community.routeros.git
synced 2025-06-22 18:03:34 +02:00
deploy: 2333efcf0f
This commit is contained in:
felixfontein
parent
581f29a187
commit
cda70580f8
11 changed files with 170 additions and 170 deletions
|
|
@ -192,7 +192,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-add" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Will add selected arguments in selected path to RouterOS config.</p>
|
||||
<p>Example <code class="docutils literal notranslate"><span class="pre">address=1.1.1.1/32</span> <span class="pre">interface=ether1</span></code>.</p>
|
||||
<p>Example <code class="ansible-value docutils literal notranslate"><span class="pre">address=1.1.1.1/32</span> <span class="pre">interface=ether1</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">add</span> <span class="pre">address=1.1.1.1/32</span> <span class="pre">interface=ether1</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
@ -202,7 +202,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>PEM formatted file that contains a CA certificate to be used for certificate validation.</p>
|
||||
<p>See also <em>validate_cert_hostname</em>. Only used when <em>tls=true</em> and <em>validate_certs=true</em>.</p>
|
||||
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-validate-cert-hostname"><span class="std std-ref"><span class="pre">validate_cert_hostname</span></span></a></strong></code>. Only used when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code> and <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs=true</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
|
|
@ -210,8 +210,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-cmd" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Execute any/arbitrary command in selected path, after the command we can add <code class="docutils literal notranslate"><span class="pre">.id</span></code>.</p>
|
||||
<p>Example path <code class="docutils literal notranslate"><span class="pre">system</span> <span class="pre">script</span></code> and cmd <code class="docutils literal notranslate"><span class="pre">run</span> <span class="pre">.id=*03</span></code> is equivalent in RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/system</span> <span class="pre">script</span> <span class="pre">run</span> <span class="pre">number=0</span></code>.</p>
|
||||
<p>Example path <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> and cmd <code class="docutils literal notranslate"><span class="pre">print</span></code> is equivalent in 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 path <code class="ansible-value docutils literal notranslate"><span class="pre">system</span> <span class="pre">script</span></code> and cmd <code class="ansible-value docutils literal notranslate"><span class="pre">run</span> <span class="pre">.id=*03</span></code> is equivalent in RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/system</span> <span class="pre">script</span> <span class="pre">run</span> <span class="pre">number=0</span></code>.</p>
|
||||
<p>Example path <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> and cmd <code class="ansible-value docutils literal notranslate"><span class="pre">print</span></code> is equivalent in 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>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
|
|
@ -220,7 +220,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<p><span class="ansible-option-versionadded">added in community.routeros 2.1.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use the specified encoding when communicating with the RouterOS device.</p>
|
||||
<p>Default is <code class="docutils literal notranslate"><span class="pre">ASCII</span></code>. Note that <code class="docutils literal notranslate"><span class="pre">UTF-8</span></code> requires librouteros 3.2.1 or newer.</p>
|
||||
<p>Default is <code class="ansible-value docutils literal notranslate"><span class="pre">ASCII</span></code>. Note that <code class="ansible-value docutils literal notranslate"><span class="pre">UTF-8</span></code> requires librouteros 3.2.1 or newer.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"ASCII"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
@ -237,7 +237,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-extended_query/attributes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The list of attributes to return.</p>
|
||||
<p>Every attribute used in a <em>where</em> clause need to be listed here.</p>
|
||||
<p>Every attribute used in a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where"><span class="std std-ref"><span class="pre">extended_query.where[]</span></span></a></strong></code> clause need to be listed here.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
|
|
@ -245,15 +245,15 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-extended_query/where" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Allows to restrict the objects returned.</p>
|
||||
<p>The conditions here must all match. An <em>or</em> condition needs at least one of its conditions to match.</p>
|
||||
<p>The conditions here must all match. An <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-or"><span class="std std-ref"><span class="pre">extended_query.where[].or</span></span></a></strong></code> condition needs at least one of its conditions to match.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-extended_query/where/attribute"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-parameter-extended-query-where-attribute"><strong>attribute</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-extended_query/where/attribute" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The attribute to match. Must be part of <em>attributes</em>.</p>
|
||||
<p>Either <em>or</em> or all of <em>attribute</em>, <em>is</em>, and <em>value</em> have to be specified.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The attribute to match. Must be part of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-attributes"><span class="std std-ref"><span class="pre">extended_query.attributes</span></span></a></strong></code>.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-or"><span class="std std-ref"><span class="pre">extended_query.where[].or</span></span></a></strong></code> or all of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-attribute"><span class="std std-ref"><span class="pre">extended_query.where[].attribute</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-is"><span class="std std-ref"><span class="pre">extended_query.where[].is</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-value"><span class="std std-ref"><span class="pre">extended_query.where[].value</span></span></a></strong></code> have to be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
|
|
@ -261,9 +261,9 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-extended_query/where/is" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The operator to use for matching.</p>
|
||||
<p>For equality use <code class="docutils literal notranslate"><span class="pre">==</span></code> or <code class="docutils literal notranslate"><span class="pre">eq</span></code>. For less use <code class="docutils literal notranslate"><span class="pre"><</span></code> or <code class="docutils literal notranslate"><span class="pre">less</span></code>. For more use <code class="docutils literal notranslate"><span class="pre">></span></code> or <code class="docutils literal notranslate"><span class="pre">more</span></code>.</p>
|
||||
<p>Use <code class="docutils literal notranslate"><span class="pre">in</span></code> to check whether the value is part of a list. In that case, <em>value</em> must be a list.</p>
|
||||
<p>Either <em>or</em> or all of <em>attribute</em>, <em>is</em>, and <em>value</em> have to be specified.</p>
|
||||
<p>For equality use <code class="ansible-value docutils literal notranslate"><span class="pre">==</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">eq</span></code>. For less use <code class="ansible-value docutils literal notranslate"><span class="pre"><</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">less</span></code>. For more use <code class="ansible-value docutils literal notranslate"><span class="pre">></span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">more</span></code>.</p>
|
||||
<p>Use <code class="ansible-value docutils literal notranslate"><span class="pre">in</span></code> to check whether the value is part of a list. In that case, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-value"><span class="std std-ref"><span class="pre">extended_query.where[].value</span></span></a></strong></code> must be a list.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-or"><span class="std std-ref"><span class="pre">extended_query.where[].or</span></span></a></strong></code> or all of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-attribute"><span class="std std-ref"><span class="pre">extended_query.where[].attribute</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-is"><span class="std std-ref"><span class="pre">extended_query.where[].is</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-value"><span class="std std-ref"><span class="pre">extended_query.where[].value</span></span></a></strong></code> have to be specified.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"=="</span></code></p></li>
|
||||
|
|
@ -283,14 +283,14 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-extended_query/where/or" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>A list of conditions so that at least one of them has to match.</p>
|
||||
<p>Either <em>or</em> or all of <em>attribute</em>, <em>is</em>, and <em>value</em> have to be specified.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-or"><span class="std std-ref"><span class="pre">extended_query.where[].or</span></span></a></strong></code> or all of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-attribute"><span class="std std-ref"><span class="pre">extended_query.where[].attribute</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-is"><span class="std std-ref"><span class="pre">extended_query.where[].is</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-value"><span class="std std-ref"><span class="pre">extended_query.where[].value</span></span></a></strong></code> have to be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-extended_query/where/or/attribute"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-parameter-extended-query-where-or-attribute"><strong>attribute</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-extended_query/where/or/attribute" 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>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The attribute to match. Must be part of <em>attributes</em>.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The attribute to match. Must be part of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-attributes"><span class="std std-ref"><span class="pre">extended_query.attributes</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
|
|
@ -298,8 +298,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-extended_query/where/or/is" 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>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The operator to use for matching.</p>
|
||||
<p>For equality use <code class="docutils literal notranslate"><span class="pre">==</span></code> or <code class="docutils literal notranslate"><span class="pre">eq</span></code>. For less use <code class="docutils literal notranslate"><span class="pre"><</span></code> or <code class="docutils literal notranslate"><span class="pre">less</span></code>. For more use <code class="docutils literal notranslate"><span class="pre">></span></code> or <code class="docutils literal notranslate"><span class="pre">more</span></code>.</p>
|
||||
<p>Use <code class="docutils literal notranslate"><span class="pre">in</span></code> to check whether the value is part of a list. In that case, <em>value</em> must be a list.</p>
|
||||
<p>For equality use <code class="ansible-value docutils literal notranslate"><span class="pre">==</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">eq</span></code>. For less use <code class="ansible-value docutils literal notranslate"><span class="pre"><</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">less</span></code>. For more use <code class="ansible-value docutils literal notranslate"><span class="pre">></span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">more</span></code>.</p>
|
||||
<p>Use <code class="ansible-value docutils literal notranslate"><span class="pre">in</span></code> to check whether the value is part of a list. In that case, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-or-value"><span class="std std-ref"><span class="pre">extended_query.where[].or[].value</span></span></a></strong></code> must be a list.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"=="</span></code></p></li>
|
||||
|
|
@ -318,15 +318,15 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<div class="ansibleOptionAnchor" id="parameter-extended_query/where/or/value"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-parameter-extended-query-where-or-value"><strong>value</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-extended_query/where/or/value" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The value to compare to. Must be a list for <em>is=in</em>.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The value to compare to. Must be a list for <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-or-is"><span class="std std-ref"><span class="pre">extended_query.where[].or[].is=in</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-extended_query/where/value"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-module-parameter-extended-query-where-value"><strong>value</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-extended_query/where/value" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The value to compare to. Must be a list for <em>is=in</em>.</p>
|
||||
<p>Either <em>or</em> or all of <em>attribute</em>, <em>is</em>, and <em>value</em> have to be specified.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The value to compare to. Must be a list for <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-is"><span class="std std-ref"><span class="pre">extended_query.where[].is=in</span></span></a></code>.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-or"><span class="std std-ref"><span class="pre">extended_query.where[].or</span></span></a></strong></code> or all of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-attribute"><span class="std std-ref"><span class="pre">extended_query.where[].attribute</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-is"><span class="std std-ref"><span class="pre">extended_query.where[].is</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-extended-query-where-value"><span class="std std-ref"><span class="pre">extended_query.where[].value</span></span></a></strong></code> have to be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
|
|
@ -334,9 +334,9 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-force_no_cert" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.routeros 2.4.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="docutils literal notranslate"><span class="pre">true</span></code> to connect without a certificate when <em>tls=true</em>.</p>
|
||||
<p>See also <em>validate_certs</em>.</p>
|
||||
<p><strong>Note:</strong> this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at <em>validate_certs</em> and <em>ca_path</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> to connect without a certificate when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code>.</p>
|
||||
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs</span></span></a></strong></code>.</p>
|
||||
<p><strong>Note:</strong> this forces the use of anonymous Diffie-Hellman (ADH) ciphers. The protocol is susceptible to Man-in-the-Middle attacks, because the keys used in the exchange are not authenticated. Instead of simply connecting without a certificate to “make things work” have a look at <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-ca-path"><span class="std std-ref"><span class="pre">ca_path</span></span></a></strong></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
|
|
@ -364,15 +364,15 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
</div></td>
|
||||
<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>Example <code class="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>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<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>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>RouterOS api port. If <em>tls</em> is set, port will apply to TLS/SSL connection.</p>
|
||||
<p>Defaults are <code class="docutils literal notranslate"><span class="pre">8728</span></code> for the HTTP API, and <code class="docutils literal notranslate"><span class="pre">8729</span></code> for the HTTPS API.</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>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
|
|
@ -381,10 +381,10 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Query given path for selected query attributes from RouterOS aip.</p>
|
||||
<p>WHERE is key word which extend query. WHERE format is key operator value - with spaces.</p>
|
||||
<p>WHERE valid operators are <code class="docutils literal notranslate"><span class="pre">==</span></code> or <code class="docutils literal notranslate"><span class="pre">eq</span></code>, <code class="docutils literal notranslate"><span class="pre">!=</span></code> or <code class="docutils literal notranslate"><span class="pre">not</span></code>, <code class="docutils literal notranslate"><span class="pre">></span></code> or <code class="docutils literal notranslate"><span class="pre">more</span></code>, <code class="docutils literal notranslate"><span class="pre"><</span></code> or <code class="docutils literal notranslate"><span class="pre">less</span></code>.</p>
|
||||
<p>Example path <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> and query <code class="docutils literal notranslate"><span class="pre">.id</span> <span class="pre">address</span></code> will return only <code class="docutils literal notranslate"><span class="pre">.id</span></code> and <code class="docutils literal notranslate"><span class="pre">address</span></code> for all items in <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> path.</p>
|
||||
<p>Example path <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> and query <code class="docutils literal notranslate"><span class="pre">.id</span> <span class="pre">address</span> <span class="pre">WHERE</span> <span class="pre">address</span> <span class="pre">==</span> <span class="pre">1.1.1.3/32</span></code>. will return only <code class="docutils literal notranslate"><span class="pre">.id</span></code> and <code class="docutils literal notranslate"><span class="pre">address</span></code> for items in <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> path, where address is eq to 1.1.1.3/32.</p>
|
||||
<p>Example path <code class="docutils literal notranslate"><span class="pre">interface</span></code> and query <code class="docutils literal notranslate"><span class="pre">mtu</span> <span class="pre">name</span> <span class="pre">WHERE</span> <span class="pre">mut</span> <span class="pre">></span> <span class="pre">1400</span></code> will return only interfaces <code class="docutils literal notranslate"><span class="pre">mtu,name</span></code> where mtu is bigger than 1400.</p>
|
||||
<p>WHERE valid operators are <code class="ansible-value docutils literal notranslate"><span class="pre">==</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">eq</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">!=</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">not</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">></span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">more</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre"><</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">less</span></code>.</p>
|
||||
<p>Example path <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> and query <code class="ansible-value docutils literal notranslate"><span class="pre">.id</span> <span class="pre">address</span></code> will return only <code class="docutils literal notranslate"><span class="pre">.id</span></code> and <code class="docutils literal notranslate"><span class="pre">address</span></code> for all items in <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> path.</p>
|
||||
<p>Example path <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> and query <code class="ansible-value docutils literal notranslate"><span class="pre">.id</span> <span class="pre">address</span> <span class="pre">WHERE</span> <span class="pre">address</span> <span class="pre">==</span> <span class="pre">1.1.1.3/32</span></code>. will return only <code class="docutils literal notranslate"><span class="pre">.id</span></code> and <code class="docutils literal notranslate"><span class="pre">address</span></code> for items in <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code> path, where address is eq to 1.1.1.3/32.</p>
|
||||
<p>Example path <code class="ansible-value docutils literal notranslate"><span class="pre">interface</span></code> and query <code class="ansible-value docutils literal notranslate"><span class="pre">mtu</span> <span class="pre">name</span> <span class="pre">WHERE</span> <span class="pre">mut</span> <span class="pre">></span> <span class="pre">1400</span></code> will return only interfaces <code class="docutils literal notranslate"><span class="pre">mtu,name</span></code> where mtu is bigger than 1400.</p>
|
||||
<p>Equivalent in RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/interface</span> <span class="pre">print</span> <span class="pre">where</span> <span class="pre">mtu</span> <span class="pre">></span> <span class="pre">1400</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
@ -393,7 +393,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-remove" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Remove config/value from RouterOS by ‘.id’.</p>
|
||||
<p>Example <code class="docutils literal notranslate"><span class="pre">*03</span></code> will remove config/value with <code class="docutils literal notranslate"><span class="pre">id=*03</span></code> in selected path.</p>
|
||||
<p>Example <code class="ansible-value docutils literal notranslate"><span class="pre">*03</span></code> will remove config/value with <code class="docutils literal notranslate"><span class="pre">id=*03</span></code> in selected path.</p>
|
||||
<p>Equivalent in RouterOS CLI <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">remove</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>
|
||||
</div></td>
|
||||
|
|
@ -426,7 +426,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>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Update config/value in RouterOS by ‘.id’ in selected path.</p>
|
||||
<p>Example <code class="docutils literal notranslate"><span class="pre">.id=*03</span> <span class="pre">address=1.1.1.3/32</span></code> and path <code class="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 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>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>
|
||||
|
|
@ -443,8 +443,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-validate_cert_hostname" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="docutils literal notranslate"><span class="pre">true</span></code> to validate hostnames in certificates.</p>
|
||||
<p>See also <em>validate_certs</em>. Only used when <em>tls=true</em> and <em>validate_certs=true</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> to validate hostnames in certificates.</p>
|
||||
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs</span></span></a></strong></code>. Only used when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code> and <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs=true</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
|
|
@ -457,9 +457,9 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="docutils literal notranslate"><span class="pre">false</span></code> to skip validation of TLS certificates.</p>
|
||||
<p>See also <em>validate_cert_hostname</em>. Only used when <em>tls=true</em>.</p>
|
||||
<p><strong>Note:</strong> instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the <em>ca_path</em> option.</p>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> to skip validation of TLS certificates.</p>
|
||||
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-validate-cert-hostname"><span class="std std-ref"><span class="pre">validate_cert_hostname</span></span></a></strong></code>. Only used when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code>.</p>
|
||||
<p><strong>Note:</strong> instead of simply deactivating certificate validations to “make things work”, please consider creating your own CA certificate and using it to sign certificates used for your router. You can tell the module about your CA certificate with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-ca-path"><span class="std std-ref"><span class="pre">ca_path</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
|
|
@ -521,7 +521,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
|||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p><em>add</em>, <em>remove</em>, <em>update</em>, <em>cmd</em> and <em>query</em> are mutually exclusive.</p></li>
|
||||
<li><p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-add"><span class="std std-ref"><span class="pre">add</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-remove"><span class="std std-ref"><span class="pre">remove</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-update"><span class="std std-ref"><span class="pre">update</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-cmd"><span class="std std-ref"><span class="pre">cmd</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-module-parameter-query"><span class="std std-ref"><span class="pre">query</span></span></a></strong></code> are mutually exclusive.</p></li>
|
||||
<li><p>Use 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 for more specific modifications, and 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</span></a> module for a more controlled way of returning all entries for a path.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue