nxos_ntp_auth — Управление аутентификацией NTP.
Новая версия с 2.2.
Описание
- Управление аутентификацией NTP.
Параметры
| параметр | обязательно | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4)
| нет | нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize имеет значение false, то этот аргумент не оказывает никакого влияния. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| auth_type | нет | текст |
| Указывает, является ли заданная строка md5 открытым текстом или зашифрованной. Если это открытый текст, устройство зашифрует его перед сохранением. |
| authentication | нет |
| Включает или выключает аутентификацию NTP. | |
| authorize (добавлен в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| key_id | да | Идентификатор ключа аутентификации (числовой). | ||
| md5string | да | Строка MD5. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для протоколов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (используется стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к протоколам cli или nxapi. Если порт не указан в задаче, значение по умолчанию — соответствующий стандартный порт для протокола (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, допустимые значения и т.д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| 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. | |
| trusted_key | нет |
| Указывает, требуется ли ключ от источника времени для синхронизации устройства с источником времени. | |
| use_ssl | нет |
| Настраивает использование SSL для протокола transport, если значение true и если transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации при входе в CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверяться. Это должно использоваться только на контролируемых сайтах с самоподписанными сертификатами. Если транспорт не nxapi, это значение игнорируется. |
Примеры
# Basic NTP authentication configuration
- nxos_ntp_auth:
key_id: 32
md5string: hello
auth_type: text
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| commands | команда, отправленная устройству | всегда | список | ['ntp authentication-key 32 md5 helloWorld 0', 'ntp trusted-key 32'] |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Если
state=absent, модуль попытается удалить конфигурацию данного ключа. Если соответствующая конфигурация ключа не найдена на устройстве, модуль завершится с ошибкой. - Если
state=absentиauthentication=on, аутентификация будет выключена. - Если
state=absentиauthentication=off, аутентификация будет включена.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией 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_auth_module.html