dellemc.enterprise_sonic.sonic_ntp module – Manage NTP configuration on SONiC.
Note
This module is part of the dellemc.enterprise_sonic collection (version 2.5.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 dellemc.enterprise_sonic
.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_ntp
.
New in dellemc.enterprise_sonic 2.0.0
Synopsis
This module provides configuration management of NTP for devices running SONiC.
Parameters
Parameter |
Comments |
---|---|
Specifies NTP related configurations. |
|
Enable or disable NTP authentication. Choices:
|
|
List of NTP authentication keys. |
|
NTP authentication key_value is encrypted. encrypted can not be deleted. When “state” is “merged”, “encrypted” is required. Choices:
|
|
NTP authentication key identifier. |
|
NTP authentication key type. key_type can not be deleted. When “state” is “merged”, “key_type” is required. Choices:
|
|
NTP authentication key value. key_value can not be deleted. When “state” is “merged”, “key_value” is required. |
|
List of NTP servers. minpoll and maxpoll are required to be configured together. |
|
IPv4/IPv6 address or host name of NTP server. |
|
NTP authentication key used by server. Key_id can not be deleted. |
|
Maximum poll interval to poll NTP server. maxpoll can not be deleted. |
|
Minimum poll interval to poll NTP server. minpoll can not be deleted. |
|
Indicates whether this server should be preferred. prefer can not be deleted. Choices:
|
|
List of names of NTP source interfaces. |
|
List of trusted NTP authentication keys. |
|
VRF name on which NTP is enabled. |
|
The state of the configuration after module completion. Choices:
|
Notes
Note
Supports
check_mode
.
Examples
# Using deleted
#
# Before state:
# -------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.1 6 10 False
#10.11.0.2 5 9 False
#dell.com 6 9 False
#dell.org 7 10 True
#
- name: Delete NTP server configuration
sonic_ntp:
config:
servers:
- address: 10.11.0.2
- address: dell.org
state: deleted
# After state:
# ------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.1 6 10 False
#dell.com 6 9 False
#
#
# Using deleted
#
# Before state:
# -------------
#
#sonic# show ntp global
#----------------------------------------------
#NTP Global Configuration
#----------------------------------------------
#NTP source-interfaces: Ethernet0, Ethernet4, Ethernet8, Ethernet16
#
- name: Delete NTP source-interface configuration
sonic_ntp:
config:
source_interfaces:
- Ethernet8
- Ethernet16
state: deleted
# After state:
# ------------
#
#sonic# show ntp global
#----------------------------------------------
#NTP Global Configuration
#----------------------------------------------
#NTP source-interfaces: Ethernet0, Ethernet4
#
#
# Using deleted
#
# Before state:
# -------------
#
#sonic# show running-configuration | grep ntp
#ntp authentication-key 8 sha1 U2FsdGVkX1/NpJrdOeyMeUHEkSohY6azY9VwbAqXRTY= encrypted
#ntp authentication-key 10 md5 U2FsdGVkX1/Gxds/5pscCvIKbVngGaKka4SQineS51Y= encrypted
#ntp authentication-key 20 sha2-256 U2FsdGVkX1/eAzKj1teKhYWD7tnzOsYOijGeFAT0rKM= encrypted
#
- name: Delete NTP key configuration
sonic_ntp:
config:
ntp_keys:
- key_id: 10
- key_id: 20
state: deleted
#
# After state:
# ------------
#
#sonic# show running-configuration | grep ntp
#ntp authentication-key 8 sha1 U2FsdGVkX1/NpJrdOeyMeUHEkSohY6azY9VwbAqXRTY= encrypted
#
#
# Using merged
#
# Before state:
# -------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.1 6 10 False
#dell.com 6 9 False
#
- name: Merge NTP server configuration
sonic_ntp:
config:
servers:
- address: 10.11.0.2
minpoll: 5
- address: dell.org
minpoll: 7
maxpoll: 10
prefer: true
state: merged
# After state:
# ------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.1 6 10 Flase
#10.11.0.2 5 10 Flase
#dell.com 6 9 Flase
#dell.org 7 10 True
#
#
# Using merged
#
# Before state:
# -------------
#
#sonic# show ntp global
#----------------------------------------------
#NTP Global Configuration
#----------------------------------------------
#NTP source-interfaces: Ethernet0, Ethernet4
#
- name: Merge NTP source-interface configuration
sonic_ntp:
config:
source_interfaces:
- Ethernet8
- Ethernet16
state: merged
# After state:
# ------------
#
#sonic# show ntp global
#----------------------------------------------
#NTP Global Configuration
#----------------------------------------------
#NTP source-interfaces: Ethernet0, Ethernet4, Ethernet8, Ethernet16
#
#
# Using merged
#
# Before state:
# -------------
#
#sonic# show running-configuration | grep ntp
#ntp authentication-key 8 sha1 U2FsdGVkX1/NpJrdOeyMeUHEkSohY6azY9VwbAqXRTY= encrypted
#
- name: Merge NTP key configuration
sonic_ntp:
config:
ntp_keys:
- key_id: 10
key_type: NTP_AUTH_MD5
key_value: dellemc10
encrypted: false
- key_id: 20
key_type: NTP_AUTH_SHA2_256
key_value: dellemc20
encrypted: false
state: merged
#
# After state:
# ------------
#
#sonic# show running-configuration | grep ntp
#ntp authentication-key 8 sha1 U2FsdGVkX1/NpJrdOeyMeUHEkSohY6azY9VwbAqXRTY= encrypted
#ntp authentication-key 10 md5 U2FsdGVkX1/Gxds/5pscCvIKbVngGaKka4SQineS51Y= encrypted
#ntp authentication-key 20 sha2-256 U2FsdGVkX1/eAzKj1teKhYWD7tnzOsYOijGeFAT0rKM= encrypted
#
# Using replaced
#
# Before state:
# -------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.1 6 10 False
#dell.com 6 9 False
#
- name: Replace NTP server configuration
sonic_ntp:
config:
servers:
- address: 10.11.0.2
minpoll: 5
maxpoll: 9
- address: dell.com
minpoll: 7
maxpoll: 10
prefer: true
state: replaced
#
# After state:
# ------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.1 6 10 False
#10.11.0.2 5 9 False
#dell.com 7 10 True
#
# Using overridden
#
# Before state:
# -------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.1 6 10 False
#dell.com 6 9 False
#
#sonic# show ntp global
#----------------------------------------------
#NTP Global Configuration
#----------------------------------------------
#NTP source-interfaces: Ethernet0, Ethernet4
#
- name: Overridden NTP configuration
sonic_ntp:
config:
servers:
- address: 10.11.0.2
minpoll: 5
- address: dell.com
minpoll: 7
maxpoll: 10
prefer: true
state: overridden
#
# After state:
# ------------
#
# After state:
# ------------
#
#sonic# show ntp server
#----------------------------------------------------------------------------
#NTP Servers minpoll maxpoll Prefer Authentication key ID
#----------------------------------------------------------------------------
#10.11.0.2 5 10 False
#dell.com 7 10 True
#
#sonic# show ntp global
#
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The resulting configuration module invocation. Returned: when changed Sample: |
|
The generated configuration module invocation. Returned: when Sample: |
|
The configuration prior to the module invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |