Модуль cisco.ise.telemetry_info – Модуль информации о телеметрии

Примечание

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

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

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

Для использования в книге задач укажите: cisco.ise.telemetry_info.

Новое в cisco.ise 1.0.0

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

Описание

Получить все данные телеметрии.
Получить данные телеметрии по ID.
Этот API позволяет клиенту получить все данные телеметрии.
Этот API позволяет клиенту получить данные телеметрии по идентификатору.

Примечание

Для этого модуля имеется соответствующий плагин действий.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
filter список / элементы=строка	Параметр запроса фильтрации. Простая фильтрация должна быть доступна через параметр строки запроса фильтрации. Структура фильтра — тройка: поле, оператор и значение, разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию — И, его можно изменить, используя параметр строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор «EQ» описывает «Равно». Оператор «NEQ» описывает «Не равно». Оператор «GT» описывает «Больше чем». Оператор «LT» описывает «Меньше чем». Оператор «STARTSW» описывает «Начинается с». Оператор «NSTARTSW» описывает «Не начинается с». Оператор «ENDSW» описывает «Заканчивается на». Оператор «NENDSW» описывает «Не заканчивается на». Оператор «CONTAINS» описывает «Содержит». Оператор «NCONTAINS» описывает «Не содержит».
filterType строка	Параметр filterType запроса. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию — И, его можно изменить, используя данный параметр.
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 в ERS-API ISE. Если True, SDK предполагает, что проверка CSRF вашего ISE включена. Если True, предполагается, что 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` ← (по умолчанию)
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов, возвращаемых на странице.

Примечания

Примечание

Используемые методы SDK: telemetry_information.TelemetryInformation.get_telemetry_info_by_id, telemetry_information.TelemetryInformation.get_telemetry_information_generator,
Используемые пути: get /ers/config/telemetryinfo, get /ers/config/telemetryinfo/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

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

Примеры

- name: Get all Telemetry Info
  cisco.ise.telemetry_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    filter: []
    filterType: AND
  register: result

- name: Get Telemetry Info by id
  cisco.ise.telemetry_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 Возвращается: всегда Пример: `{"deploymentId": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "status": "string", "udiSN": "string"}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"status\": \"string\",\n \"deploymentId\": \"string\",\n \"udiSN\": \"string\",\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/telemetry_info_module.html