Модуль cisco.dnac.dnacaap_management_execution_status_info – Модуль информации о состоянии выполнения управления Dnacaap

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.dnac.dnacaap_management_execution_status_info.

Новое в cisco.dnac 4.0.0

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

Обзор

Получение состояния выполнения управления Dnacaap по id.
Получение данных о выполнении бизнес-API.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
executionId string	Параметр пути executionId. Идентификатор выполнения API.
headers словарь	Дополнительные заголовки.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов против схемы JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: task.Task.get_business_api_execution_details,
Используемые пути: get /dna/intent/api/v1/dnacaap/management/execution-status/{executionId},
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по задаче GetBusinessAPIExecutionDetails: Полная справка по API GetBusinessAPIExecutionDetails.

Примеры

- name: Get Dnacaap Management Execution Status by id
  cisco.dnac.dnacaap_management_execution_status_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    executionId: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением возврата Cisco DNAC Python SDK Возвращается: всегда Пример: `{"bapiError": "string", "bapiExecutionId": "string", "bapiKey": "string", "bapiName": "string", "endTime": "string", "endTimeEpoch": 0, "runtimeInstanceId": "string", "startTime": "string", "startTimeEpoch": 0, "status": "string", "timeDuration": 0}`

Ключ

Описание

dnac_response

словарь

Словарь или список со значением возврата Cisco DNAC Python SDK

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

Пример: {"bapiError": "string", "bapiExecutionId": "string", "bapiKey": "string", "bapiName": "string", "endTime": "string", "endTimeEpoch": 0, "runtimeInstanceId": "string", "startTime": "string", "startTimeEpoch": 0, "status": "string", "timeDuration": 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/dnac/dnacaap_management_execution_status_info_module.html