Spec-Zone.ru › Ansible

Модуль cisco.ise.sponsor_group_member_info – Модуль информации о членах группы спонсоров

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля потребуются дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в плейбуке, укажите: cisco.ise.sponsor_group_member_info.

Добавлен в cisco.ise 1.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Получить всех членов группы спонсоров.
  • Этот API позволяет клиенту получить всех членов группы спонсоров.

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

filter

список / элементы=строка

Параметр запроса фильтрации. **Простое фильтрание** должно быть доступно через параметр строки запроса фильтра. Структура фильтра — это тройка поле-оператор-значение, разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию будет И, и его можно изменить, используя параметр строки запроса «filterType=или».

Описание модели данных каждого ресурса должно указывать, является ли атрибут полем для фильтрации.

Оператор 'EQ' описывает 'Равно'.

Оператор 'NEQ' описывает 'Не равно'.

Оператор 'GT' описывает 'Больше чем'.

Оператор 'LT' описывает 'Меньше чем'.

Оператор 'STARTSW' описывает 'Начинается с'.

Оператор 'NSTARTSW' описывает 'Не начинается с'.

Оператор 'ENDSW' описывает 'Оканчивается на'.

Оператор 'NENDSW' описывает 'Не оканчивается на'.

Оператор 'CONTAINS' описывает 'Содержит'.

Оператор 'NCONTAINS' описывает 'Не содержит'.

filterType

строка

Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию будет И, и его можно изменить, используя этот параметр.

ise_debug

булево

Флаг для Identity Services Engine SDK для включения отладки.

Варианты:

  • false ← (по умолчанию)
  • true

ise_hostname

строка / обязательно

Имя хоста Identity Services Engine.

ise_password

строка / обязательно

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

целое число

добавлен в cisco.ise 3.0.0

Таймаут (в секундах) для RESTful HTTP-запросов.

По умолчанию: 60

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).

Варианты:

  • false
  • true ← (по умолчанию)

ise_uses_csrf_token

булево

добавлен в cisco.ise 3.0.0

Флаг, который сообщает SDK, отправлять ли токен CSRF в API ERS ISE.

Если значение True, SDK предполагает, что проверка CSRF ISE включена.

Если значение True, предполагается, что SDK должен автоматически управлять токеном CSRF.

Варианты:

  • false ← (по умолчанию)
  • true

ise_verify

булево

Флаг для включения или отключения проверки SSL-сертификатов.

Варианты:

  • false
  • true ← (по умолчанию)

ise_version

строка

Указывает SDK, какую версию Identity Services Engine использовать.

По умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

булево

Флаг для Identity Services Engine SDK для включения автоматической обработки лимитов скорости.

Варианты:

  • false
  • true ← (по умолчанию)

page

целое число

Параметр запроса страницы. Номер страницы.

size

целое число

Параметр запроса размера. Количество объектов, возвращаемых на страницу.

sortasc

строка

Параметр запроса sortasc. Сортировка по возрастанию.

sortdsc

строка

Параметр запроса sortdsc. Сортировка по убыванию.

Примечания

Примечание

  • Используемые методы SDK: sponsor_group_member.SponsorGroupMember.get_sponsor_group_member_generator,
  • Используемые пути: get /ers/config/sponsorgroupmember,
  • Поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Get all Sponsor Group Member
  cisco.ise.sponsor_group_member_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

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ

Описание

ise_response

список / элементы=словарь

Словарь или список со значением, возвращаемым Python SDK Cisco ISE.

Возвращается: всегда

Пример: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"link\": {\n      \"rel\": \"string\",\n      \"href\": \"string\",\n      \"type\": \"string\"\n    }\n  }\n]\n"

ise_responses

список / элементы=словарь

добавлен в cisco.ise 1.1.0

Словарь или список со значением, возвращаемым Python SDK Cisco ISE.

Возвращается: всегда

Пример: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"link\": {\n      \"rel\": \"string\",\n      \"href\": \"string\",\n      \"type\": \"string\"\n    }\n  }\n]\n"

Авторы

  • Rafael Campos (@racampos)

Ссылки на сборку

  • Система отслеживания задач
  • Репозиторий (источники)

© 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_member_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API