Модуль cisco.ise.sponsor_group_info – Модуль информации о группе спонсоров
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в playbook, укажите: cisco.ise.sponsor_group_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 в 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: sponsor_group.SponsorGroup.get_sponsor_group_by_id, sponsor_group.SponsorGroup.get_sponsor_group_generator,
- Используемые пути: get /ers/config/sponsorgroup, get /ers/config/sponsorgroup/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины соединения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Sponsor Group
cisco.ise.sponsor_group_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 Sponsor Group by id
cisco.ise.sponsor_group_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/sponsor_group_info_module.html
