mirror of
https://github.com/ansible-collections/community.routeros.git
synced 2025-06-22 01:49:02 +02:00
deploy: 2333efcf0f
This commit is contained in:
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-
|
||||||
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>PEM formatted file that contains a CA certificate to be used for certificate validation.</p>
|
<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-facts-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-facts-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-facts-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs=true</span></span></a></code>.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -201,7 +201,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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.1.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Use the specified encoding when communicating with the RouterOS device.</p>
|
<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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -210,9 +210,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.4.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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-facts-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code>.</p>
|
||||||
<p>See also <em>validate_certs</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-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 <em>validate_certs</em> and <em>ca_path</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 <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-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-facts-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -224,8 +224,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<div class="ansibleOptionAnchor" id="parameter-gather_subset"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><strong>gather_subset</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-gather_subset"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><strong>gather_subset</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-gather_subset" 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></p>
|
<a class="ansibleOptionLink" href="#parameter-gather_subset" 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></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include <code class="docutils literal notranslate"><span class="pre">all</span></code>, <code class="docutils literal notranslate"><span class="pre">hardware</span></code>, <code class="docutils literal notranslate"><span class="pre">interfaces</span></code>, and <code class="docutils literal notranslate"><span class="pre">routing</span></code>.</p>
|
<td><div class="ansible-option-cell"><p>When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include <code class="ansible-value docutils literal notranslate"><span class="pre">all</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code>.</p>
|
||||||
<p>Can specify a list of values to include a larger subset. Values can also be used with an initial <code class="docutils literal notranslate"><span class="pre">!</span></code> to specify that a specific subset should not be collected.</p>
|
<p>Can specify a list of values to include a larger subset. Values can also be used with an initial <code class="ansible-value docutils literal notranslate"><span class="pre">!</span></code> to specify that a specific subset should not be collected.</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">["all"]</span></code></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">["all"]</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -247,8 +247,8 @@ 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 <em>tls</em> 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="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>
|
<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>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -286,8 +286,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_certs</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-facts-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-facts-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-facts-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -300,9 +300,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_cert_hostname</em>. Only used when <em>tls=true</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-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-facts-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 <em>ca_path</em> option.</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-facts-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||||
|
@ -422,7 +422,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_all_ipv4_addresses" 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-ansible_facts/ansible_net_all_ipv4_addresses" 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 IPv4 addresses configured on the device.</p>
|
<td><div class="ansible-option-cell"><p>All IPv4 addresses configured on the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -430,7 +430,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_all_ipv6_addresses" 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-ansible_facts/ansible_net_all_ipv6_addresses" 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 IPv6 addresses configured on the device.</p>
|
<td><div class="ansible-option-cell"><p>All IPv6 addresses configured on the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -438,7 +438,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_arch" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_arch" title="Permalink to this return value"></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>The CPU architecture of the device.</p>
|
<td><div class="ansible-option-cell"><p>The CPU architecture of the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -446,7 +446,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with BGP instance information.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with BGP instance information.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -454,7 +454,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_peer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_peer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with BGP peer information.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with BGP peer information.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -462,7 +462,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_vpnv4_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_vpnv4_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with BGP vpnv4 route information.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with BGP vpnv4 route information.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -470,7 +470,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_cpu_load" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_cpu_load" title="Permalink to this return value"></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>Current CPU load.</p>
|
<td><div class="ansible-option-cell"><p>Current CPU load.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -486,7 +486,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_hostname" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_hostname" title="Permalink to this return value"></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>The configured hostname of the device.</p>
|
<td><div class="ansible-option-cell"><p>The configured hostname of the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -494,7 +494,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_interfaces" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_interfaces" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A hash of all interfaces running on the system.</p>
|
<td><div class="ansible-option-cell"><p>A hash of all interfaces running on the system.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -502,7 +502,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memfree_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memfree_mb" title="Permalink to this return value"></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>The available free memory on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The available free memory on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -510,7 +510,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memtotal_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memtotal_mb" title="Permalink to this return value"></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>The total memory on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The total memory on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -518,7 +518,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_model" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_model" title="Permalink to this return value"></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>The model name returned from the device.</p>
|
<td><div class="ansible-option-cell"><p>The model name returned from the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -526,7 +526,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_neighbors" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_neighbors" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>The list of neighbors from the remote device.</p>
|
<td><div class="ansible-option-cell"><p>The list of neighbors from the remote device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -534,7 +534,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with OSPF instances.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with OSPF instances.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -542,7 +542,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_neighbor" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_neighbor" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with OSPF neighbors.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with OSPF neighbors.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -550,7 +550,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary for routes in all routing tables.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary for routes in all routing tables.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -558,7 +558,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_serialnum" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_serialnum" title="Permalink to this return value"></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>The serial number of the remote device.</p>
|
<td><div class="ansible-option-cell"><p>The serial number of the remote device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -566,7 +566,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacefree_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacefree_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>The available disk space on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The available disk space on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -574,7 +574,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacetotal_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacetotal_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>The total disk space on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The total disk space on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -582,7 +582,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_uptime" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_uptime" title="Permalink to this return value"></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>The uptime of the device.</p>
|
<td><div class="ansible-option-cell"><p>The uptime of the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -590,7 +590,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_version" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_version" title="Permalink to this return value"></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>The operating system version running on the remote device.</p>
|
<td><div class="ansible-option-cell"><p>The operating system version running on the remote device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
@ -193,7 +193,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#parameter-allow_no_matches" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
<a class="ansibleOptionLink" href="#parameter-allow_no_matches" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Whether to allow that no match is found.</p>
|
<td><div class="ansible-option-cell"><p>Whether to allow that no match is found.</p>
|
||||||
<p>If not specified, this value is induced from whether <em>require_matches_min</em> is 0 or larger.</p>
|
<p>If not specified, this value is induced from whether <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-require-matches-min"><span class="std std-ref"><span class="pre">require_matches_min</span></span></a></strong></code> is 0 or larger.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||||
|
@ -207,7 +207,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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>PEM formatted file that contains a CA certificate to be used for certificate validation.</p>
|
<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-find-and-modify-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-find-and-modify-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-find-and-modify-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs=true</span></span></a></code>.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -216,7 +216,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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.1.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Use the specified encoding when communicating with the RouterOS device.</p>
|
<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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -225,8 +225,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#parameter-find" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
<a class="ansibleOptionLink" href="#parameter-find" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Fields to search for.</p>
|
<td><div class="ansible-option-cell"><p>Fields to search for.</p>
|
||||||
<p>The module will only consider entries in the given <em>path</em> that match all fields provided here.</p>
|
<p>The module will only consider entries in the given <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> that match all fields provided here.</p>
|
||||||
<p>Use YAML <code class="docutils literal notranslate"><span class="pre">~</span></code>, or prepend keys with <code class="docutils literal notranslate"><span class="pre">!</span></code>, to specify an unset value.</p>
|
<p>Use YAML <code class="ansible-value docutils literal notranslate"><span class="pre">~</span></code>, or prepend keys with <code class="ansible-value docutils literal notranslate"><span class="pre">!</span></code>, to specify an unset value.</p>
|
||||||
<p>Note that if the dictionary specified here is empty, every entry in the path will be matched.</p>
|
<p>Note that if the dictionary specified here is empty, every entry in the path will be matched.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -235,9 +235,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.4.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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-find-and-modify-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code>.</p>
|
||||||
<p>See also <em>validate_certs</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-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 <em>validate_certs</em> and <em>ca_path</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 <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-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-find-and-modify-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -264,15 +264,15 @@ 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>Path to query.</p>
|
<td><div class="ansible-option-cell"><p>Path to query.</p>
|
||||||
<p>An example value is <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. This is equivalent to running <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span></code> in the RouterOS CLI.</p>
|
<p>An example value is <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. This is equivalent to running <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span></code> in the RouterOS CLI.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<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-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 <em>tls</em> 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="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>
|
<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>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -328,8 +328,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_certs</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-find-and-modify-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-find-and-modify-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-find-and-modify-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -342,9 +342,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_cert_hostname</em>. Only used when <em>tls=true</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-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-find-and-modify-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 <em>ca_path</em> option.</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-find-and-modify-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||||
|
@ -356,8 +356,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<div class="ansibleOptionAnchor" id="parameter-values"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-find-and-modify-module-parameter-values"><strong>values</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-values"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-find-and-modify-module-parameter-values"><strong>values</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-values" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
<a class="ansibleOptionLink" href="#parameter-values" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>On all entries matching the conditions in <em>find</em>, set the keys of this option to the values specified here.</p>
|
<td><div class="ansible-option-cell"><p>On all entries matching the conditions in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-find"><span class="std std-ref"><span class="pre">find</span></span></a></strong></code>, set the keys of this option to the values specified here.</p>
|
||||||
<p>Use YAML <code class="docutils literal notranslate"><span class="pre">~</span></code>, or prepend keys with <code class="docutils literal notranslate"><span class="pre">!</span></code>, to specify to unset a value.</p>
|
<p>Use YAML <code class="ansible-value docutils literal notranslate"><span class="pre">~</span></code>, or prepend keys with <code class="ansible-value docutils literal notranslate"><span class="pre">!</span></code>, to specify to unset a value.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -413,7 +413,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<div class="admonition note">
|
<div class="admonition note">
|
||||||
<p class="admonition-title">Note</p>
|
<p class="admonition-title">Note</p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p>If you want to change values based on their old values (like change all comments ‘foo’ to ‘bar’) and make sure that there are at least N such values, you can use <em>require_matches_min=N</em> together with <em>allow_no_matches=true</em>. This will make the module fail if there are less than N such entries, but not if there is no match. The latter case is needed for idempotency of the task: once the values have been changed, there should be no further match.</p></li>
|
<li><p>If you want to change values based on their old values (like change all comments ‘foo’ to ‘bar’) and make sure that there are at least N such values, you can use <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-require-matches-min"><span class="std std-ref"><span class="pre">require_matches_min=N</span></span></a></code> together with <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-allow-no-matches"><span class="std std-ref"><span class="pre">allow_no_matches=true</span></span></a></code>. This will make the module fail if there are less than N such entries, but not if there is no match. The latter case is needed for idempotency of the task: once the values have been changed, there should be no further match.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
@ -480,7 +480,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<div class="ansibleOptionAnchor" id="return-match_count"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-find-and-modify-module-return-match-count"><strong>match_count</strong></p>
|
<div class="ansibleOptionAnchor" id="return-match_count"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-find-and-modify-module-return-match-count"><strong>match_count</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#return-match_count" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
<a class="ansibleOptionLink" href="#return-match_count" title="Permalink to this return value"></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>The number of entries that matched the criteria in <em>find</em>.</p>
|
<td><div class="ansible-option-cell"><p>The number of entries that matched the criteria in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-find-and-modify-module-parameter-find"><span class="std std-ref"><span class="pre">find</span></span></a></strong></code>.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">1</span></code></p>
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
|
|
|
@ -167,7 +167,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p>Allows to retrieve information for a path using the API.</p></li>
|
<li><p>Allows to retrieve information for a path using the API.</p></li>
|
||||||
<li><p>This can be used to backup a path to restore it with the <a class="reference internal" href="api_modify_module.html#ansible-collections-community-routeros-api-modify-module"><span class="std std-ref">community.routeros.api_modify</span></a> module.</p></li>
|
<li><p>This can be used to backup a path to restore it with the <a class="reference internal" href="api_modify_module.html#ansible-collections-community-routeros-api-modify-module"><span class="std std-ref">community.routeros.api_modify</span></a> module.</p></li>
|
||||||
<li><p>Entries are normalized, dynamic and builtin entries are not returned. Use the <em>handle_disabled</em> and <em>hide_defaults</em> options to control normalization, the <em>include_dynamic</em> and <em>include_builtin</em> options to also return dynamic resp. builtin entries, and use <em>unfiltered</em> to return all fields including counters.</p></li>
|
<li><p>Entries are normalized, dynamic and builtin entries are not returned. Use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-module-parameter-handle-disabled"><span class="std std-ref"><span class="pre">handle_disabled</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-module-parameter-hide-defaults"><span class="std std-ref"><span class="pre">hide_defaults</span></span></a></strong></code> options to control normalization, the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-module-parameter-include-dynamic"><span class="std std-ref"><span class="pre">include_dynamic</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-module-parameter-include-builtin"><span class="std std-ref"><span class="pre">include_builtin</span></span></a></strong></code> options to also return dynamic resp. builtin entries, and use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-module-parameter-unfiltered"><span class="std std-ref"><span class="pre">unfiltered</span></span></a></strong></code> to return all fields including counters.</p></li>
|
||||||
<li><p><strong>Note</strong> that this module is still heavily in development, and only supports <strong>some</strong> paths. If you want to support new paths, or think you found problems with existing paths, please first <a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/">create an issue in the community.routeros Issue Tracker</a>.</p></li>
|
<li><p><strong>Note</strong> that this module is still heavily in development, and only supports <strong>some</strong> paths. If you want to support new paths, or think you found problems with existing paths, please first <a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/">create an issue in the community.routeros Issue Tracker</a>.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
|
@ -194,7 +194,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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>PEM formatted file that contains a CA certificate to be used for certificate validation.</p>
|
<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-info-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-info-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-info-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs=true</span></span></a></code>.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -203,7 +203,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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.1.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Use the specified encoding when communicating with the RouterOS device.</p>
|
<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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -212,9 +212,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.4.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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-info-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code>.</p>
|
||||||
<p>See also <em>validate_certs</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-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 <em>validate_certs</em> and <em>ca_path</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 <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-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-info-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -227,9 +227,9 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<a class="ansibleOptionLink" href="#parameter-handle_disabled" 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-handle_disabled" 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>How to handle unset values.</p>
|
<td><div class="ansible-option-cell"><p>How to handle unset values.</p>
|
||||||
<p><code class="docutils literal notranslate"><span class="pre">exclamation</span></code> prepends the keys with <code class="docutils literal notranslate"><span class="pre">!</span></code> in the output with value <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p>
|
<p><code class="ansible-value docutils literal notranslate"><span class="pre">exclamation</span></code> prepends the keys with <code class="ansible-value docutils literal notranslate"><span class="pre">!</span></code> in the output with value <code class="ansible-value docutils literal notranslate"><span class="pre">null</span></code>.</p>
|
||||||
<p><code class="docutils literal notranslate"><span class="pre">null-value</span></code> uses the regular key with value <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p>
|
<p><code class="ansible-value docutils literal notranslate"><span class="pre">null-value</span></code> uses the regular key with value <code class="ansible-value docutils literal notranslate"><span class="pre">null</span></code>.</p>
|
||||||
<p><code class="docutils literal notranslate"><span class="pre">omit</span></code> omits these values from the result.</p>
|
<p><code class="ansible-value docutils literal notranslate"><span class="pre">omit</span></code> omits these values from the result.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"exclamation"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"exclamation"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||||
|
@ -264,7 +264,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Whether to include builtin values.</p>
|
<td><div class="ansible-option-cell"><p>Whether to include builtin values.</p>
|
||||||
<p>By default, they are not returned, and the <code class="docutils literal notranslate"><span class="pre">builtin</span></code> keys are omitted.</p>
|
<p>By default, they are not returned, and the <code class="docutils literal notranslate"><span class="pre">builtin</span></code> keys are omitted.</p>
|
||||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, they are returned as well, and the <code class="docutils literal notranslate"><span class="pre">builtin</span></code> keys are returned as well.</p>
|
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, they are returned as well, and the <code class="docutils literal notranslate"><span class="pre">builtin</span></code> keys are returned as well.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -278,7 +278,7 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Whether to include dynamic values.</p>
|
<td><div class="ansible-option-cell"><p>Whether to include dynamic values.</p>
|
||||||
<p>By default, they are not returned, and the <code class="docutils literal notranslate"><span class="pre">dynamic</span></code> keys are omitted.</p>
|
<p>By default, they are not returned, and the <code class="docutils literal notranslate"><span class="pre">dynamic</span></code> keys are omitted.</p>
|
||||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, they are returned as well, and the <code class="docutils literal notranslate"><span class="pre">dynamic</span></code> keys are returned as well.</p>
|
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, they are returned as well, and the <code class="docutils literal notranslate"><span class="pre">dynamic</span></code> keys are returned as well.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -298,7 +298,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>Path to query.</p>
|
<td><div class="ansible-option-cell"><p>Path to query.</p>
|
||||||
<p>An example value is <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. This is equivalent to running <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">print</span></code> in the RouterOS CLI.</p>
|
<p>An example value is <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. This is equivalent to running <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span> <span class="pre">print</span></code> in the RouterOS CLI.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"caps-man</span> <span class="pre">aaa"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"caps-man</span> <span class="pre">aaa"</span></code></p></li>
|
||||||
|
@ -450,8 +450,8 @@ 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 <em>tls</em> 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="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>
|
<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>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -502,8 +502,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_certs</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-info-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-info-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-info-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -516,9 +516,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_cert_hostname</em>. Only used when <em>tls=true</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-info-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-info-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 <em>ca_path</em> option.</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-info-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||||
|
|
|
@ -196,7 +196,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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>PEM formatted file that contains a CA certificate to be used for certificate validation.</p>
|
<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-modify-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-modify-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-modify-module-parameter-validate-certs"><span class="std std-ref"><span class="pre">validate_certs=true</span></span></a></code>.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -214,7 +214,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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.1.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Use the specified encoding when communicating with the RouterOS device.</p>
|
<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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -222,8 +222,8 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<div class="ansibleOptionAnchor" id="parameter-ensure_order"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-ensure-order"><strong>ensure_order</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-ensure_order"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-ensure-order"><strong>ensure_order</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-ensure_order" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
<a class="ansibleOptionLink" href="#parameter-ensure_order" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Whether to ensure the same order of the config as present in <em>data</em>.</p>
|
<td><div class="ansible-option-cell"><p>Whether to ensure the same order of the config as present in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code>.</p>
|
||||||
<p>Requires <em>handle_absent_entries=remove</em>.</p>
|
<p>Requires <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-module-parameter-handle-absent-entries"><span class="std std-ref"><span class="pre">handle_absent_entries=remove</span></span></a></code>.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -236,9 +236,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.4.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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-modify-module-parameter-tls"><span class="std std-ref"><span class="pre">tls=true</span></span></a></code>.</p>
|
||||||
<p>See also <em>validate_certs</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-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 <em>validate_certs</em> and <em>ca_path</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 <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-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-modify-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -250,9 +250,9 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<div class="ansibleOptionAnchor" id="parameter-handle_absent_entries"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-handle-absent-entries"><strong>handle_absent_entries</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-handle_absent_entries"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-handle-absent-entries"><strong>handle_absent_entries</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-handle_absent_entries" 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-handle_absent_entries" 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>How to handle entries that are present in the current config, but not in <em>data</em>.</p>
|
<td><div class="ansible-option-cell"><p>How to handle entries that are present in the current config, but not in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code>.</p>
|
||||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> ignores them.</p>
|
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> ignores them.</p>
|
||||||
<p><code class="docutils literal notranslate"><span class="pre">remove</span></code> removes them.</p>
|
<p><code class="ansible-value docutils literal notranslate"><span class="pre">remove</span></code> removes them.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||||
|
@ -264,10 +264,10 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
|
||||||
<div class="ansibleOptionAnchor" id="parameter-handle_entries_content"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-handle-entries-content"><strong>handle_entries_content</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-handle_entries_content"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-api-modify-module-parameter-handle-entries-content"><strong>handle_entries_content</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-handle_entries_content" 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-handle_entries_content" 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>For a single entry in <em>data</em>, this describes how to handle fields that are not mentioned in that entry, but appear in the actual config.</p>
|
<td><div class="ansible-option-cell"><p>For a single entry in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code>, this describes how to handle fields that are not mentioned in that entry, but appear in the actual config.</p>
|
||||||
<p>If <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, they are not modified.</p>
|
<p>If <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, they are not modified.</p>
|
||||||
<p>If <code class="docutils literal notranslate"><span class="pre">remove</span></code>, they are removed. If at least one cannot be removed, the module will fail.</p>
|
<p>If <code class="ansible-value docutils literal notranslate"><span class="pre">remove</span></code>, they are removed. If at least one cannot be removed, the module will fail.</p>
|
||||||
<p>If <code class="docutils literal notranslate"><span class="pre">remove_as_much_as_possible</span></code>, all that can be removed will be removed. The ones that cannot be removed will be kept.</p>
|
<p>If <code class="ansible-value docutils literal notranslate"><span class="pre">remove_as_much_as_possible</span></code>, all that can be removed will be removed. The ones that cannot be removed will be kept.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||||
|
@ -295,7 +295,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>Path to query.</p>
|
<td><div class="ansible-option-cell"><p>Path to query.</p>
|
||||||
<p>An example value is <code class="docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. This is equivalent to running modification commands in <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span></code> in the RouterOS CLI.</p>
|
<p>An example value is <code class="ansible-value docutils literal notranslate"><span class="pre">ip</span> <span class="pre">address</span></code>. This is equivalent to running modification commands in <code class="docutils literal notranslate"><span class="pre">/ip</span> <span class="pre">address</span></code> in the RouterOS CLI.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"caps-man</span> <span class="pre">aaa"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"caps-man</span> <span class="pre">aaa"</span></code></p></li>
|
||||||
|
@ -447,8 +447,8 @@ 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 <em>tls</em> 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="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>
|
<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>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -486,8 +486,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_certs</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-modify-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-modify-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-modify-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
@ -500,9 +500,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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_cert_hostname</em>. Only used when <em>tls=true</em>.</p>
|
<p>See also <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-api-modify-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-modify-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 <em>ca_path</em> option.</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-modify-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||||
|
|
|
@ -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>
|
<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>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Will add selected arguments in selected path to RouterOS config.</p>
|
<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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>PEM formatted file that contains a CA certificate to be used for certificate validation.</p>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<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>
|
<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>
|
</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>
|
<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="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="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">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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.1.0</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Use the specified encoding when communicating with the RouterOS device.</p>
|
<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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</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>
|
<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>
|
</div></td>
|
||||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The list of attributes to return.</p>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
<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>
|
<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>
|
</div></td>
|
||||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Allows to restrict the objects returned.</p>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
<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>
|
<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>
|
<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>
|
</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>
|
<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 <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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
<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>
|
<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>
|
</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>
|
<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>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="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>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 <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>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"=="</span></code></p></li>
|
<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>
|
<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>
|
</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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</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">
|
<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>
|
<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>
|
<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>
|
</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>
|
</div></td>
|
||||||
</tr>
|
</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">
|
<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>
|
<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>
|
</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>
|
<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>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="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>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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"=="</span></code></p></li>
|
<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>
|
<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>
|
<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>
|
</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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
<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>
|
<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>
|
<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>
|
</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>
|
<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 <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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 2.4.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_certs</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-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 <em>validate_certs</em> and <em>ca_path</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 <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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
</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, 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>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<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>
|
<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 <em>tls</em> 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="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>
|
<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>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<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>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Query given path for selected query attributes from RouterOS aip.</p>
|
<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 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>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="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="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="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="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="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>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>
|
<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>
|
</div></td>
|
||||||
</tr>
|
</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>
|
<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>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Remove config/value from RouterOS by ‘.id’.</p>
|
<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>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>
|
<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>
|
||||||
|
@ -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>
|
<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="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>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>
|
||||||
|
@ -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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_certs</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-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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
<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>
|
<p><span class="ansible-option-versionadded">added in community.routeros 1.2.0</span></p>
|
||||||
</div></td>
|
</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>
|
<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 <em>validate_cert_hostname</em>. Only used when <em>tls=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>.</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>
|
<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>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
<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">
|
<div class="admonition note">
|
||||||
<p class="admonition-title">Note</p>
|
<p class="admonition-title">Note</p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -179,7 +179,7 @@
|
||||||
<div class="ansibleOptionAnchor" id="parameter-commands"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-command-module-parameter-commands"><strong>commands</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-commands"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-command-module-parameter-commands"><strong>commands</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-commands" 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>
|
<a class="ansibleOptionLink" href="#parameter-commands" 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>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>List of commands to send to the remote RouterOS device over the configured provider. The resulting output from the command is returned. If the <em>wait_for</em> argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired.</p>
|
<td><div class="ansible-option-cell"><p>List of commands to send to the remote RouterOS device over the configured provider. The resulting output from the command is returned. If the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-command-module-parameter-wait-for"><span class="std std-ref"><span class="pre">wait_for</span></span></a></strong></code> argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -194,7 +194,7 @@
|
||||||
<div class="ansibleOptionAnchor" id="parameter-match"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-command-module-parameter-match"><strong>match</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-match"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-command-module-parameter-match"><strong>match</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-match" 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-match" 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>The <em>match</em> argument is used in conjunction with the <em>wait_for</em> argument to specify the match policy. Valid values are <code class="docutils literal notranslate"><span class="pre">all</span></code> or <code class="docutils literal notranslate"><span class="pre">any</span></code>. If the value is set to <code class="docutils literal notranslate"><span class="pre">all</span></code> then all conditionals in the wait_for must be satisfied. If the value is set to <code class="docutils literal notranslate"><span class="pre">any</span></code> then only one of the values must be satisfied.</p>
|
<td><div class="ansible-option-cell"><p>The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-command-module-parameter-match"><span class="std std-ref"><span class="pre">match</span></span></a></strong></code> argument is used in conjunction with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-command-module-parameter-wait-for"><span class="std std-ref"><span class="pre">wait_for</span></span></a></strong></code> argument to specify the match policy. Valid values are <code class="ansible-value docutils literal notranslate"><span class="pre">all</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">any</span></code>. If the value is set to <code class="ansible-value docutils literal notranslate"><span class="pre">all</span></code> then all conditionals in the wait_for must be satisfied. If the value is set to <code class="ansible-value docutils literal notranslate"><span class="pre">any</span></code> then only one of the values must be satisfied.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"any"</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"any"</span></code></p></li>
|
||||||
|
@ -206,7 +206,7 @@
|
||||||
<div class="ansibleOptionAnchor" id="parameter-retries"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-command-module-parameter-retries"><strong>retries</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-retries"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-command-module-parameter-retries"><strong>retries</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-retries" 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-retries" 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>Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the <em>wait_for</em> conditions.</p>
|
<td><div class="ansible-option-cell"><p>Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-command-module-parameter-wait-for"><span class="std std-ref"><span class="pre">wait_for</span></span></a></strong></code> conditions.</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">10</span></code></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">10</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
|
@ -222,16 +222,16 @@
|
||||||
</section>
|
</section>
|
||||||
<section id="setting-up-encryption">
|
<section id="setting-up-encryption">
|
||||||
<h2>Setting up encryption<a class="headerlink" href="#setting-up-encryption" title="Permalink to this heading"></a></h2>
|
<h2>Setting up encryption<a class="headerlink" href="#setting-up-encryption" title="Permalink to this heading"></a></h2>
|
||||||
<p>It is recommended to always use <code class="docutils literal notranslate"><span class="pre">tls:</span> <span class="pre">true</span></code> when connecting with the API, even if you are only connecting to the device through a trusted network. The following options control how TLS/SSL is used:</p>
|
<p>It is recommended to always use <code class="ansible-option-value docutils literal notranslate"><span class="pre">tls=true</span></code> when connecting with the API, even if you are only connecting to the device through a trusted network. The following options control how TLS/SSL is used:</p>
|
||||||
<dl class="field-list simple">
|
<dl class="field-list simple">
|
||||||
<dt class="field-odd">force_no_cert<span class="colon">:</span></dt>
|
<dt class="field-odd">force_no_cert<span class="colon">:</span></dt>
|
||||||
<dd class="field-odd"><p>Setting to <code class="docutils literal notranslate"><span class="pre">true</span></code> connects to the device without a certificate. <strong>This is discouraged to use in production and is susceptible to Man-in-the-Middle attacks</strong>, but might be useful when setting the device up. The default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
<dd class="field-odd"><p>Setting to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> connects to the device without a certificate. <strong>This is discouraged to use in production and is susceptible to Man-in-the-Middle attacks</strong>, but might be useful when setting the device up. The default value is <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt class="field-even">validate_certs<span class="colon">:</span></dt>
|
<dt class="field-even">validate_certs<span class="colon">:</span></dt>
|
||||||
<dd class="field-even"><p>Setting to <code class="docutils literal notranslate"><span class="pre">false</span></code> disables any certificate validation. <strong>This is discouraged to use in production</strong>, but is needed when setting the device up. The default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
<dd class="field-even"><p>Setting to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> disables any certificate validation. <strong>This is discouraged to use in production</strong>, but is needed when setting the device up. The default value is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt class="field-odd">validate_cert_hostname<span class="colon">:</span></dt>
|
<dt class="field-odd">validate_cert_hostname<span class="colon">:</span></dt>
|
||||||
<dd class="field-odd"><p>Setting to <code class="docutils literal notranslate"><span class="pre">false</span></code> (default) disables hostname verification during certificate validation. This is needed if the hostnames specified in the certificate do not match the hostname used for connecting (usually the device’s IP). It is recommended to set up the certificate correctly and set this to <code class="docutils literal notranslate"><span class="pre">true</span></code>; the default <code class="docutils literal notranslate"><span class="pre">false</span></code> is chosen for backwards compatibility to an older version of the module.</p>
|
<dd class="field-odd"><p>Setting to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> (default) disables hostname verification during certificate validation. This is needed if the hostnames specified in the certificate do not match the hostname used for connecting (usually the device’s IP). It is recommended to set up the certificate correctly and set this to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>; the default <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> is chosen for backwards compatibility to an older version of the module.</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt class="field-even">ca_path<span class="colon">:</span></dt>
|
<dt class="field-even">ca_path<span class="colon">:</span></dt>
|
||||||
<dd class="field-even"><p>If you are not using a commerically trusted CA certificate to sign your device’s certificate, or have not included your CA certificate in Python’s truststore, you need to point this option to the CA certificate.</p>
|
<dd class="field-even"><p>If you are not using a commerically trusted CA certificate to sign your device’s certificate, or have not included your CA certificate in Python’s truststore, you need to point this option to the CA certificate.</p>
|
||||||
|
|
|
@ -134,7 +134,7 @@
|
||||||
<li><p>The <a class="reference internal" href="../quote_argument_filter.html#ansible-collections-community-routeros-quote-argument-filter"><span class="std std-ref">community.routeros.quote_argument filter</span></a> quotes an argument with or without a value: <code class="docutils literal notranslate"><span class="pre">'comment=this</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">"comment"'</span> <span class="pre">|</span> <span class="pre">community.routeros.quote_argument</span> <span class="pre">==</span> <span class="pre">'comment="this</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">\\"comment\\""'</span></code>.</p></li>
|
<li><p>The <a class="reference internal" href="../quote_argument_filter.html#ansible-collections-community-routeros-quote-argument-filter"><span class="std std-ref">community.routeros.quote_argument filter</span></a> quotes an argument with or without a value: <code class="docutils literal notranslate"><span class="pre">'comment=this</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">"comment"'</span> <span class="pre">|</span> <span class="pre">community.routeros.quote_argument</span> <span class="pre">==</span> <span class="pre">'comment="this</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">\\"comment\\""'</span></code>.</p></li>
|
||||||
<li><p>The <a class="reference internal" href="../join_filter.html#ansible-collections-community-routeros-join-filter"><span class="std std-ref">community.routeros.join filter</span></a> quotes a list of arguments and joins them to one string: <code class="docutils literal notranslate"><span class="pre">['foo=bar',</span> <span class="pre">'comment=foo</span> <span class="pre">is</span> <span class="pre">bar']</span> <span class="pre">|</span> <span class="pre">community.routeros.join</span> <span class="pre">==</span> <span class="pre">'foo=bar</span> <span class="pre">comment="foo</span> <span class="pre">is</span> <span class="pre">bar"'</span></code>.</p></li>
|
<li><p>The <a class="reference internal" href="../join_filter.html#ansible-collections-community-routeros-join-filter"><span class="std std-ref">community.routeros.join filter</span></a> quotes a list of arguments and joins them to one string: <code class="docutils literal notranslate"><span class="pre">['foo=bar',</span> <span class="pre">'comment=foo</span> <span class="pre">is</span> <span class="pre">bar']</span> <span class="pre">|</span> <span class="pre">community.routeros.join</span> <span class="pre">==</span> <span class="pre">'foo=bar</span> <span class="pre">comment="foo</span> <span class="pre">is</span> <span class="pre">bar"'</span></code>.</p></li>
|
||||||
<li><p>The <a class="reference internal" href="../split_filter.html#ansible-collections-community-routeros-split-filter"><span class="std std-ref">community.routeros.split filter</span></a> splits a command into a list of arguments (with or without values): <code class="docutils literal notranslate"><span class="pre">'foo=bar</span> <span class="pre">comment="foo</span> <span class="pre">is</span> <span class="pre">bar"'</span> <span class="pre">|</span> <span class="pre">community.routeros.split</span> <span class="pre">==</span> <span class="pre">['foo=bar',</span> <span class="pre">'comment=foo</span> <span class="pre">is</span> <span class="pre">bar']</span></code></p></li>
|
<li><p>The <a class="reference internal" href="../split_filter.html#ansible-collections-community-routeros-split-filter"><span class="std std-ref">community.routeros.split filter</span></a> splits a command into a list of arguments (with or without values): <code class="docutils literal notranslate"><span class="pre">'foo=bar</span> <span class="pre">comment="foo</span> <span class="pre">is</span> <span class="pre">bar"'</span> <span class="pre">|</span> <span class="pre">community.routeros.split</span> <span class="pre">==</span> <span class="pre">['foo=bar',</span> <span class="pre">'comment=foo</span> <span class="pre">is</span> <span class="pre">bar']</span></code></p></li>
|
||||||
<li><p>The <a class="reference internal" href="../list_to_dict_filter.html#ansible-collections-community-routeros-list-to-dict-filter"><span class="std std-ref">community.routeros.list_to_dict filter</span></a> splits a list of arguments with values into a dictionary: <code class="docutils literal notranslate"><span class="pre">['foo=bar',</span> <span class="pre">'comment=foo</span> <span class="pre">is</span> <span class="pre">bar']</span> <span class="pre">|</span> <span class="pre">community.routeros.list_to_dict</span> <span class="pre">==</span> <span class="pre">{'foo':</span> <span class="pre">'bar',</span> <span class="pre">'comment':</span> <span class="pre">'foo</span> <span class="pre">is</span> <span class="pre">bar'}</span></code>. It has two optional arguments: <code class="docutils literal notranslate"><span class="pre">require_assignment</span></code> (default value <code class="docutils literal notranslate"><span class="pre">true</span></code>) allows to accept arguments without values when set to <code class="docutils literal notranslate"><span class="pre">false</span></code>; and <code class="docutils literal notranslate"><span class="pre">skip_empty_values</span></code> (default value <code class="docutils literal notranslate"><span class="pre">false</span></code>) allows to skip arguments whose value is empty.</p></li>
|
<li><p>The <a class="reference internal" href="../list_to_dict_filter.html#ansible-collections-community-routeros-list-to-dict-filter"><span class="std std-ref">community.routeros.list_to_dict filter</span></a> splits a list of arguments with values into a dictionary: <code class="docutils literal notranslate"><span class="pre">['foo=bar',</span> <span class="pre">'comment=foo</span> <span class="pre">is</span> <span class="pre">bar']</span> <span class="pre">|</span> <span class="pre">community.routeros.list_to_dict</span> <span class="pre">==</span> <span class="pre">{'foo':</span> <span class="pre">'bar',</span> <span class="pre">'comment':</span> <span class="pre">'foo</span> <span class="pre">is</span> <span class="pre">bar'}</span></code>. It has two optional arguments: <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../list_to_dict_filter.html#ansible-collections-community-routeros-list-to-dict-filter-parameter-require-assignment"><span class="std std-ref"><span class="pre">require_assignment</span></span></a></strong></code> (default value <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>) allows to accept arguments without values when set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>; and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../list_to_dict_filter.html#ansible-collections-community-routeros-list-to-dict-filter-parameter-skip-empty-values"><span class="std std-ref"><span class="pre">skip_empty_values</span></span></a></strong></code> (default value <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>) allows to skip arguments whose value is empty.</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
|
@ -151,7 +151,7 @@
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
<li><p>When using the <a class="reference internal" href="../command_module.html#ansible-collections-community-routeros-command-module"><span class="std std-ref">community.routeros.command module</span></a> module, make sure to not specify too long commands. Alternatively, add something like <code class="docutils literal notranslate"><span class="pre">+cet512w</span></code> to the username (replace <code class="docutils literal notranslate"><span class="pre">admin</span></code> with <code class="docutils literal notranslate"><span class="pre">admin+cet512w</span></code>) to tell RouterOS to not wrap before 512 characters in a line (<a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/6">see issue for details</a>).</p></li>
|
<li><p>When using the <a class="reference internal" href="../command_module.html#ansible-collections-community-routeros-command-module"><span class="std std-ref">community.routeros.command module</span></a> module, make sure to not specify too long commands. Alternatively, add something like <code class="docutils literal notranslate"><span class="pre">+cet512w</span></code> to the username (replace <code class="docutils literal notranslate"><span class="pre">admin</span></code> with <code class="docutils literal notranslate"><span class="pre">admin+cet512w</span></code>) to tell RouterOS to not wrap before 512 characters in a line (<a class="reference external" href="https://github.com/ansible-collections/community.routeros/issues/6">see issue for details</a>).</p></li>
|
||||||
<li><p>Finally, the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.netcommon.network_cli connection plugin</span></a> uses <a class="reference external" href="https://pypi.org/project/paramiko/">paramiko</a> by default to connect to devices with SSH. You can set its <code class="docutils literal notranslate"><span class="pre">ssh_type</span></code> option to <code class="docutils literal notranslate"><span class="pre">libssh</span></code> to use <a class="reference external" href="https://pypi.org/project/ansible-pylibssh/">ansible-pylibssh</a> instead, which offers Python bindings to libssh. See its documentation for details.</p></li>
|
<li><p>Finally, the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/netcommon/network_cli_connection.html#ansible-collections-ansible-netcommon-network-cli-connection" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.netcommon.network_cli connection plugin</span></a> uses <a class="reference external" href="https://pypi.org/project/paramiko/">paramiko</a> by default to connect to devices with SSH. You can set its <code class="ansible-option docutils literal notranslate"><strong><code class="docutils literal notranslate"><span class="pre">ssh_type`</span></code></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">libssh</span></code> to use <a class="reference external" href="https://pypi.org/project/ansible-pylibssh/">ansible-pylibssh</a> instead, which offers Python bindings to libssh. See its documentation for details.</p></li>
|
||||||
</ol>
|
</ol>
|
||||||
</section>
|
</section>
|
||||||
<section id="setting-up-an-inventory">
|
<section id="setting-up-an-inventory">
|
||||||
|
|
|
@ -176,8 +176,8 @@
|
||||||
<div class="ansibleOptionAnchor" id="parameter-gather_subset"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-facts-module-parameter-gather-subset"><strong>gather_subset</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-gather_subset"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-facts-module-parameter-gather-subset"><strong>gather_subset</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-gather_subset" 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></p>
|
<a class="ansibleOptionLink" href="#parameter-gather_subset" 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></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include <code class="docutils literal notranslate"><span class="pre">all</span></code>, <code class="docutils literal notranslate"><span class="pre">hardware</span></code>, <code class="docutils literal notranslate"><span class="pre">config</span></code>, <code class="docutils literal notranslate"><span class="pre">interfaces</span></code>, and <code class="docutils literal notranslate"><span class="pre">routing</span></code>.</p>
|
<td><div class="ansible-option-cell"><p>When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include <code class="ansible-value docutils literal notranslate"><span class="pre">all</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">config</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code>.</p>
|
||||||
<p>Can specify a list of values to include a larger subset. Values can also be used with an initial <code class="docutils literal notranslate"><span class="pre">!</span></code> to specify that a specific subset should not be collected.</p>
|
<p>Can specify a list of values to include a larger subset. Values can also be used with an initial <code class="ansible-value docutils literal notranslate"><span class="pre">!</span></code> to specify that a specific subset should not be collected.</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">["!config"]</span></code></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">["!config"]</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -274,7 +274,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_all_ipv4_addresses" 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-ansible_facts/ansible_net_all_ipv4_addresses" 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 IPv4 addresses configured on the device.</p>
|
<td><div class="ansible-option-cell"><p>All IPv4 addresses configured on the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -282,7 +282,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_all_ipv6_addresses" 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-ansible_facts/ansible_net_all_ipv6_addresses" 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 IPv6 addresses configured on the device.</p>
|
<td><div class="ansible-option-cell"><p>All IPv6 addresses configured on the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -290,7 +290,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_arch" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_arch" title="Permalink to this return value"></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>The CPU architecture of the device.</p>
|
<td><div class="ansible-option-cell"><p>The CPU architecture of the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -298,7 +298,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with BGP instance information.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with BGP instance information.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -306,7 +306,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_peer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_peer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with BGP peer information.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with BGP peer information.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -314,7 +314,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_vpnv4_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_bgp_vpnv4_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with BGP vpnv4 route information.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with BGP vpnv4 route information.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -322,7 +322,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_config" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_config" title="Permalink to this return value"></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>The current active config from the device.</p>
|
<td><div class="ansible-option-cell"><p>The current active config from the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">config</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">config</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -332,7 +332,7 @@
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>The current active config from the device in minimal form.</p>
|
<td><div class="ansible-option-cell"><p>The current active config from the device in minimal form.</p>
|
||||||
<p>This value is idempotent in the sense that if the facts module is run twice and the device’s config was not changed between the runs, the value is identical. This is achieved by running <code class="docutils literal notranslate"><span class="pre">/export</span></code> and stripping the timestamp from the comment in the first line.</p>
|
<p>This value is idempotent in the sense that if the facts module is run twice and the device’s config was not changed between the runs, the value is identical. This is achieved by running <code class="docutils literal notranslate"><span class="pre">/export</span></code> and stripping the timestamp from the comment in the first line.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">config</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">config</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -340,7 +340,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_cpu_load" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_cpu_load" title="Permalink to this return value"></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>Current CPU load.</p>
|
<td><div class="ansible-option-cell"><p>Current CPU load.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -356,7 +356,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_hostname" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_hostname" title="Permalink to this return value"></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>The configured hostname of the device.</p>
|
<td><div class="ansible-option-cell"><p>The configured hostname of the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -364,7 +364,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_interfaces" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_interfaces" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A hash of all interfaces running on the system.</p>
|
<td><div class="ansible-option-cell"><p>A hash of all interfaces running on the system.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -372,7 +372,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memfree_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memfree_mb" title="Permalink to this return value"></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>The available free memory on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The available free memory on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -380,7 +380,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memtotal_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_memtotal_mb" title="Permalink to this return value"></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>The total memory on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The total memory on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -388,7 +388,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_model" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_model" title="Permalink to this return value"></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>The model name returned from the device.</p>
|
<td><div class="ansible-option-cell"><p>The model name returned from the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -396,7 +396,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_neighbors" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_neighbors" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>The list of neighbors from the remote device.</p>
|
<td><div class="ansible-option-cell"><p>The list of neighbors from the remote device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">interfaces</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -404,7 +404,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_instance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with OSPF instances.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with OSPF instances.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -412,7 +412,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_neighbor" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_ospf_neighbor" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary with OSPF neighbors.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary with OSPF neighbors.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -420,7 +420,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_route" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A dictionary for routes in all routing tables.</p>
|
<td><div class="ansible-option-cell"><p>A dictionary for routes in all routing tables.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">routing</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">routing</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -428,7 +428,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_serialnum" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_serialnum" title="Permalink to this return value"></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>The serial number of the remote device.</p>
|
<td><div class="ansible-option-cell"><p>The serial number of the remote device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -436,7 +436,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacefree_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacefree_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>The available disk space on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The available disk space on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -444,7 +444,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacetotal_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_spacetotal_mb" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>The total disk space on the remote device in MiB.</p>
|
<td><div class="ansible-option-cell"><p>The total disk space on the remote device in MiB.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">hardware</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
@ -452,7 +452,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_uptime" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_uptime" title="Permalink to this return value"></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>The uptime of the device.</p>
|
<td><div class="ansible-option-cell"><p>The uptime of the device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
@ -460,7 +460,7 @@
|
||||||
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_version" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
<a class="ansibleOptionLink" href="#return-ansible_facts/ansible_net_version" title="Permalink to this return value"></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>The operating system version running on the remote device.</p>
|
<td><div class="ansible-option-cell"><p>The operating system version running on the remote device.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>gather_subset</em> contains <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-routeros-facts-module-parameter-gather-subset"><span class="std std-ref"><span class="pre">gather_subset</span></span></a></strong></code> contains <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
@ -176,7 +176,7 @@
|
||||||
<div class="ansibleOptionAnchor" id="parameter-_input"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-list-to-dict-filter-parameter-input"><strong>Input</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-_input"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-list-to-dict-filter-parameter-input"><strong>Input</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-_input" 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>
|
<a class="ansibleOptionLink" href="#parameter-_input" 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>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>A list of assignments. Can be the result of the <code class="docutils literal notranslate"><span class="pre">community.routeros.split</span></code> filter.</p>
|
<td><div class="ansible-option-cell"><p>A list of assignments. Can be the result of the <a class="reference internal" href="split_filter.html#ansible-collections-community-routeros-split-filter"><span class="std std-ref">community.routeros.split</span></a> filter.</p>
|
||||||
</div></td>
|
</div></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -197,7 +197,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||||
<div class="ansibleOptionAnchor" id="parameter-require_assignment"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-list-to-dict-filter-parameter-require-assignment"><strong>require_assignment</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-require_assignment"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-list-to-dict-filter-parameter-require-assignment"><strong>require_assignment</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-require_assignment" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
<a class="ansibleOptionLink" href="#parameter-require_assignment" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Allows to accept arguments without values when set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
<td><div class="ansible-option-cell"><p>Allows to accept arguments without values when set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||||
|
@ -209,7 +209,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||||
<div class="ansibleOptionAnchor" id="parameter-skip_empty_values"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-list-to-dict-filter-parameter-skip-empty-values"><strong>skip_empty_values</strong></p>
|
<div class="ansibleOptionAnchor" id="parameter-skip_empty_values"></div><p class="ansible-option-title" id="ansible-collections-community-routeros-list-to-dict-filter-parameter-skip-empty-values"><strong>skip_empty_values</strong></p>
|
||||||
<a class="ansibleOptionLink" href="#parameter-skip_empty_values" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
<a class="ansibleOptionLink" href="#parameter-skip_empty_values" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
</div></td>
|
</div></td>
|
||||||
<td><div class="ansible-option-cell"><p>Allows to skip arguments whose value is empty when set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
<td><div class="ansible-option-cell"><p>Allows to skip arguments whose value is empty when set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
<ul class="simple">
|
<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>
|
<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>
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue