.. _arista.eos.eos_ntp_global_module: ************************* arista.eos.eos_ntp_global ************************* **Manages ntp resource module** Version added: 3.1.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module configures and manages the attributes of ntp on Arista EOS platforms. Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
config
dictionary
A dictionary of ntp options
authenticate
dictionary
Require authentication for NTP synchronization.
enable
boolean
    Choices:
  • no
  • yes
Enable authentication for NTP synchronization.
servers
boolean
    Choices:
  • no
  • yes
Authentication required only for incoming NTP server responses.
authentication_keys
list / elements=dictionary
Define a key to use for authentication.
algorithm
string
    Choices:
  • md5
  • sha1
hash algorithm,
encryption
integer
    Choices:
  • 0
  • 7
key type
id
integer
key identifier.
key
string
Unobfuscated key string.
local_interface
string
Configure the interface from which the IP source address is taken.
qos_dscp
integer
Set DSCP value in IP header
serve
dictionary
Configure the switch as an NTP server.
access_lists
list / elements=dictionary
Configure access control list.
acls
list / elements=dictionary
Access lists to be configured under the afi
acl_name
string
Name of the access list.
direction
string
    Choices:
  • in
  • out
direction for the packets.
vrf
string
VRF in which to apply the access control list.
afi
string
ip/ipv6 config commands.
all
boolean
    Choices:
  • no
  • yes
Service NTP requests received on any interface.
servers
list / elements=dictionary
Configure NTP server to synchronize to.
burst
boolean
    Choices:
  • no
  • yes
Send a burst of packets instead of the usual one.
iburst
boolean
    Choices:
  • no
  • yes
Send bursts of packets until the server is reached
key_id
integer
Set a key to use for authentication.
local_interface
string
Configure the interface from which the IP source address is taken.
maxpoll
integer
Maximum poll interval.
minpoll
integer
Minimum poll interval.
prefer
boolean
    Choices:
  • no
  • yes
Mark this server as preferred.
server
string / required
Hostname or A.B.C.D or A:B:C:D:E:F:G:H.
source
string
Configure the interface from which the IP source address is taken.
version
integer
NTP version.
vrf
string
vrf name.
trusted_key
string
Configure the set of keys that are accepted for incoming messages
running_config
string
This option is used only with state parsed.
The value of this option should be the output received from the EOS device by executing the command show running-config | section ntp.
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
state
string
    Choices:
  • deleted
  • merged ←
  • overridden
  • replaced
  • gathered
  • rendered
  • parsed
The state the configuration should be left in.
The states replaced and overridden have identical behaviour for this module.
Please refer to examples for more details.

Notes ----- .. note:: - Tested against Arista EOS 4.24.60M - This module works with connection ``network_cli``. See the https://docs.ansible.com/ansible/latest/network/user_guide/platform_eos.html. Examples -------- .. code-block:: yaml # Using merged # Before state: # ------------- # localhost(config)#show running-config | section ntp # localhost(config)# - name: Merge provided configuration with device configuration arista.eos.eos_ntp_global: config: authenticate: enable: true authentication_keys: - id: 2 algorithm: "sha1" encryption: 7 key: "123456" - id: 23 algorithm: "md5" encryption: 7 key: "123456" local_interface: "Ethernet1" qos_dscp: 10 trusted_key: 23 servers: - server: "10.1.1.1" vrf: "vrf01" burst: true prefer: true - server: "25.1.1.1" vrf: "vrf01" maxpoll: 15 key_id: 2 serve: access_lists: - afi: "ip" acls: - acl_name: "acl01" direction: "in" - afi: "ipv6" acls: - acl_name: "acl02" direction: "in" # After State # localhost(config)#show running-config | section ntp # ntp authentication-key 2 sha1 7 123456 # ntp authentication-key 23 md5 7 123456 # ntp trusted-key 23 # ntp authenticate # ntp local-interface Ethernet1 # ntp qos dscp 10 # ntp server vrf vrf01 10.1.1.1 prefer burst # ntp server vrf vrf01 25.1.1.1 maxpoll 15 key 2 # ntp serve ip access-group acl01 in # ntp serve ipv6 access-group acl02 in # localhost(config)# # # # Module Execution: # "after": { # "authenticate": { # "enable": true # }, # "authentication_keys": [ # { # "algorithm": "sha1", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # }, # { # "algorithm": "md5", # "encryption": 7, # "id": 23, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "local_interface": "Ethernet1", # "qos_dscp": 10, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl01", # "direction": "in" # } # ], # "afi": "ip" # }, # { # "acls": [ # { # "acl_name": "acl02", # "direction": "in" # } # ], # "afi": "ipv6" # } # ] # }, # "servers": [ # { # "burst": true, # "prefer": true, # "server": "10.1.1.1", # "vrf": "vrf01" # }, # { # "key_id": 2, # "maxpoll": 15, # "server": "25.1.1.1", # "vrf": "vrf01" # } # ], # "trusted_key": "23" # }, # "before": {}, # "changed": true, # "commands": [ # "ntp serve ip access-group acl01 in", # "ntp serve ipv6 access-group acl02 in", # "ntp authentication-key 2 sha1 7 ********", # "ntp authentication-key 23 md5 7 ********", # "ntp server vrf vrf01 10.1.1.1 burst prefer", # "ntp server vrf vrf01 25.1.1.1 key 2 maxpoll 15", # "ntp authenticate", # "ntp local-interface Ethernet1", # "ntp qos dscp 10", # "ntp trusted-key 23" # ], # Using Replaced # Before State # localhost(config)#show running-config | section ntp # ntp authentication-key 2 sha1 7 123456 # ntp authentication-key 23 md5 7 123456 # ntp trusted-key 23 # ntp authenticate # ntp local-interface Ethernet1 # ntp qos dscp 10 # ntp server vrf vrf01 10.1.1.1 prefer burst # ntp server vrf vrf01 25.1.1.1 maxpoll 15 key 2 # ntp serve ip access-group acl01 in # ntp serve ipv6 access-group acl02 in # localhost(config)# - name: Replace arista.eos.eos_ntp_global: config: qos_dscp: 15 authentication_keys: - id: 2 algorithm: "md5" encryption: 7 key: "123456" servers: - server: "11.21.1.1" vrf: "vrf01" burst: true prefer: true minpoll: 13 serve: access_lists: - afi: "ip" acls: - acl_name: "acl03" direction: "in" state: replaced # After State: # localhost(config)#show running-config | section ntp # ntp authentication-key 2 md5 7 123456 # ntp qos dscp 15 # ntp server vrf vrf01 11.21.1.1 prefer burst minpoll 13 # ntp serve ip access-group acl03 in # localhost(config)# # # # Module Execution: # "after": { # "authentication_keys": [ # { # "algorithm": "md5", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "qos_dscp": 15, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl03", # "direction": "in" # } # ], # "afi": "ip" # } # ] # }, # "servers": [ # { # "burst": true, # "minpoll": 13, # "prefer": true, # "server": "11.21.1.1", # "vrf": "vrf01" # } # ] # }, # "before": { # "authenticate": { # "enable": true # }, # "authentication_keys": [ # { # "algorithm": "sha1", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # }, # { # "algorithm": "md5", # "encryption": 7, # "id": 23, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "local_interface": "Ethernet1", # "qos_dscp": 10, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl01", # "direction": "in" # } # ], # "afi": "ip" # }, # { # "acls": [ # { # "acl_name": "acl02", # "direction": "in" # } # ], # "afi": "ipv6" # } # ] # }, # "servers": [ # { # "burst": true, # "prefer": true, # "server": "10.1.1.1", # "vrf": "vrf01" # }, # { # "key_id": 2, # "maxpoll": 15, # "server": "25.1.1.1", # "vrf": "vrf01" # } # ], # "trusted_key": "23" # }, # "changed": true, # "commands": [ # "no ntp serve ip access-group acl01 in", # "no ntp serve ipv6 access-group acl02 in", # "no ntp authentication-key 23 md5 7 ********", # "no ntp server vrf vrf01 10.1.1.1 burst prefer", # "no ntp server vrf vrf01 25.1.1.1 key 2 maxpoll 15", # "no ntp authenticate", # "no ntp local-interface Ethernet1", # "no ntp trusted-key 23", # "ntp serve ip access-group acl03 in", # "ntp authentication-key 2 md5 7 ********", # "ntp server vrf vrf01 11.21.1.1 burst minpoll 13 prefer", # "ntp qos dscp 15" # ], # # Using Overridden # Before State # localhost(config)#show running-config | section ntp # ntp authentication-key 2 sha1 7 123456 # ntp authentication-key 23 md5 7 123456 # ntp trusted-key 23 # ntp authenticate # ntp local-interface Ethernet1 # ntp qos dscp 10 # ntp server vrf vrf01 10.1.1.1 prefer burst # ntp server vrf vrf01 25.1.1.1 maxpoll 15 key 2 # ntp serve ip access-group acl01 in # ntp serve ipv6 access-group acl02 in # localhost(config)# - name: Replace arista.eos.eos_ntp_global: config: qos_dscp: 15 authentication_keys: - id: 2 algorithm: "md5" encryption: 7 key: "123456" servers: - server: "11.21.1.1" vrf: "vrf01" burst: true prefer: true minpoll: 13 serve: access_lists: - afi: "ip" acls: - acl_name: "acl03" direction: "in" state: overridden # After State: # localhost(config)#show running-config | section ntp # ntp authentication-key 2 md5 7 123456 # ntp qos dscp 15 # ntp server vrf vrf01 11.21.1.1 prefer burst minpoll 13 # ntp serve ip access-group acl03 in # localhost(config)# # # # Module Execution: # "after": { # "authentication_keys": [ # { # "algorithm": "md5", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "qos_dscp": 15, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl03", # "direction": "in" # } # ], # "afi": "ip" # } # ] # }, # "servers": [ # { # "burst": true, # "minpoll": 13, # "prefer": true, # "server": "11.21.1.1", # "vrf": "vrf01" # } # ] # }, # "before": { # "authenticate": { # "enable": true # }, # "authentication_keys": [ # { # "algorithm": "sha1", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # }, # { # "algorithm": "md5", # "encryption": 7, # "id": 23, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "local_interface": "Ethernet1", # "qos_dscp": 10, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl01", # "direction": "in" # } # ], # "afi": "ip" # }, # { # "acls": [ # { # "acl_name": "acl02", # "direction": "in" # } # ], # "afi": "ipv6" # } # ] # }, # "servers": [ # { # "burst": true, # "prefer": true, # "server": "10.1.1.1", # "vrf": "vrf01" # }, # { # "key_id": 2, # "maxpoll": 15, # "server": "25.1.1.1", # "vrf": "vrf01" # } # ], # "trusted_key": "23" # }, # "changed": true, # "commands": [ # "no ntp serve ip access-group acl01 in", # "no ntp serve ipv6 access-group acl02 in", # "no ntp authentication-key 23 md5 7 ********", # "no ntp server vrf vrf01 10.1.1.1 burst prefer", # "no ntp server vrf vrf01 25.1.1.1 key 2 maxpoll 15", # "no ntp authenticate", # "no ntp local-interface Ethernet1", # "no ntp trusted-key 23", # "ntp serve ip access-group acl03 in", # "ntp authentication-key 2 md5 7 ********", # "ntp server vrf vrf01 11.21.1.1 burst minpoll 13 prefer", # "ntp qos dscp 15" # ], # # using deleted: # Before State # localhost(config)#show running-config | section ntp # ntp authentication-key 2 sha1 7 123456 # ntp authentication-key 23 md5 7 123456 # ntp trusted-key 23 # ntp authenticate # ntp local-interface Ethernet1 # ntp qos dscp 10 # ntp server vrf vrf01 10.1.1.1 prefer burst # ntp server vrf vrf01 11.21.1.1 prefer burst minpoll 13 # ntp server vrf vrf01 25.1.1.1 maxpoll 15 key 2 # ntp serve ip access-group acl01 in # ntp serve ipv6 access-group acl02 in # localhost(config)# - name: Delete ntp-global arista.eos.eos_ntp_global: state: deleted # After State: # localhost(config)#show running-config | section ntp # localhost(config)# # # # # Module Execution # "after": {}, # "before": { # "authenticate": { # "enable": true # }, # "authentication_keys": [ # { # "algorithm": "sha1", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # }, # { # "algorithm": "md5", # "encryption": 7, # "id": 23, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "local_interface": "Ethernet1", # "qos_dscp": 10, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl01", # "direction": "in" # } # ], # "afi": "ip" # }, # { # "acls": [ # { # "acl_name": "acl02", # "direction": "in" # } # ], # "afi": "ipv6" # } # ] # }, # "servers": [ # { # "burst": true, # "prefer": true, # "server": "10.1.1.1", # "vrf": "vrf01" # }, # { # "burst": true, # "minpoll": 13, # "prefer": true, # "server": "11.21.1.1", # "vrf": "vrf01" # }, # { # "key": 2, # "maxpoll": 15, # "server": "25.1.1.1", # "vrf": "vrf01" # } # ], # "trusted_key": "23" # }, # "changed": true, # "commands": [ # "no ntp serve ip access-group acl01 in", # "no ntp serve ipv6 access-group acl02 in", # "no ntp authentication-key 2 sha1 7 ********", # "no ntp authentication-key 23 md5 7 ********", # "no ntp server vrf vrf01 10.1.1.1 burst prefer", # "no ntp server vrf vrf01 11.21.1.1 burst minpoll 13 prefer", # "no ntp server vrf vrf01 25.1.1.1 key 2 maxpoll 15", # "no ntp authenticate", # "no ntp local-interface Ethernet1", # "no ntp qos dscp 10", # "no ntp trusted-key 23" # ], # # Using parsed: # parsed.cfg # ntp authentication-key 2 sha1 7 123456 # ntp authentication-key 23 md5 7 123456 # ntp trusted-key 23 # ntp authenticate # ntp local-interface Ethernet1 # ntp qos dscp 10 # ntp server vrf vrf01 10.1.1.1 prefer burst # ntp server vrf vrf01 11.21.1.1 prefer burst minpoll 13 # ntp server vrf vrf01 25.1.1.1 maxpoll 15 key 2 # ntp serve ip access-group acl01 in # ntp serve ipv6 access-group acl02 in - name: parse configs arista.eos.eos_ntp_global: running_config: "{{ lookup('file', './parsed_ntp_global.cfg') }}" state: parsed tags: - parsed # Module Execution # "parsed": { # "authenticate": { # "enable": true # }, # "authentication_keys": [ # { # "algorithm": "sha1", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # }, # { # "algorithm": "md5", # "encryption": 7, # "id": 23, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "local_interface": "Ethernet1", # "qos_dscp": 10, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl01", # "direction": "in" # } # ], # "afi": "ip" # }, # { # "acls": [ # { # "acl_name": "acl02", # "direction": "in" # } # ], # "afi": "ipv6" # } # ] # }, # "servers": [ # { # "burst": true, # "prefer": true, # "server": "10.1.1.1", # "vrf": "vrf01" # }, # { # "burst": true, # "minpoll": 13, # "prefer": true, # "server": "11.21.1.1", # "vrf": "vrf01" # }, # { # "key": 2, # "maxpoll": 15, # "server": "25.1.1.1", # "vrf": "vrf01" # } # ], # "trusted_key": "23" # } # } # using Gathered # Device config: # localhost(config)#show running-config | section ntp # ntp authentication-key 2 sha1 7 123456 # ntp authentication-key 23 md5 7 123456 # ntp trusted-key 23 # ntp authenticate # ntp local-interface Ethernet1 # ntp qos dscp 10 # ntp server vrf vrf01 10.1.1.1 prefer burst # ntp server vrf vrf01 25.1.1.1 maxpoll 15 key 2 # ntp serve ip access-group acl01 in # ntp serve ipv6 access-group acl02 in # localhost(config)# - name: gather configs arista.eos.eos_ntp_global: state: gathered tags: - gathered # Module Execution # "gathered": { # "authenticate": { # "enable": true # }, # "authentication_keys": [ # { # "algorithm": "sha1", # "encryption": 7, # "id": 2, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # }, # { # "algorithm": "md5", # "encryption": 7, # "id": 23, # "key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" # } # ], # "local_interface": "Ethernet1", # "qos_dscp": 10, # "serve": { # "access_lists": [ # { # "acls": [ # { # "acl_name": "acl01", # "direction": "in" # } # ], # "afi": "ip" # }, # { # "acls": [ # { # "acl_name": "acl02", # "direction": "in" # } # ], # "afi": "ipv6" # } # ] # }, # "servers": [ # { # "burst": true, # "prefer": true, # "server": "10.1.1.1", # "vrf": "vrf01" # }, # { # "key_id": 2, # "maxpoll": 15, # "server": "25.1.1.1", # "vrf": "vrf01" # } # ], # "trusted_key": "23" # }, # "invocation": { # "module_args": { # "config": null, # "running_config": null, # "state": "gathered" # } # } # } # using rendered: - name: Render provided configuration arista.eos.eos_ntp_global: config: authenticate: enable: true authentication_keys: - id: 2 algorithm: "sha1" encryption: 7 key: "123456" - id: 23 algorithm: "md5" encryption: 7 key: "123456" local_interface: "Ethernet1" qos_dscp: 10 trusted_key: 23 servers: - server: "10.1.1.1" vrf: "vrf01" burst: true prefer: true - server: "25.1.1.1" vrf: "vrf01" maxpoll: 15 key_id: 2 serve: access_lists: - afi: "ip" acls: - acl_name: "acl01" direction: "in" - afi: "ipv6" acls: - acl_name: "acl02" direction: "in" state: rendered # Module Execution: # "rendered": [ # "ntp serve ip access-group acl01 in", # "ntp serve ipv6 access-group acl02 in", # "ntp authentication-key 2 sha1 7 ********", # "ntp authentication-key 23 md5 7 ********", # "ntp server vrf vrf01 10.1.1.1 burst prefer", # "ntp server vrf vrf01 25.1.1.1 key 2 maxpoll 15", # "ntp authenticate", # "ntp local-interface Ethernet1", # "ntp qos dscp 10", # "ntp trusted-key 23" # ] # Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
after
dictionary
when changed
The resulting configuration after module execution.

Sample:
This output will always be in the same format as the module argspec.
before
dictionary
when state is merged, replaced, overridden, deleted or purged
The configuration prior to the module execution.

Sample:
This output will always be in the same format as the module argspec.
commands
list
when state is merged, replaced, overridden, deleted or purged
The set of commands pushed to the remote device.

Sample:
['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']
gathered
list
when state is gathered
Facts about the network resource gathered from the remote device as structured data.

Sample:
This output will always be in the same format as the module argspec.
parsed
list
when state is parsed
The device native config provided in running_config option parsed into structured data as per module argspec.

Sample:
This output will always be in the same format as the module argspec.
rendered
list
when state is rendered
The provided configuration in the task rendered in device-native format (offline).

Sample:
['ntp authentication-key 2 sha1 7 123456', 'ntp authentication-key 23 md5 7 123456', 'ntp trusted-key 23', 'ntp authenticate', 'ntp local-interface Ethernet1', 'ntp qos dscp 10', 'ntp server vrf vrf01 10.1.1.1 prefer burst', 'ntp server vrf vrf01 25.1.1.1 maxpoll 15 key 2', 'ntp serve ip access-group acl01 in', 'ntp serve ipv6 access-group acl02 in']


Status ------ Authors ~~~~~~~ - Gomathi Selvi Srinivasan (@GomathiselviS)