Модуль cisco.ise.self_registered_portal_info – Модуль информации для портала саморегистрации
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: cisco.ise.self_registered_portal_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 для отправки запросов. Если значение истинно, используется API-шлюз ISE, и запросы отправляются по адресу https://{{ise_hostname}}. Если значение ложно, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token булево добавлен в cisco.ise 3.0.0 | Флаг, который сообщает SDK, отправлять ли маркер CSRF в API ISE ERS. Если значение истинно, SDK предполагает, что проверка CSRF в вашем ISE включена. Если значение истинно, SDK предполагает, что вам нужно, чтобы 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: self_registered_portal.SelfRegisteredPortal.get_self_registered_portal_by_id, self_registered_portal.SelfRegisteredPortal.get_self_registered_portals_generator,
- Используемые пути: get /ers/config/selfregportal, get /ers/config/selfregportal/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
См. также
См. также
- Документация Cisco ISE для SelfRegisteredPortal
-
Полная справка по API SelfRegisteredPortal.
Примеры
- name: Get all Self Registered Portal
cisco.ise.self_registered_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 Self Registered Portal by id
cisco.ise.self_registered_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/self_registered_portal_info_module.html
