Модуль cisco.ise.anc_endpoint_info – Модуль информации для конечных устройств ANC
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.
Для использования в книге задач укажите: cisco.ise.anc_endpoint_info.
Добавлена в cisco.ise 1.0.0
Обзор
- Получить все конечные устройства ANC.
- Получить конечное устройство ANC по идентификатору.
- Этот API позволяет клиенту получить все конечные устройства ANC.
- Этот API позволяет клиенту получить конечное устройство ANC по его идентификатору.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтра. **Простое фильтрация** должна быть доступна через параметр строки запроса фильтра. Структура фильтра — это тройка «поле оператор значение», разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтра, будет по умолчанию И, и его можно изменить, используя параметр строки запроса «filterType=или». Описание модели данных каждого ресурса должно указывать, является ли атрибут фильтруемым полем. Оператор «EQ» обозначает «Равно». Оператор «NEQ» обозначает «Не равно». Оператор «GT» обозначает «Больше, чем». Оператор «LT» обозначает «Меньше, чем». Оператор «STARTSW» обозначает «Начинается с». Оператор «NSTARTSW» обозначает «Не начинается с». Оператор «ENDSW» обозначает «Заканчивается на». Оператор «NENDSW» обозначает «Не заканчивается на». Оператор «CONTAINS» обозначает «Содержит». Оператор «NCONTAINS» обозначает «Не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтра, будет по умолчанию И, и его можно изменить, используя параметр. |
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, чтобы включить автоматическую обработку ограничений скорости. Варианты:
|
page целое число | Параметр запроса страницы. Номер страницы. |
size целое число | Параметр запроса размера. Количество объектов, возвращаемых за страницу. |
sortasc строка | Параметр запроса sortasc. Сортировать по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировать по убыванию. |
Примечания
Примечание
- Используемые методы SDK: anc_endpoint.AncEndpoint.get_anc_endpoint_by_id, anc_endpoint.AncEndpoint.get_anc_endpoint_generator,
- Используемые пути: get /ers/config/ancendpoint, get /ers/config/ancendpoint/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all ANC Endpoint
cisco.ise.anc_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 ANC Endpoint by id
cisco.ise.anc_endpoint_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/anc_endpoint_info_module.html
