nxos_ntp – Управление основной конфигурацией NTP
Новая версия с 2.2.
Обзор
- Управляет основной конфигурацией NTP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| key_id - | Идентификатор ключа аутентификации для использования с заданным NTP-сервером или peer или ключевое слово 'default'. | ||
| peer - | Сеть адрес NTP peer. | ||
| prefer - |
| Устанавливает заданный NTP-сервер или peer в качестве предпочтительного NTP-сервера или peer для устройства. | |
| provider dictionary | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации, см. руководство NXOS Platform Options. Объект словаря с деталями подключения. | ||
| auth_pass string добавлено в 2.5.3 | Указывает пароль для использования, если требуется ввод привилегированного режима на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean добавлено в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | По умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при построении соединения с удаленным устройством. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию будет установлено на соответствующий общий порт транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer добавлено в 2.3 | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернет ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport string / обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если установлено yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, управляемых лично, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| server - | Сеть адрес NTP сервера. | ||
| source_addr - | Локальный исходный адрес, с которого отправляются NTP-сообщения, или ключевое слово 'default'. | ||
| source_int - | Локальный исходный интерфейс, с которого отправляются NTP-сообщения. Должен быть полное имя интерфейса или ключевое слово 'default'. | ||
| state - |
| Управление состоянием ресурса. | |
| vrf_name - | Настраивает устройство для связи с заданным NTP-сервером или peer через определенный VRF или ключевое слово 'default'. | ||
Примечания
Примечание
- Дополнительную информацию по использованию CLI и NX-API см. в руководстве NXOS Platform Options.
- Дополнительную информацию по использованию Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
- Дополнительную информацию по использованию Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
# 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 словарь | всегда | пара ключи/значения информации ntp после выполнения модуля Пример: {'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'источник'} |
| existing словарь | всегда | пара ключи/значения существующего ntp сервера/узла Пример: {'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'источник-интерфейс'} |
| proposed словарь | всегда | пара ключи/значения параметров, переданных в модуль Пример: {'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'источник'} |
| updates список | всегда | команда, отправленная устройству Пример: ['ntp server 192.0.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 192.0.2.3'] |
Статус
- Данный модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке данного модуля компанией Red Hat доступна в статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- 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.8/modules/nxos_ntp_module.html