Модуль dellemc.enterprise_sonic.sonic_ntp — управление конфигурацией NTP на SONiC.

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.enterprise_sonic.

Чтобы использовать её в плейбуке, укажите: dellemc.enterprise_sonic.sonic_ntp.

Добавлено в dellemc.enterprise_sonic 2.0.0

Общие сведения
Параметры
Примечания
Примеры
Возвращаемые значения

Общие сведения

Этот модуль обеспечивает управление конфигурацией NTP на устройствах под управлением SONiC.

Параметры

Параметр	Комментарии
config dictionary	Задает параметры конфигурации NTP.
enable_ntp_auth boolean	Включение или отключение аутентификации NTP. Варианты: `false` `true`
ntp_keys list / elements=dictionary	Список ключей аутентификации NTP.
encrypted boolean	Значение ключа аутентификации NTP key_value зашифровано. Параметр encrypted нельзя удалить. Если значение «state» равно «merged», параметр «encrypted» является обязательным. Варианты: `false` `true`
key_id integer / обязательный	Идентификатор ключа аутентификации NTP.
key_type string	Тип ключа аутентификации NTP. Параметр key_type нельзя удалить. Если значение «state» равно «merged», параметр «key_type» является обязательным. Варианты: `"NTP_AUTH_SHA1"` `"NTP_AUTH_MD5"` `"NTP_AUTH_SHA2_256"`
key_value string	Значение ключа аутентификации NTP. Параметр key_value нельзя удалить. Если значение «state» равно «merged», параметр «key_value» является обязательным.
servers list / elements=dictionary	Список серверов NTP. Параметры minpoll и maxpoll необходимо настроить вместе.
address string / обязательный	Адрес IPv4/IPv6 или имя узла сервера NTP.
key_id integer	Ключ аутентификации NTP, используемый сервером. Параметр key_id нельзя удалить.
maxpoll integer	Максимальный интервал опроса сервера NTP. Параметр maxpoll нельзя удалить.
minpoll integer	Минимальный интервал опроса сервера NTP. Параметр minpoll нельзя удалить.
prefer boolean	Указывает, следует ли отдавать предпочтение этому серверу. Параметр prefer нельзя удалить. Варианты: `false` `true`
source_interfaces list / elements=string	Список имен исходных интерфейсов NTP.
trusted_keys list / elements=integer	Список доверенных ключей аутентификации NTP.
vrf string	Имя VRF, в котором включен NTP.
state string	Состояние конфигурации после выполнения модуля. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"`

Примечания

Примечание

Поддерживает check_mode.

Примеры

# Using "deleted" state
#
# 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" state
#
# 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" state
#
# 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" state
#
# 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" state
#
# 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" state
#
# 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" state
#
# 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" state
#
# 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
#

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
after list / elements=string	Результирующий вызов модуля конфигурации. Возвращается: при изменении Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
after(generated) list / elements=string	Сгенерированный вызов модуля конфигурации. Возвращается: когда `check_mode` Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
before list / elements=string	Конфигурация до вызова модуля. Возвращается: всегда Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
commands list / elements=string	Набор команд, отправленных на удаленное устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

1. Zhang (@mingjunzhang2019)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_ntp_module.html