Модуль cisco.ise.tacacs_external_servers_info – Модуль информации о внешних серверах TACACS

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.tacacs_external_servers_info.

Добавлена в cisco.ise 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Примечание

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

Требования

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

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 строка	Параметр пути «имя».
page целое число	Параметр запроса «страница». Номер страницы.
size целое число	Параметр запроса «размер». Количество возвращаемых объектов на странице.

Примечания

Примечание

Используемые методы SDK: tacacs_external_servers.TacacsExternalServers.get_tacacs_external_servers_by_id, tacacs_external_servers.TacacsExternalServers.get_tacacs_external_servers_by_name, tacacs_external_servers.TacacsExternalServers.get_tacacs_external_servers_generator,
Используемые пути: get /ers/config/tacacsexternalservers, get /ers/config/tacacsexternalservers/name/{name}, get /ers/config/tacacsexternalservers/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all TACACS External Servers
  cisco.ise.tacacs_external_servers_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 TACACS External Servers by id
  cisco.ise.tacacs_external_servers_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get TACACS External Servers by name
  cisco.ise.tacacs_external_servers_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 Возвращается: всегда Пример: `{"connectionPort": 0, "description": "string", "hostIP": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "sharedSecret": "string", "singleConnect": true, "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 \"connectionPort\": 0,\n \"singleConnect\": true,\n \"sharedSecret\": \"string\",\n \"timeout\": 0,\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"`

Ключ

Описание

ise_response

словарь

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

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

Пример: {"connectionPort": 0, "description": "string", "hostIP": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "sharedSecret": "string", "singleConnect": true, "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 \"connectionPort\": 0,\n \"singleConnect\": true,\n \"sharedSecret\": \"string\",\n \"timeout\": 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/tacacs_external_servers_info_module.html