Модуль cisco.ise.sponsored_guest_portal_info – Модуль информации для портала Sponsored Guest
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: cisco.ise.sponsored_guest_portal_info.
Новая версия в cisco.ise 1.0.0
Обзор
- Получить все порталы Sponsored Guest.
- Получить портал Sponsored Guest по идентификатору.
- Этот API позволяет клиенту получить портал sponsored guest по ID.
- Этот API позволяет клиенту получить все порталы sponsored guest.
Примечание
Данный модуль имеет соответствующий плагин действий.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter list / elements=string | Параметр запроса фильтра. **Простая фильтрация** должна быть доступна через параметр строки запроса filter. Структура фильтра представляет собой тройку поле-оператор-значение, разделенные точками. Можно отправить более одного фильтра. Логическим оператором, общим для ВСЕХ критериев фильтра, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут фильтруемым полем. Оператор ‘EQ’ описывает ‘Равно’. Оператор ‘NEQ’ описывает ‘Не равно’. Оператор ‘GT’ описывает ‘Больше чем’. Оператор ‘LT’ описывает ‘Меньше чем’. Оператор ‘STARTSW’ описывает ‘Начинается с’. Оператор ‘NSTARTSW’ описывает ‘Не начинается с’. Оператор ‘ENDSW’ описывает ‘Заканчивается на’. Оператор ‘NENDSW’ описывает ‘Не заканчивается на’. Оператор ‘CONTAINS’ описывает ‘Содержит’. Оператор ‘NCONTAINS’ описывает ‘Не содержит’. |
filterType string | Параметр запроса FilterType. Логическим оператором, общим для ВСЕХ критериев фильтра, по умолчанию будет AND, и его можно изменить, используя этот параметр. |
id string | Параметр пути Id. |
ise_debug boolean | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname string / required | Имя хоста Identity Services Engine. |
ise_password string / required | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout integer added in cisco.ise 3.0.0 | Время ожидания (в секундах) для HTTP-запросов RESTful. По умолчанию: |
ise_username string / required | Имя пользователя Identity Services Engine для аутентификации. |
ise_uses_api_gateway boolean added in 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). Варианты:
|
ise_uses_csrf_token boolean added in cisco.ise 3.0.0 | Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если он имеет значение True, SDK предполагает, что проверка CSRF вашего ISE включена. Если он имеет значение True, предполагается, что вам необходимо, чтобы SDK автоматически управлял токеном CSRF. Варианты:
|
ise_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
ise_version string | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit boolean | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты:
|
page integer | Параметр запроса Page. Номер страницы. |
size integer | Параметр запроса Size. Количество возвращаемых объектов на странице. |
sortasc string | Параметр запроса Sortasc. Сортировка по возрастанию. |
sortdsc string | Параметр запроса Sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: sponsored_guest_portal.SponsoredGuestPortal.get_sponsored_guest_portal_by_id, sponsored_guest_portal.SponsoredGuestPortal.get_sponsored_guest_portals_generator,
- Используемые пути: get /ers/config/sponsoredguestportal, get /ers/config/sponsoredguestportal/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Sponsored Guest Portal
cisco.ise.sponsored_guest_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 Sponsored Guest Portal by id
cisco.ise.sponsored_guest_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/sponsored_guest_portal_info_module.html
