Модуль cisco.ise.sponsor_portal_info — Модуль информации для портала спонсоров
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.
Чтобы использовать его в плейбуке, укажите: cisco.ise.sponsor_portal_info.
Новое в cisco.ise 1.0.0
Описание
- Получить все порталы спонсоров.
- Получить портал спонсора по идентификатору.
- Этот API позволяет клиенту получить портал спонсора по ID.
- Этот API позволяет клиенту получить все порталы спонсоров.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтра. **Простая фильтрация** должна быть доступна через параметр строки запроса фильтра. Структура фильтра — тройка «поле оператор значение», разделенных точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию — И, и может быть изменён с помощью параметра строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут фильтруемым полем. Оператор «EQ» описывает «равно». Оператор «NEQ» описывает «не равно». Оператор «GT» описывает «больше». Оператор «LT» описывает «меньше». Оператор «STARTSW» описывает «начинается с». Оператор «NSTARTSW» описывает «не начинается с». Оператор «ENDSW» описывает «заканчивается на». Оператор «NENDSW» описывает «не заканчивается на». Оператор «CONTAINS» описывает «содержит». Оператор «NCONTAINS» описывает «не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для всех критериев фильтра, по умолчанию — И, и может быть изменён с помощью этого параметра. |
id строка | Параметр пути id. |
ise_debug логическое | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлено в cisco.ise 3.0.0 | Таймаут (в секундах) для RESTful HTTP-запросов. По умолчанию: |
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). Варианты:
|
ise_uses_csrf_token логическое добавлено в cisco.ise 3.0.0 | Флаг, информирующий SDK, отправлять ли токен CSRF в ERS API ISE. Если значение истинно, SDK предполагает, что проверка CSRF вашего ISE включена. Если значение истинно, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify логическое | Флаг для включения или выключения проверки сертификата SSL. Варианты:
|
ise_version строка | Информирует SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit логическое | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничений скорости. Варианты:
|
page целое число | Параметр запроса страницы. Номер страницы. |
size целое число | Параметр запроса размера. Количество объектов, возвращаемых на странице. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: sponsor_portal.SponsorPortal.get_sponsor_portal_by_id, sponsor_portal.SponsorPortal.get_sponsor_portal_generator,
- Используемые пути: get /ers/config/sponsorportal, get /ers/config/sponsorportal/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Sponsor Portal
cisco.ise.sponsor_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 Sponsor Portal by id
cisco.ise.sponsor_portal_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список со значением возврата Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0 | Словарь или список со значением возврата Cisco ISE Python SDK Возвращается: всегда Пример: |
Ссылки на сборку
© 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/sponsor_portal_info_module.html
