summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoromnom62 <75066712+omnom62@users.noreply.github.com>2026-08-04 19:46:02 +1000
committerGitHub <noreply@github.com>2026-08-04 10:46:02 +0100
commitfa0e13e1a28d2a1f1653db6767e74bc37acc4a28 (patch)
tree91c62f42efe2c8b1731a48683397c3322f53eef7 /docs
parentdec3537721776b7caca47fed5d7e335e3e6d80d6 (diff)
downloadvyos.vyos-fa0e13e1a28d2a1f1653db6767e74bc37acc4a28.tar.gz
vyos.vyos-fa0e13e1a28d2a1f1653db6767e74bc37acc4a28.zip
T6890: use boolean in documentation (#491)
* T6890: use boolean in documentation * T6890: use booleans in documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/vyos.vyos.vyos_bgp_global_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_config_module.rst25
2 files changed, 24 insertions, 3 deletions
diff --git a/docs/vyos.vyos.vyos_bgp_global_module.rst b/docs/vyos.vyos.vyos_bgp_global_module.rst
index ecf44968..e83a147d 100644
--- a/docs/vyos.vyos.vyos_bgp_global_module.rst
+++ b/docs/vyos.vyos.vyos_bgp_global_module.rst
@@ -888,7 +888,7 @@ Parameters
<td>
</td>
<td>
- <div>Allow this EBGP neighbor to not be on a directly connected network. Specify the number hops.</div>
+ <div>Allow this EBGP neighbor to not be on a directly connected network. Specify the number of hops.</div>
</td>
</tr>
<tr>
diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst
index e2be25b9..bf91bb0f 100644
--- a/docs/vyos.vyos.vyos_config_module.rst
+++ b/docs/vyos.vyos.vyos_config_module.rst
@@ -36,6 +36,27 @@ Parameters
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>allow_password_change</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>all</li>
+ <li><div style="color: blue"><b>plaintext</b>&nbsp;&larr;</div></li>
+ <li>encrypted</li>
+ <li>none</li>
+ </ul>
+ </td>
+ <td>
+ <div>The <code>allow_password_change</code> argument specifies whether any configuration lines which would change a user&#x27;s password should be filtered out. By default only plaintext password changes are allowed and any encrypted-password keys are filtered out. In order to allow all password updates, both plaintext and encrypted, set this argument to <code>all</code>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
<b>backup</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
@@ -64,7 +85,7 @@ Parameters
<td>
</td>
<td>
- <div>This is a dict object containing configurable options related to backup file path. The value of this option is read only when <code>backup</code> is set to <em>yes</em>, if <code>backup</code> is set to <em>no</em> this option will be silently ignored.</div>
+ <div>This is a dict object containing configurable options related to backup file path. The value of this option is read only when <code>backup</code> is set to <code>true</code>, if <code>backup</code> is set to <code>false</code> this option will be silently ignored.</div>
</td>
</tr>
<tr>
@@ -218,7 +239,7 @@ Parameters
</ul>
</td>
<td>
- <div>The <code>save</code> argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to True, the active configuration is saved.</div>
+ <div>The <code>save</code> argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to <code>true</code>, the active configuration is saved.</div>
</td>
</tr>
<tr>