Модуль cisco.ise.endpoints_bulk_info – Модуль информации для массового добавления конечных точек
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.
Для использования в книге задач укажите: cisco.ise.endpoints_bulk_info.
Добавлен в cisco.ise 1.0.0
Описание
- Получить все конечные точки массово.
- Получить конечные точки массово по идентификатору.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter строка | Параметр запроса фильтрации. .. Контейнер **Простая фильтрация** должна быть доступна через параметр строки запроса фильтра. Структура фильтра — это тройка: поле, оператор и значение, разделенные точками. Можно передавать несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса *’filterType=or’*. Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор ‘EQ’ описывает ‘равно’. Оператор ‘NEQ’ описывает ‘не равно’. Оператор ‘GT’ описывает ‘больше, чем’. Оператор ‘LT’ описывает ‘меньше, чем’. Оператор ‘STARTSW’ описывает ‘начинается с’. Оператор ‘NSTARTSW’ описывает ‘не начинается с’. Оператор ‘ENDSW’ описывает ‘заканчивается на’. Оператор ‘NENDSW’ описывает ‘не заканчивается на’. Оператор ‘CONTAINS’ описывает ‘содержит’. Оператор ‘NCONTAINS’ описывает ‘не содержит’. |
filterType строка | Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя этот параметр. |
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 ERS ISE. Если значение истинно, SDK предполагает, что проверка CSRF вашего ISE включена. Если значение истинно, предполагается, что вам необходимо, чтобы SDK автоматически управлял токеном CSRF. Варианты:
|
ise_verify логический тип | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
ise_version строка | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit логический тип | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничений скорости. Варианты:
|
page целое число | Параметр запроса страницы. Номер страницы. |
size целое число | Параметр запроса размера. Количество объектов, возвращаемых на странице. |
sort строка | Параметр запроса сортировки. Тип сортировки — asc или desc. |
sortBy строка | Параметр запроса sortBy. Столбец, по которому нужно отсортировать объекты. |
value строка | Параметр пути value. Идентификатор или MAC-адрес конечной точки. |
Примечания
Примечание
- Используемые методы SDK — endpoints.Endpoints.get_1, endpoints.Endpoints.list_1_generator,
- Используемые пути — get /api/v1/endpoint, get /api/v1/endpoint/{value},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all Endpoints Bulk
cisco.ise.endpoints_bulk_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
page: 0
size: 0
sort: string
sortBy: string
filter: string
filterType: string
register: result
- name: Get Endpoints Bulk by id
cisco.ise.endpoints_bulk_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
value: 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/endpoints_bulk_info_module.html
