vyos.vyos.vyos_ntp_global module – NTP global resource module
Note
This module is part of the vyos.vyos collection (version 6.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install vyos.vyos.
To use it in a playbook, specify: vyos.vyos.vyos_ntp_global.
New in vyos.vyos 1.0.0
Synopsis
This module manages ntp configuration on devices running Vyos
Parameters
Parameter |
Comments |
|---|---|
List of configurations for ntp module |
|
Network Time Protocol (NTP) server options |
|
local IP addresses for service to listen on |
|
Network Time Protocol (NTP) server |
|
server options for NTP `pool` replaces `dynamic` in Vyos 1.3 `preempt` is only available in Vyos 1.3 and earlier `nts` was added in Vyos 1.4 `ptp` and `interleave` were added in Vyos 1.5 Choices:
|
|
server name or address for NTP |
|
This option is used only with state parsed. The value of this option should be the output received from the VYOS device by executing the command show configuration commands | grep ntp. The states replaced and overridden have identical behaviour for this module. The state parsed reads the configuration from |
|
The state the configuration should be left in. Choices:
|
Notes
Note
Tested against VyOS 1.3.8, 1.4.2, the upcoming 1.5, and the rolling release of spring 2025
This module works with connection
network_cli.VyOS v.1.4+ uses chronyd, and path changes from `system` to `service`
Examples
# # -------------------
# # 1. Using merged
# # -------------------
# # Before state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# # Task
# # -------------
- name: Replace the existing ntp config with the new config
vyos.vyos.vyos_ntp_global:
config:
allow_clients:
- 10.6.6.0/24
listen_addresses:
- 10.1.3.1
servers:
- server: 203.0.113.0
options:
- prefer
# Task output:
# -------------
# "after": {
# "allow_clients": [
# "10.6.6.0/24"
# ],
# "listen_addresses": [
# "10.1.3.1"
# ],
# "servers": [
# {
# "server": "ser",
# "options": [
# "prefer"
# ]
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# },
# "before": {
# },
# "changed": true,
# "commands": [
# "set service ntp allow-clients address 10.6.6.0/24",
# "set service ntp listen-address 10.1.3.1",
# "set service ntp server 203.0.113.0 prefer"
# ]
# After state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.6.6.0/24'
# set service ntp listen-address '10.1.3.1'
# set service ntp server 203.0.113.0 prefer,
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# # -------------------
# # 2. Using replaced
# # -------------------
# # Before state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.4.9.0/24'
# set service ntp allow-clients address '10.4.7.0/24'
# set service ntp allow-clients address '10.1.2.0/24'
# set service ntp allow-clients address '10.2.3.0/24'
# set service ntp listen-address '10.1.9.16'
# set service ntp listen-address '10.5.3.2'
# set service ntp listen-address '10.7.9.21'
# set service ntp listen-address '10.8.9.4'
# set service ntp listen-address '10.4.5.1'
# set service ntp server 10.3.6.5 noselect
# set service ntp server 10.3.6.5 dynamic
# set service ntp server 10.3.6.5 preempt
# set service ntp server 10.3.6.5 prefer
# set service ntp server server4 noselect
# set service ntp server server4 dynamic
# set service ntp server server5
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# # Task
# # -------------
- name: Replace the existing ntp config with the new config
vyos.vyos.vyos_ntp_global:
config:
allow_clients:
- 10.6.6.0/24
listen_addresses:
- 10.1.3.1
servers:
- server: 203.0.113.0
options:
- prefer
state: replaced
# # Task output:
# # -------------
# "after": {
# "allow_clients": [
# "10.6.6.0/24"
# ],
# "listen_addresses": [
# "10.1.3.1"
# ],
# "servers": [
# {
# "server": "ser",
# "options": [
# "prefer"
# ]
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# },
# "before": {
# "allow_clients": [
# "10.4.7.0/24",
# "10.2.3.0/24",
# "10.1.2.0/24",
# "10.4.9.0/24"
# ],
# "listen_addresses": [
# "10.7.9.21",
# "10.4.5.1",
# "10.5.3.2",
# "10.8.9.4",
# "10.1.9.16"
# ],
# "servers": [
# {
# "server": "10.3.6.5",
# "options": [
# "noselect",
# "dynamic",
# "preempt",
# "prefer"
# ]
# },
# {
# "server": "server4",
# "options": [
# "noselect",
# "dynamic"
# ]
# },
# {
# "server": "server5"
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# },
# "changed": true,
# "commands": [
# "delete service ntp allow-clients address 10.4.7.0/24",
# "delete service ntp allow-clients address 10.2.3.0/24",
# "delete service ntp allow-clients address 10.1.2.0/24",
# "delete service ntp allow-clients address 10.4.9.0/24",
# "delete service ntp listen-address 10.7.9.21",
# "delete service ntp listen-address 10.4.5.1",
# "delete service ntp listen-address 10.5.3.2",
# "delete service ntp listen-address 10.8.9.4",
# "delete service ntp listen-address 10.1.9.16",
# "delete service ntp server 10.3.6.5",
# "delete service ntp server server4",
# "delete service ntp server server5",
# "set service ntp allow-clients address 10.6.6.0/24",
# "set service ntp listen-address 10.1.3.1",
# "set service ntp server 203.0.113.0 prefer"
# ]
# After state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.6.6.0/24'
# set service ntp listen-address '10.1.3.1'
# set service ntp server 203.0.113.0 prefer,
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# # -------------------
# # 3. Using overridden
# # -------------------
# # Before state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.6.6.0/24'
# set service ntp listen-address '10.1.3.1'
# set service ntp server 203.0.113.0 prefer,
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# Task
# -------------
- name: Override ntp config
vyos.vyos.vyos_ntp_global:
config:
allow_clients:
- 10.3.3.0/24
listen_addresses:
- 10.7.8.1
servers:
- server: server1
options:
- dynamic
- prefer
- server: server2
options:
- noselect
- preempt
- server: serv
state: overridden
# # Task output:
# # -------------
# "after": {
# "allow_clients": [
# "10.3.3.0/24"
# ],
# "listen_addresses": [
# "10.7.8.1"
# ],
# "servers": [
# {
# "server": "serv"
# },
# {
# "server": "server1",
# "options": [
# "dynamic",
# "prefer"
# ]
# },
# {
# "server": "server2",
# "options": [
# "noselect",
# "preempt"
# ]
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# },
# "before": {
# "allow_clients": [
# "10.6.6.0/24"
# ],
# "listen_addresses": [
# "10.1.3.1"
# ],
# "servers": [
# {
# "server": "ser",
# "options": [
# "prefer"
# ]
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# },
# "changed": true,
# "commands": [
# "delete service ntp allow-clients address 10.6.6.0/24",
# "delete service ntp listen-address 10.1.3.1",
# "delete service ntp server ser",
# "set service ntp allow-clients address 10.3.3.0/24",
# "set service ntp listen-address 10.7.8.1",
# "set service ntp server server1 dynamic",
# "set service ntp server server1 prefer",
# "set service ntp server server2 noselect",
# "set service ntp server server2 preempt",
# "set service ntp server serv"
# ]
# After state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.3.3.0/24'
# set service ntp listen-address '10.7.8.1'
# set service ntp server serv
# set service ntp server server1 dynamic
# set service ntp server server1 prefer
# set service ntp server server2 noselect
# set service ntp server server2 preempt
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# 4. Using gathered
# -------------------
# # Before state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.3.3.0/24'
# set service ntp listen-address '10.7.8.1'
# set service ntp server serv
# set service ntp server server1 dynamic
# set service ntp server server1 prefer
# set service ntp server server2 noselect
# set service ntp server server2 preempt
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# Task
# -------------
- name: Gather ntp config
vyos.vyos.vyos_ntp_global:
state: gathered
# # Task output:
# # -------------
# "gathered": {
# "allow_clients": [
# "10.3.3.0/24"
# ],
# "listen_addresses": [
# "10.7.8.1"
# ],
# "servers": [
# {
# "server": "serv"
# },
# {
# "server": "server1",
# "options": [
# "dynamic",
# "prefer"
# ]
# },
# {
# "server": "server2",
# "options": [
# "noselect",
# "preempt"
# ]
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# }
# After state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.3.3.0/24'
# set service ntp listen-address '10.7.8.1'
# set service ntp server serv
# set service ntp server server1 dynamic
# set service ntp server server1 prefer
# set service ntp server server2 noselect
# set service ntp server server2 preempt
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# # -------------------
# # 5. Using deleted
# # -------------------
# # Before state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp allow-clients address '10.3.3.0/24'
# set service ntp listen-address '10.7.8.1'
# set service ntp server serv
# set service ntp server server1 dynamic
# set service ntp server server1 prefer
# set service ntp server server2 noselect
# set service ntp server server2 preempt
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# # Task
# # -------------
- name: Delete ntp config
vyos.vyos.vyos_ntp_global:
state: deleted
# # Task output:
# # -------------
# "after": {
# "servers": [
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# },
# "before": {
# "allow_clients": [
# "10.3.3.0/24"
# ],
# "listen_addresses": [
# "10.7.8.1"
# ],
# "servers": [
# {
# "server": "serv"
# },
# {
# "server": "server1",
# "options": [
# "dynamic",
# "prefer"
# ]
# },
# {
# "server": "server2",
# "options": [
# "noselect",
# "preempt"
# ]
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
# ]
# },
# "changed": true,
# "commands": [
# "delete service ntp allow-clients",
# "delete service ntp listen-address",
# "delete service ntp server serv",
# "delete service ntp server server1",
# "delete service ntp server server2"
#
# ]
# After state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# # -------------------
# # 6. Using rendered
# # -------------------
# # Before state:
# # -------------
# vyos@vyos:~$ show configuration commands | grep ntp
# set service ntp server time1.vyos.net
# set service ntp server time2.vyos.net
# set service ntp server time3.vyos.net
# vyos@vyos:~$
# Task
# -------------
- name: Render ntp config
vyos.vyos.vyos_ntp_global:
config:
allow_clients:
- 10.7.7.0/24
- 10.8.8.0/24
listen_addresses:
- 10.7.9.1
servers:
- server: server7
- server: server45
options:
- noselect
- prefer
- pool
- server: time1.vyos.net
- server: time2.vyos.net
- server: time3.vyos.net
state: rendered
# # Task output:
# # -------------
# "rendered": [
# "set service ntp allow-clients address 10.7.7.0/24",
# "set service ntp allow-clients address 10.8.8.0/24",
# "set service ntp listen-address 10.7.9.1",
# "set service ntp server server7",
# "set service ntp server server45 noselect",
# "set service ntp server server45 prefer",
# "set service ntp server server45 pool",
# "set service ntp server time1.vyos.net",
# "set service ntp server time2.vyos.net",
# "set service ntp server time3.vyos.net"
# ]
# # -------------------
# # 7. Using parsed
# # -------------------
# # sample_config.cfg:
# # -------------
# "set service ntp allow-clients address 10.7.7.0/24",
# "set service ntp listen-address 10.7.9.1",
# "set service ntp server server45 noselect",
# "set service ntp allow-clients addres 10.8.6.0/24",
# "set service ntp listen-address 10.5.4.1",
# "set service ntp server server45 dynamic",
# "set service ntp server time1.vyos.net",
# "set service ntp server time2.vyos.net",
# "set service ntp server time3.vyos.net"
# Task:
# -------------
- name: Parse externally provided ntp configuration
vyos.vyos.vyos_ntp_global:
running_config: "{{ lookup('file', './sample_config.cfg') }}"
state: parsed
# # Task output:
# # -------------
# parsed = {
# "allow_clients": [
# "10.7.7.0/24",
# "10.8.6.0/24
# ],
# "listen_addresses": [
# "10.5.4.1",
# "10.7.9.1"
# ],
# "servers": [
# {
# "server": "server45",
# "options": [
# "noselect",
# "dynamic"
#
# ]
# },
# {
# "server": "time1.vyos.net"
# },
# {
# "server": "time2.vyos.net"
# },
# {
# "server": "time3.vyos.net"
# }
#
# ]
# }
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration after module execution. Returned: when changed Sample: |
|
The configuration prior to the module execution. Returned: when state is Sample: |
|
The set of commands pushed to the remote device. Returned: when state is Sample: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is Sample: |