You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

dellemc.enterprise_sonic.sonic_ntp module – Manage NTP configuration on SONiC.

Note

This module is part of the dellemc.enterprise_sonic collection (version 2.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 dellemc.enterprise\_sonic.

To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_ntp.

New in dellemc.enterprise_sonic 2.0.0

Synopsis
Parameters
Examples
Return Values

Synopsis 

This module provides configuration management of NTP for devices running SONiC.

Parameters 

Parameter	Comments
config dictionary	Specifies NTP related configurations.
enable_ntp_auth boolean	Enable or disable NTP authentication. Choices: `false` `true`
ntp_keys list / elements=dictionary	List of NTP authentication keys.
encrypted boolean	NTP authentication key_value is encrypted. encrypted can not be deleted. When “state” is “merged”, “encrypted” is required. Choices: `false` `true`
key_id integer / required	NTP authentication key identifier.
key_type string	NTP authentication key type. key_type can not be deleted. When “state” is “merged”, “key_type” is required. Choices: `"NTP_AUTH_SHA1"` `"NTP_AUTH_MD5"` `"NTP_AUTH_SHA2_256"`
key_value string	NTP authentication key value. key_value can not be deleted. When “state” is “merged”, “key_value” is required.
servers list / elements=dictionary	List of NTP servers.
address string / required	IPv4/IPv6 address or host name of NTP server.
key_id integer	NTP authentication key used by server. Key_id can not be deleted.
maxpoll integer	Maximum poll interval to poll NTP server. maxpoll can not be deleted.
minpoll integer	Minimum poll interval to poll NTP server. minpoll can not be deleted.
source_interfaces list / elements=string	List of names of NTP source interfaces.
trusted_keys list / elements=integer	List of trusted NTP authentication keys.
vrf string	VRF name on which NTP is enabled.
state string	The state of the configuration after module completion. Choices: `"merged"` ← (default) `"deleted"`

Examples 

# Using deleted
#
# Before state:
# -------------
#
#sonic# show ntp server
#----------------------------------------------------------------------
#NTP Servers                     minpoll maxpoll Authentication key ID
#----------------------------------------------------------------------
#10.11.0.1                       6       10
#10.11.0.2                       5       9
#dell.com                        6       9
#dell.org                        7       10
#
- name: Delete NTP server configuration
  ntp:
    config:
      servers:
        - address: 10.11.0.2
        - address: dell.org
    state: deleted

# After state:
# ------------
#
#sonic# show ntp server
#----------------------------------------------------------------------
#NTP Servers                     minpoll maxpoll Authentication key ID
#----------------------------------------------------------------------
#10.11.0.1                       6       10
#dell.com                        6       9
#
#
# Using deleted
#
# Before state:
# -------------
#
#sonic# show ntp global
#----------------------------------------------
#NTP Global Configuration
#----------------------------------------------
#NTP source-interfaces:  Ethernet0, Ethernet4, Ethernet8, Ethernet16
#
- name: Delete NTP source-interface configuration
  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
  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 Authentication key ID
#----------------------------------------------------------------------
#10.11.0.1                       6       10
#dell.com                        6       9
#
- name: Merge NTP server configuration
  ntp:
    config:
      servers:
        - address: 10.11.0.2
          minpoll: 5
        - address: dell.org
          minpoll: 7
          maxpoll: 10
    state: merged

# After state:
# ------------
#
#sonic# show ntp server
#----------------------------------------------------------------------
#NTP Servers                     minpoll maxpoll Authentication key ID
#----------------------------------------------------------------------
#10.11.0.1                       6       10
#10.11.0.2                       5       9
#dell.com                        6       9
#dell.org                        7       10
#
#
# Using merged
#
# Before state:
# -------------
#
#sonic# show ntp global
#----------------------------------------------
#NTP Global Configuration
#----------------------------------------------
#NTP source-interfaces:  Ethernet0, Ethernet4
#
- name: Merge NTP source-interface configuration
  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
  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
#

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
after list / elements=string	The resulting configuration model invocation. Returned: when changed Sample: `["The configuration returned will always be in the same format\n of the parameters above.\n"]`
before list / elements=string	The configuration prior to the model invocation. Returned: always Sample: `["The configuration returned will always be in the same format\n of the parameters above.\n"]`
commands list / elements=string	The set of commands pushed to the remote device. Returned: always Sample: `["command 1", "command 2", "command 3"]`

Authors

1. Zhang (@mingjunzhang2019)

Collection links

Issue Tracker Repository (Sources)

dellemc.enterprise_sonic.sonic_ntp module – Manage NTP configuration on SONiC.

Synopsis

Parameters

Examples

Return Values