cisco.nxos.nxos_aaa_server_host – Управляет конфигурацией узла сервера AAA.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_aaa_server_host.
Новое в версии 1.0.0: из cisco.nxos
Обзор
- Управляет конфигурацией узла сервера AAA.
Примечание
Для данного модуля существует соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| acct_port строка | Альтернативный порт UDP для RADIUS-отчётов или ключевое слово 'default'. | ||
| address строка / обязательно | Адрес или имя узла RADIUS или TACACS. | ||
| auth_port строка | Альтернативный порт UDP для RADIUS-аутентификации или ключевое слово 'default'. | ||
| encrypt_type строка |
| Состояние шифрования, применяемое к введённому ключу. 0 — открытый текст, 7 — зашифрованный. Шифрование типа 6 не поддерживается. | |
| host_timeout строка | Срок ожидания для указанного узла в секундах или ключевое слово 'default'. Диапазон от 1 до 60. | ||
| key строка | Секретный ключ для указанного узла или ключевое слово 'default'. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удалён в релизе после 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 строка |
| Настраивает транспортное соединение, которое необходимо использовать при подключении к удалённому устройству. Аргумент 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_type строка / обязательно |
| Тип сервера — либо radius, либо tacacs. | |
| state строка |
| Управление состоянием ресурса. | |
| tacacs_port строка | Альтернативный TCP-порт сервера TACACS или ключевое слово 'default'. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Изменения ключа узла (секретного ключа) не идемпотентны для типа 0.
- Если
state=absentудаляет всю конфигурацию узла. - Для получения информации об использовании CLI и NX-API см. руководство NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco integration.
Примеры
# Radius Server Host Basic settings
- name: Radius Server Host Basic settings
cisco.nxos.nxos_aaa_server_host:
state: present
server_type: radius
address: 1.2.3.4
acct_port: 2084
host_timeout: 10
# Radius Server Host Key Configuration
- name: Radius Server Host Key Configuration
cisco.nxos.nxos_aaa_server_host:
state: present
server_type: radius
address: 1.2.3.4
key: hello
encrypt_type: 7
# TACACS Server Host Configuration
- name: Tacacs Server Host Configuration
cisco.nxos.nxos_aaa_server_host:
state: present
server_type: tacacs
tacacs_port: 89
host_timeout: 10
address: 5.6.7.8
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed булево | всегда | проверка того, было ли внесено изменение на устройстве Пример: True |
| end_state словарь | всегда | параметры конфигурации после выполнения модуля Пример: {'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'} |
| existing словарь | всегда | параметры существующей конфигурации |
| proposed словарь | всегда | параметры, переданные в модуль Пример: {'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'} |
| updates список / элементы=строка | всегда | команда, отправленная на устройство Пример: ['radius-server host 1.2.3.4 auth-port 2084 timeout 10'] |
Авторы
- 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_host_module.html