Модуль cisco.ise.external_radius_server_info – Модуль информации для внешнего сервера RADIUS

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: cisco.ise.external_radius_server_info.

Новое в cisco.ise 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Получить все внешние сервера RADIUS.
Получить внешний сервер RADIUS по ID.
Получить внешний сервер RADIUS по имени.
Этот API позволяет клиенту получить все внешние серверы RADIUS.
Этот API позволяет клиенту получить внешний сервер RADIUS по идентификатору.
Этот API позволяет клиенту получить внешний сервер RADIUS по имени.

Примечание

Для этого модуля существует соответствующий плагин действия.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
id строка	Параметр пути id.
ise_debug логическое	Флаг для Identity Services Engine SDK, позволяющий включить отладку. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0	Таймаут (в секундах) для запросов RESTful HTTP. По умолчанию: `60`
ise_username строка / обязательно	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway логическое добавлен в cisco.ise 1.1.0	Флаг, который информирует SDK, использовать ли шлюз API Identity Services Engine для отправки запросов. Если он имеет значение true, используется шлюз API ISE и отправляются запросы на https://{{ise_hostname}}. Если он имеет значение false, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0	Флаг, который информирует SDK, отправлять ли токен CSRF в API ERS ISE. Если он имеет значение True, SDK предполагает, что проверка CSRF ISE включена. Если он имеет значение True, предполагается, что вам нужно, чтобы SDK автоматически управлял токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логическое	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Информирует SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логическое	Флаг для Identity Services Engine SDK, позволяющий включить автоматическую обработку лимитов запросов. Варианты: `false` `true` ← (по умолчанию)
name строка	Параметр пути name.
page целое число	Параметр запроса page. Номер страницы.
size целое число	Параметр запроса size. Количество объектов, возвращаемых на странице.

Примечания

Примечание

Методы SDK используются external_radius_server.ExternalRadiusServer.get_external_radius_server_by_id, external_radius_server.ExternalRadiusServer.get_external_radius_server_by_name, external_radius_server.ExternalRadiusServer.get_external_radius_server_generator,
Используемые пути: get /ers/config/externalradiusserver, get /ers/config/externalradiusserver/name/{name}, get /ers/config/externalradiusserver/{id},
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all External RADIUS Server
  cisco.ise.external_radius_server_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get External RADIUS Server by id
  cisco.ise.external_radius_server_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get External RADIUS Server by name
  cisco.ise.external_radius_server_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
  register: result

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"accountingPort": 0, "authenticationPort": 0, "authenticatorKey": "string", "description": "string", "enableKeyWrap": true, "encryptionKey": "string", "hostIP": "string", "id": "string", "keyInputFormat": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "proxyTimeout": 0, "retries": 0, "sharedSecret": "string", "timeout": 0}`
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"hostIP\": \"string\",\n \"sharedSecret\": \"string\",\n \"enableKeyWrap\": true,\n \"encryptionKey\": \"string\",\n \"authenticatorKey\": \"string\",\n \"keyInputFormat\": \"string\",\n \"authenticationPort\": 0,\n \"accountingPort\": 0,\n \"timeout\": 0,\n \"retries\": 0,\n \"proxyTimeout\": 0,\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Ключ

Описание

ise_response

словарь

Словарь или список с ответом, возвращенным Cisco ISE Python SDK

Возвращается: всегда

Пример: {"accountingPort": 0, "authenticationPort": 0, "authenticatorKey": "string", "description": "string", "enableKeyWrap": true, "encryptionKey": "string", "hostIP": "string", "id": "string", "keyInputFormat": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "proxyTimeout": 0, "retries": 0, "sharedSecret": "string", "timeout": 0}

ise_responses

список / элементы=словарь

добавлено в cisco.ise 1.1.0

Словарь или список с ответом, возвращенным Cisco ISE Python SDK

Возвращается: всегда

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"hostIP\": \"string\",\n \"sharedSecret\": \"string\",\n \"enableKeyWrap\": true,\n \"encryptionKey\": \"string\",\n \"authenticatorKey\": \"string\",\n \"keyInputFormat\": \"string\",\n \"authenticationPort\": 0,\n \"accountingPort\": 0,\n \"timeout\": 0,\n \"retries\": 0,\n \"proxyTimeout\": 0,\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Авторы

Rafael Campos (@racampos)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/ise/external_radius_server_info_module.html