cisco.nxos.nxos_aaa_server – Управляет глобальной конфигурацией сервера AAA.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач, укажите: cisco.nxos.nxos_aaa_server.
В версии 1.0.0: коллекции cisco.nxos
Описание
- Управляет глобальной конфигурацией сервера 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. Начиная с Ansible 2.6, для NX-API рекомендуется использовать connection: httpapi. Этот параметр будет удален в релизе после 2022-06-01. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий детали подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если требуется. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Если порт не указан в задаче, значение по умолчанию соответствует стандартному порту для транспорта (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т. д.). | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. Транспорт поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_proxy булево |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl булево |
| Настраивает transport на использование SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверяющих сертификатов. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| 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
cisco.nxos.nxos_aaa_server:
server_type: radius
server_timeout: 9
deadtime: 20
directed_request: enabled
# Tacacs Server Basic settings
- name: Tacacs Server Basic settings
cisco.nxos.nxos_aaa_server:
server_type: tacacs
server_timeout: 8
deadtime: 19
directed_request: disabled
# Setting Global Key
- name: AAA Server Global Key
cisco.nxos.nxos_aaa_server:
server_type: radius
global_key: test_key
Возвращаемые значения
Общие возвращаемые значения описаны в документации. Ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | команда, отправленная устройству Пример: ['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request'] |
Авторы
- Jason Edelman (@jedelman8)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_aaa_server_module.html