cisco.dnac.dnacaap_management_execution_status_info 模块 – 用于 Dnacaap 管理执行状态信息的模块

注意

此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。

如果您正在使用 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.dnacaap_management_execution_status_info

cisco.dnac 4.0.0 中的新增功能

概要

  • 此模块表示模块 dnacaap_management_execution_status_v1_info 的别名

注意

此模块具有相应的 action 插件

要求

执行此模块的主机需要满足以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

布尔值

用于 Cisco DNA Center SDK 以启用调试的标志。

选项

  • false ←(默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

布尔值

用于启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ←(默认)

dnac_version

字符串

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值: "2.3.7.6"

executionId

字符串

ExecutionId 路径参数。API 的执行 ID。

headers

字典

附加标头。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用针对 JSON 模式验证请求主体的标志。

选项

  • false

  • true ←(默认)

备注

注意

  • 使用的 SDK 方法是 task.Task.get_business_api_execution_details_v1,

  • 使用的路径是 get /dna/intent/api/v1/dnacaap/management/execution-status/{executionId},

  • 应该注意的是,此模块是 dnacaap_management_execution_status_v1_info 的别名

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Task GetBusinessAPIExecutionDetailsV1

GetBusinessAPIExecutionDetailsV1 API 的完整参考。

示例

- name: Get Dnacaap Management Execution Status Info 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}

作者

  • Rafael Campos (@racampos)