cisco.ise.endpoint_group_info модуль — Модуль информации для группы конечных точек

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.ise.endpoint_group_info.

Новая в cisco.ise 1.0.0

Синопсис
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Синопсис

Получить все группы конечных точек.
Получить группу конечных точек по идентификатору.
Получить группу конечных точек по имени.
Этот API позволяет клиенту получить все группы идентификаторов конечных точек.
Этот 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 для включения отладки. Варианты: `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 предполагает, что вам нужно, чтобы 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` ← (по умолчанию)
name строка	Параметр пути name.
page целое число	Параметр запроса page. Номер страницы.
size целое число	Параметр запроса size. Количество объектов на странице.
sortasc строка	Параметр запроса sortasc. Сортировка по возрастанию.
sortdsc строка	Параметр запроса sortdsc. Сортировка по убыванию.

Примечания

Примечание

Используемые методы SDK: endpoint_identity_group.EndpointIdentityGroup.get_endpoint_group_by_id, endpoint_identity_group.EndpointIdentityGroup.get_endpoint_group_by_name, endpoint_identity_group.EndpointIdentityGroup.get_endpoint_groups_generator,
Используемые пути: get /ers/config/endpointgroup, get /ers/config/endpointgroup/name/{name}, get /ers/config/endpointgroup/{id},
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

Документация Cisco ISE для EndpointIdentityGroup: Полная справка по API EndpointIdentityGroup.

Примеры

- name: Get all Endpoint Group
  cisco.ise.endpoint_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 Endpoint Group by id
  cisco.ise.endpoint_group_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get Endpoint Group by name
  cisco.ise.endpoint_group_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
  register: result

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

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "systemDefined": true}`
ise_responses список / элементы=словарь Добавлен в cisco.ise 1.1.0	Словарь или список со значением, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"systemDefined\": true,\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/endpoint_group_info_module.html