Модуль cisco.ise.portal_global_setting_info – Модуль информации о глобальных настройках портала
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Для использования в книге задач укажите: cisco.ise.portal_global_setting_info.
Новое в cisco.ise 1.0.0
Описание
- Получение всех глобальных настроек портала.
- Получение глобальных настроек портала по идентификатору.
- Этот API позволяет клиенту получить все глобальные настройки портала.
- Этот API позволяет клиенту получить глобальные настройки портала по идентификатору.
Примечание
Этот модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтра. **Простой фильтр** должен быть доступен через параметр строки запроса фильтра. Структура фильтра — это тройка поле-оператор-значение, разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтра, будет по умолчанию AND и может быть изменен с помощью параметра строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор «EQ» описывает «равно». Оператор «NEQ» описывает «не равно». Оператор «GT» описывает «больше». Оператор «LT» описывает «меньше». Оператор «STARTSW» описывает «начинается с». Оператор «NSTARTSW» описывает «не начинается с». Оператор «ENDSW» описывает «заканчивается на». Оператор «NENDSW» описывает «не заканчивается на». Оператор «CONTAINS» описывает «содержит». Оператор «NCONTAINS» описывает «не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтра, будет по умолчанию AND и может быть изменен с помощью параметра. |
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 в ERS-API 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: portal_global_setting.PortalGlobalSetting.get_portal_global_setting_by_id, portal_global_setting.PortalGlobalSetting.get_portal_global_settings_generator,
- Используемые пути: get /ers/config/portalglobalsetting, get /ers/config/portalglobalsetting/{id},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Python SDK Cisco ISE для установления подключения
Примеры
- name: Get all Portal Global Setting
cisco.ise.portal_global_setting_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 Global Setting by id
cisco.ise.portal_global_setting_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_global_setting_info_module.html
