Модуль cisco.ise.portal_theme_info – Модуль информации о теме портала
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.
Для использования в плейбуке укажите: cisco.ise.portal_theme_info.
Новая функция в cisco.ise 1.0.0
Обзор
- Получить все темы портала.
- Получить тему портала по идентификатору.
- Этот API позволяет клиенту получить тему портала по идентификатору.
- Этот 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 для отправки запросов. Если он равен 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 целое число | Параметр запроса page. Номер страницы. |
size целое число | Параметр запроса size. Количество объектов, возвращаемых за раз. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: portal_theme.PortalTheme.get_portal_theme_by_id, portal_theme.PortalTheme.get_portal_themes_generator,
- Используемые пути: get /ers/config/portaltheme, get /ers/config/portaltheme/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Portal Theme
cisco.ise.portal_theme_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 Theme by id
cisco.ise.portal_theme_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/portal_theme_info_module.html
