Модуль cisco.ise.sgt_bulk_monitor_status_info – Информационный модуль для состояния массового мониторинга SGt

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.ise.sgt_bulk_monitor_status_info.

Новое в cisco.ise 1.0.0

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

Краткое описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
bulkid строка	Параметр пути Bulkid.
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	Тайм-аут (в секундах) для HTTP-запросов RESTful. По умолчанию: `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 в API ERS 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` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: security_groups.SecurityGroups.monitor_bulk_status_security_group,
Используемые пути: get /ers/config/sgt/bulk/{bulkid},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

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

Примеры

- name: Get SGt Bulk Monitor Status by id
  cisco.ise.sgt_bulk_monitor_status_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    bulkid: string
  register: result

Значения возврата

Общие значения возврата задокументированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
ise_response словарь	Словарь или список, содержащий ответ, возвращённый Cisco ISE Python SDK Возвращается: всегда Пример: `{"bulkId": "string", "executionStatus": "string", "failCount": 0, "mediaType": "string", "operationType": "string", "resourcesCount": 0, "resourcesStatus": [{"description": "string", "id": "string", "name": "string", "resourceExecutionStatus": "string", "status": "string"}], "startTime": "string", "successCount": 0}`

Ключ

Описание

ise_response

словарь

Словарь или список, содержащий ответ, возвращённый Cisco ISE Python SDK

Возвращается: всегда

Пример: {"bulkId": "string", "executionStatus": "string", "failCount": 0, "mediaType": "string", "operationType": "string", "resourcesCount": 0, "resourcesStatus": [{"description": "string", "id": "string", "name": "string", "resourceExecutionStatus": "string", "status": "string"}], "startTime": "string", "successCount": 0}

Авторы

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/sgt_bulk_monitor_status_info_module.html