Skip to content

Commit 6c4c9ad

Browse files
authored
[doc] Update CONFIG_DB manual to include NTP global settings (#1741)
Updated the Configuration Database documentation to include settings supported by the NTP daemon to globally configure its source port, which controls the port from which NTP requests are made (needs to be overridden in some cases) and also controls whether it runs within the mgmt vrf (which also needs to be set in some common configurations)
1 parent dad1287 commit 6c4c9ad

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

doc/Configuration.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Table of Contents
3030
* [Management port](#management-port)
3131
* [Management VRF](#management-vrf)
3232
* [MAP_PFC_PRIORITY_TO_QUEUE](#map_pfc_priority_to_queue)
33+
* [NTP Global Configuration](#ntp-global-configuration)
3334
* [NTP and SYSLOG servers](#ntp-and-syslog-servers)
3435
* [Port](#port)
3536
* [Port Channel](#port-channel)
@@ -915,7 +916,48 @@ instead of data network.
915916
}
916917
}
917918
```
919+
### NTP Global Configuration
918920

921+
These configuration options are used to modify the way that
922+
ntp binds to the ports on the switch and which port it uses to
923+
make ntp update requests from.
924+
925+
***NTP VRF***
926+
927+
If this option is set to `default` then ntp will run within the default vrf
928+
**when the management vrf is enabled**. If the mgmt vrf is enabled and this value is
929+
not set to default then ntp will run within the mgmt vrf.
930+
931+
This option **has no effect** if the mgmt vrf is not enabled.
932+
933+
```
934+
{
935+
"NTP": {
936+
"global": {
937+
"vrf": "default"
938+
}
939+
}
940+
}
941+
```
942+
943+
944+
***NTP Source Port***
945+
946+
This option sets the port which ntp will choose to send time update requests from by.
947+
948+
NOTE: If a Loopback interface is defined on the switch ntp will choose this by default, so this setting
949+
is **required** if the switch has a Loopback interface and the ntp peer does not have defined routes
950+
for that address.
951+
952+
```
953+
{
954+
"NTP": {
955+
"global": {
956+
"src_intf": "Ethernet1"
957+
}
958+
}
959+
}
960+
```
919961

920962
### NTP and SYSLOG servers
921963

0 commit comments

Comments
 (0)