Модуль cisco.ise.sg_mapping_group_bulk_monitor_status_info — Модуль информации о статусе массового мониторинга групп сопоставления SG

Примечание

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

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

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

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

Введено в cisco.ise 1.0.0

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

Обзор

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
bulkid строка	Параметр пути bulkid.
ise_debug логическое	Флаг для SDK Identity Services Engine для включения отладки. Варианты: `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 в API ISE ERS. Если значение 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 логическое	Флаг для SDK Identity Services Engine для включения автоматической обработки лимита запросов. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get SG Mapping Group Bulk Monitor Status by id
  cisco.ise.sg_mapping_group_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/sg_mapping_group_bulk_monitor_status_info_module.html