Модуль cisco.ise.portal_info – Информационный модуль для портала

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.ise.portal_info.

Новая версия в cisco.ise 1.0.0

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

Описание

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

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
filter список / элементы=строка	Параметр запроса фильтра. Простой поиск должен быть доступен через параметр строки запроса filter. Структура фильтра — тройка «поле оператор значение», разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию — И, и может быть изменён с помощью параметра строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор «EQ» означает «Равно». Оператор «NEQ» означает «Не равно». Оператор «GT» означает «Больше». Оператор «LT» означает «Меньше». Оператор «STARTSW» означает «Начинается с». Оператор «NSTARTSW» означает «Не начинается с». Оператор «ENDSW» означает «Заканчивается на». Оператор «NENDSW» означает «Не заканчивается на». Оператор «CONTAINS» означает «Содержит». Оператор «NCONTAINS» означает «Не содержит».
filterType строка	Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию — И, и может быть изменён с помощью параметра.
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 для отправки запросов. Если значение истинно, используется API-шлюз ISE и запросы отправляются на https://{{ise_hostname}}. Если ложно, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0	Флаг, указывающий SDK, отправлять ли маркер CSRF в API ERS ISE. Если значение истинно, SDK предполагает, что проверка CSRF ISE включена. Если значение истинно, предполагается, что 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` ← (по умолчанию)
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов на странице.
sortasc строка	Параметр запроса sortasc. Сортировка по возрастанию.
sortdsc строка	Параметр запроса sortdsc. Сортировка по убыванию.

Примечания

Примечание

Используемые методы SDK: portal.Portal.get_portal_by_id, portal.Portal.get_portals_generator,
Используемые пути: get /ers/config/portal, get /ers/config/portal/{id},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all Portal
  cisco.ise.portal_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    sortasc: string
    sortdsc: string
    filter: []
    filterType: AND
  register: result

- name: Get Portal by id
  cisco.ise.portal_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

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

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

Ключ	Описание
ise_response словарь	Словарь или список, содержащий ответ, возвращенный Python SDK Cisco ISE. Возвращается: всегда Пример: `{"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "portalType": "string"}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список, содержащий ответ, возвращенный Python SDK Cisco ISE. Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"portalType\": \"string\",\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/portal_info_module.html