nxos_ntp — Управление основной конфигурацией NTP.
Новая версия с 2.2.
Описание
- Управляет основной конфигурацией NTP.
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host | да | Указывает имя или адрес хоста DNS для подключения к удалённому устройству по указанному протоколу. Значение параметра host используется как адрес назначения для протокола. | ||
| key_id | нет | Идентификатор ключа аутентификации для использования с заданным сервером NTP или узлом. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| peer | нет | Сеть адрес узла NTP. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к протоколам cli или nxapi. Значение порта по умолчанию соответствует стандартному порту протокола, если оно не задано в задаче (cli=22, http=80, https=443). | |
| prefer | нет |
| Устанавливает заданный NTP сервер или узел в качестве предпочтительного для устройства. | |
| provider | нет | Удобный метод, который позволяет передать все аргументы nxos как объект словаря. Все ограничения (обязательные, допустимые значения и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| server | нет | Сеть адрес сервера NTP. | ||
| source_addr | нет | Локальный адрес источника, с которого отправляются сообщения NTP. | ||
| source_int | нет | Локальный интерфейс источника, с которого отправляются сообщения NTP. Должно быть полное имя интерфейса. | ||
| ssh_keyfile | нет | Указывает SSH ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | наличие |
| Управляет состоянием ресурса. |
| timeout (добавлено в 2.3)
| нет | 10 | Устанавливает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает протокол transport для использования SSL, если значение равно true только при transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi, в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| vrf_name | нет | Устанавливает связь устройства с заданным NTP сервером или узлом через указанную VRF. |
Примеры
# Set NTP Server with parameters
- 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 после выполнения модуля | всегда | словарь | {'source': '3.3.3.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'} |
| existing | k/v пары существующего ntp сервера/узла | всегда | словарь | {'source': 'ethernet2/1', 'source_type': 'source-interface', 'key_id': '32', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'} |
| proposed | k/v пары параметров, переданных в модуль | всегда | словарь | {'source': '3.3.3.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'} |
| updates | команда, отправленная на устройство | всегда | список | ['ntp server 2.2.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 3.3.3.3'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы так решите, прочитайте Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_ntp_module.html