nxos_aaa_server - Управляет глобальной конфигурацией сервера AAA.
Новая в версии 2.2.
Обзор
- Управляет глобальной конфигурацией сервера AAA
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| deadtime | Время ожидания недоступного сервера AAA в минутах или ключевое слово 'default'. Диапазон значений от 1 до 1440. Значение по умолчанию на устройстве - 0. | ||
| directed_request |
| Включает прямые запросы аутентификации на сервер AAA или ключевое слово 'default'. Значение по умолчанию на устройстве - disabled. | |
| encrypt_type |
| Состояние шифрования, примененное к введенному глобальному ключу. 0 - открытый текст, 7 - зашифрованный. Шифрование типа 6 не поддерживается. | |
| global_key | Глобальный общий секрет сервера AAA или ключевое слово 'default'. | ||
| 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 |
| Настраивает транспорт transport для использования SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлен в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| server_timeout | Глобальный таймаут сервера AAA в секундах или ключевое слово 'default'. Диапазон значений от 1 до 60. Значение по умолчанию на устройстве - 5. | ||
| server_type обязательно |
| Тип сервера — либо radius, либо tacacs. | |
| state |
| Управляет состоянием ресурса. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Параметр server_type всегда требуется.
- Если encrypt_type не указан, глобальный ключ сервера AAA будет храниться зашифрованным (тип 7).
- Изменения глобального ключа сервера AAA с encrypt_type=0 не являются идемпотентными.
- state=default установит указанные параметры в их значения по умолчанию. Параметры, которые необходимо установить по умолчанию, также должны быть установлены в значение default. Если global_key=default, глобальный ключ будет удален.
- Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# Radius Server Basic settings
- name: "Radius Server Basic settings"
nxos_aaa_server:
server_type: radius
server_timeout: 9
deadtime: 20
directed_request: enabled
# Tacacs Server Basic settings
- name: "Tacacs Server Basic settings"
nxos_aaa_server:
server_type: tacacs
server_timeout: 8
deadtime: 19
directed_request: disabled
# Setting Global Key
- name: "AAA Server Global Key"
nxos_aaa_server:
server_type: radius
global_key: test_key
Возвращаемые значения
Общие возвращаемые значения описаны в разделе. Ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Команда, отправленная устройству Пример: ['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request'] |
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости интерфейса нет.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его обслуживает команда Ansible Network Team. Дополнительную информацию см. в разделе по техническому обслуживанию и поддержке модулей.
Список других модулей, также поддерживаемых командой Ansible Network Team, см. в данном разделе.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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_aaa_server_module.html