cisco.ise.endpoints_info модуль – Модуль информации об Endpoints Info
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в книге задач укажите: cisco.ise.endpoints_info.
Добавлен в cisco.ise 1.0.0
Обзор
- Получение всей информации об Endpoints.
- Получение информации об Endpoints по id.
Примечание
Этот модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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, его можно изменить, используя этот параметр. |
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 для отправки запросов. Если значение True, используется API-шлюз ISE, и запросы отправляются по адресу https://{{ise_hostname}}. Если значение False, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token логический добавлен в cisco.ise 3.0.0 | Флаг, информирующий SDK, отправлять ли токен CSRF в ERS API ISE. Если значение True, SDK предполагает, что проверка CSRF в ISE включена. Если значение True, предполагается, что 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 Info
cisco.ise.endpoints_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 Info by id
cisco.ise.endpoints_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_info_module.html
