Модуль cisco.ise.hotspot_portal_info – Модуль информации для портала Hotspot
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: cisco.ise.hotspot_portal_info.
Впервые появился в cisco.ise 1.0.0
Описание
- Получить все порталы Hotspot.
- Получить портал Hotspot по идентификатору.
- Этот API позволяет клиенту получить портал Hotspot по идентификатору.
- Этот API позволяет клиенту получить все порталы Hotspot.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- 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 для отправки запросов. Если значение true, используется шлюз API ISE и запросы отправляются на https://{{ise_hostname}}. Если значение false, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token логическое значение добавлено в cisco.ise 3.0.0 | Флаг, информирующий SDK, отправлять ли токен CSRF в API ERS ISE. Если значение True, SDK предполагает, что проверка CSRF ISE включена. Если значение True, предполагается, что 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: hotspot_portal.HotspotPortal.get_hotspot_portal_by_id, hotspot_portal.HotspotPortal.get_hotspot_portal_generator,
- Используемые пути: get /ers/config/hotspotportal, get /ers/config/hotspotportal/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины соединения ansible, а вместо этого встроенный менеджер соединений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Hotspot Portal
cisco.ise.hotspot_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 Hotspot Portal by id
cisco.ise.hotspot_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 Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0 | Словарь или список с ответом, возвращенным Python SDK Cisco ISE Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/hotspot_portal_info_module.html
