summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoromnom62 <75066712+omnom62@users.noreply.github.com>2026-09-26 01:42:14 +1000
committerGitHub <noreply@github.com>2026-09-25 16:42:14 +0100
commit9fe93349225eb9b014e7a3e397da88fece40a0b2 (patch)
tree8869b2586ad5227b164b94be015efe15fc489ed1 /docs
parent8fcff7e2591690d14ae82bcfb430ee3755aec73c (diff)
downloadrest.vyos-9fe93349225eb9b014e7a3e397da88fece40a0b2.tar.gz
rest.vyos-9fe93349225eb9b014e7a3e397da88fece40a0b2.zip
T8989: vyos_static_routes dict_op refactor (#25)
* T8989: vyos_static_routes dict_op refactor * T8989: Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/vyos.rest.vyos_static_routes_module.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/vyos.rest.vyos_static_routes_module.rst b/docs/vyos.rest.vyos_static_routes_module.rst
index 353cf2d..78fbde9 100644
--- a/docs/vyos.rest.vyos_static_routes_module.rst
+++ b/docs/vyos.rest.vyos_static_routes_module.rst
@@ -193,11 +193,12 @@ Parameters
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
- <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
+ <li>yes</li>
</ul>
</td>
<td>
<div>Whether this next-hop is enabled.</div>
+ <div>Deliberately has no default: leaving it unset means &quot;no opinion&quot; and an existing device-side disabled state is left alone under <code>merged</code>. Explicitly setting <code>true</code> actively clears a previously disabled next-hop, which <code>merged</code> could otherwise never do (only <code>replaced</code>/<code>overridden</code> run a purge pass capable of noticing an omitted value).</div>
</td>
</tr>
<tr>
@@ -261,7 +262,7 @@ Parameters
<td>
<div><code>merged</code> - Add routes without removing existing ones.</div>
<div><code>replaced</code> - Replace each named route (by afi + dest) exactly as specified.</div>
- <div><code>overridden</code> - Replace the entire static route table.</div>
+ <div><code>overridden</code> - Replace the module-known parts of the static route table (see module scope note above; unmodeled attributes on unmodeled routes are not touched).</div>
<div><code>deleted</code> - Remove listed or all static routes.</div>
<div><code>gathered</code> - Read static routes from device without changes.</div>
</td>