nxos_ntp — Управляет основной конфигурацией NTP.
Новая версия 2.2.
Обзор
- Управляет основной конфигурацией NTP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| key_id | Идентификатор ключа аутентификации, используемый с заданным сервером NTP или узлом или ключевое слово 'default'. | ||
| peer | Сеть адрес узла NTP. | ||
| prefer |
| Делает заданный сервер NTP или узел предпочтительным сервером NTP или узлом для устройства. | |
| provider | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать общий порт)" | Указывает порт, используемый при построении подключения к удаленному устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию будет соответствовать обычному порту транспорта, если он не задан в задаче (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в консоль CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлен в 2.5.3) |
| Указывает модулю перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не задано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлен в 2.5.3) | По умолчанию: "none" | Указывает пароль для использования, если требуется перейти в привилегированный режим на удаленном устройстве. Если authorize false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлен в 2.3) | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает транспорт для использования SSL, если установлено в true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверяемых сертификатов. Если аргумент транспорт не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлен в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| server | Сеть адрес сервера NTP. | ||
| source_addr | Локальный исходный адрес, с которого отправляются сообщения NTP, или ключевое слово 'default' | ||
| source_int | Локальный исходный интерфейс, с которого отправляются сообщения NTP. Должен быть полным именем интерфейса или ключевым словом 'default' | ||
| state |
| Управление состоянием ресурса. | |
| vrf_name | Делает устройство взаимодействующим с заданным сервером NTP или узлом через определённую ВРФ или ключевое слово 'default'. | ||
Примечания
Примечание
- Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# 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 boolean | всегда | проверка внесения изменений на устройстве Пример: True |
| end_state dict | всегда | пара ключ/значение информации ntp после выполнения модуля Пример: {'address': '2.2.2.2', 'key_id': '48', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': '3.3.3.3', 'source_type': 'источник'} |
| existing dict | всегда | пара ключ/значение существующего ntp сервера/узла Пример: {'address': '2.2.2.2', 'key_id': '32', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'источник-интерфейс'} |
| proposed dict | всегда | пара ключ/значение параметров, переданных в модуль Пример: {'address': '2.2.2.2', 'key_id': '48', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': '3.3.3.3', 'source_type': 'источник'} |
| updates list | всегда | команда, отправленная на устройство Пример: ['ntp server 2.2.2.2 prefer ключ 48', 'no ntp источник-интерфейс ethernet2/1', 'ntp источник 3.3.3.3'] |
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых командой Ansible по работе с сетями, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- Jason Edelman (@jedelman8)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/nxos_ntp_module.html