cisco.ise.endpoint_info модуль – Модуль информации об Endpoint
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: cisco.ise.endpoint_info.
Добавлено в cisco.ise 1.0.0
Описание
- Получение всех Endpoint.
- Получение Endpoint по идентификатору.
- Получение Endpoint по имени.
- Этот API позволяет клиенту получить все endpoint.
- Этот API позволяет клиенту получить endpoint по идентификатору.
- Этот API позволяет клиенту получить endpoint по имени.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтра. **Простой фильтр** должен быть доступен через параметр строки запроса 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 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 для включения автоматической обработки лимита запросов. Варианты:
|
name строка | Параметр пути name. |
page целое число | Параметр запроса page. Номер страницы. |
size целое число | Параметр запроса size. Количество объектов, возвращаемых на странице. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: endpoint.Endpoint.get_endpoint_by_id, endpoint.Endpoint.get_endpoint_by_name, endpoint.Endpoint.get_endpoints_generator,
- Используемые пути: get /ers/config/endpoint, get /ers/config/endpoint/name/{name}, get /ers/config/endpoint/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all Endpoint
cisco.ise.endpoint_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 by id
cisco.ise.endpoint_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get Endpoint by name
cisco.ise.endpoint_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 Возвращается: всегда Пример: |
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/endpoint_info_module.html
