cisco.nxos.nxos_ntp – Управляет основной конфигурацией NTP.

Примечание

Этот плагин входит в состав коллекции cisco.nxos (версия 1.4.0).

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

Чтобы использовать его в плейбуке, укажите: cisco.nxos.nxos_ntp.

В версии 1.0.0: модуля cisco.nxos

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

Описание

Управляет основной конфигурацией NTP.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
key_id строка			Идентификатор ключа аутентификации для использования с заданным сервером NTP или узлом или ключевое слово «default».
peer строка			Сеть адрес NTP узла.
prefer строка		Варианты: enabled disabled	Делает указанный сервер NTP или узел предпочтительным сервером NTP или узлом для устройства.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для использования, если требуется войти в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS` вместо этого.
	authorize логическое значение	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE` вместо этого.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации соединения с удалённым устройством. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD` вместо этого.
	port целое число		Указывает порт, который следует использовать при построении соединения с удалённым устройством. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует общему порту транспорта, если он не предоставлен в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE` вместо этого.
	timeout целое число		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное соединение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логическое значение	no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl логическое значение	no ← yes	Настраивает transport для использования SSL, если установлено `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME` вместо этого.
	validate_certs логическое значение	no ← yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется.
server строка			Сеть адрес NTP сервера.
source_addr строка			Локальный адрес источника, с которого отправляются сообщения NTP, или ключевое слово «default».
source_int строка			Локальный интерфейс источника, с которого отправляются сообщения NTP. Должно быть полное имя интерфейса или ключевое слово «default».
state строка		Варианты: present ← absent	Управляет состоянием ресурса.
vrf_name строка			Делает устройство общается с указанным сервером NTP или узлом через определённую VRF или ключевое слово «default».

Примечания

Примечание

Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

# Set NTP Server with parameters
- cisco.nxos.nxos_ntp:
    server: 1.2.3.4
    key_id: 32
    prefer: enabled
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

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

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

Ключ	Возвращённое значение	Описание
changed логическое значение	всегда	проверка того, были ли внесены изменения на устройстве Пример: True
end_state словарь	всегда	k/v пары ntp-информации после выполнения модуля Пример: {'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
existing словарь	всегда	k/v пары существующего сервера/узла ntp Пример: {'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'server', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'source-interface'}
proposed словарь	всегда	k/v пары параметров, переданных в модуль Пример: {'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'server', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'source'}
updates список / элементы=строка	всегда	команда, отправленная устройству Пример: ['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3']

Авторы

Jason Edelman (@jedelman8)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_ntp_module.html