diff options
| author | Ruben Herold <ruben@puettmann.net> | 2026-08-14 15:11:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-08-14 14:11:24 +0100 |
| commit | ef9f42a79eba0e4612fb7883839764cee1df57a8 (patch) | |
| tree | bddeba4e976684471c5b9900915f1c709034deaf | |
| parent | f07f919d34a28a25fcc24fc433f00ff586c62f2b (diff) | |
| download | vyos-documentation-ef9f42a79eba0e4612fb7883839764cee1df57a8.tar.gz vyos-documentation-ef9f42a79eba0e4612fb7883839764cee1df57a8.zip | |
docs: T9159: document service ntp source-address option (#2185)
* docs: T9159: document service ntp source-address option
Companion doc entry for the vyos-1x change adding
"set service ntp source-address <address>" (chrony's bindacqaddress).
* docs: T9159: document service ntp source-interface option
Companion doc entry for the vyos-1x change adding
"set service ntp source-interface <interface>" (chrony's
bindacqdevice), addressing multi-VRF feedback on T9159.
* docs: T9159: clarify source-interface is scoped to a single VRF
The source-interface description implied it helps disambiguate
across multiple VRFs at once, but service ntp vrf already binds the
whole NTP client to a single VRF - source-interface only picks the
egress device within that one VRF.
Flagged by CodeRabbit review on PR #2185.
| -rw-r--r-- | docs/configuration/service/ntp.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/configuration/service/ntp.md b/docs/configuration/service/ntp.md index c8c1dee3..baa2f097 100644 --- a/docs/configuration/service/ntp.md +++ b/docs/configuration/service/ntp.md @@ -92,6 +92,31 @@ Multiple networks/client IP addresses can be configured. ``` +```{cfgcmd} set service ntp source-address \<address\> + +Source IP address used for outgoing NTP client requests to the configured +servers, instead of relying on the kernel's default source-address selection +for whichever route is chosen at query time. Useful on routers with more +than one usable egress path to a given server, where the interface that +ends up being selected may not always carry a globally reachable address. +Only one IPv4 and one IPv6 address can be configured, using separate +commands for each. +``` + + +```{cfgcmd} set service ntp source-interface \<interface\> + +Network device used for outgoing NTP client requests, binding the socket to +this interface (Linux `SO_BINDTODEVICE`) rather than to a source address. +Useful when a source address alone cannot unambiguously select the egress +path, for example when address ranges overlap between routing instances. +Since `vrf` binds the NTP client to a single VRF, `source-interface` only +selects the egress device within that VRF, not across multiple VRFs at +once. Can be combined with `source-address`; only one interface can be +configured. If `vrf` is also set, the interface must belong to that VRF. +``` + + ```{cfgcmd} set service ntp vrf \<name\> Specify name of the {abbr}`VRF (Virtual Routing and Forwarding)` instance. |