cisco.dnac.diagnostic_validation_workflows_v1_info 模块 – 诊断验证工作流 V1 信息模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 要求 了解详情。

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

cisco.dnac 6.15.0 中的新增功能

概要

  • 获取所有诊断验证工作流 V1。

  • 按 ID 获取诊断验证工作流 V1。

  • 检索已成功提交且当前可用的工作流。这是按 `submitTime` 排序的。

  • 检索工作流 ID 的工作流详细信息。

注意

此模块具有相应的 操作插件

要求

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

  • 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"

endTime

浮点数

EndTime 查询参数。在给定时间之前启动的工作流(自 UNIX 纪元以来的毫秒数)。

headers

字典

附加标头。

id

字符串

Id 路径参数。工作流 ID。

limit

浮点数

Limit 查询参数。此页要显示的记录数。

offset

浮点数

Offset 查询参数。此页要显示的第一条记录;第一条记录编号为 1。

runStatus

字符串

RunStatus 查询参数。工作流的执行状态。如果工作流已成功提交,则 runStatus 为 `PENDING`。如果工作流执行已启动,则 runStatus 为 `IN_PROGRESS`。如果执行的工作流已完成所有验证,则 runStatus 为 `COMPLETED`。如果工作流执行在运行验证时失败,则 runStatus 为 `FAILED`。

startTime

浮点数

StartTime 查询参数。在给定时间之后启动的工作流(自 UNIX 纪元以来的毫秒数)。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法为 health_and_performance.HealthAndPerformance.retrieves_the_list_of_validation_workflows_v1、health_and_performance.HealthAndPerformance.retrieves_validation_workflow_details_v1,

  • 使用的路径为 get /dna/intent/api/v1/diagnosticValidationWorkflows、get /dna/intent/api/v1/diagnosticValidationWorkflows/{id},

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解健康和性能 RetrievesTheListOfValidationWorkflowsV1

RetrievesTheListOfValidationWorkflowsV1 API 的完整参考。

Cisco DNA Center 文档,了解健康和性能 RetrievesValidationWorkflowDetailsV1

RetrievesValidationWorkflowDetailsV1 API 的完整参考。

示例

- name: Get all Diagnostic Validation Workflows V1
  cisco.dnac.diagnostic_validation_workflows_v1_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}}"
    startTime: 0
    endTime: 0
    runStatus: string
    offset: 0
    limit: 0
  register: result

- name: Get Diagnostic Validation Workflows V1 by id
  cisco.dnac.diagnostic_validation_workflows_v1_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}}"
    id: string
  register: result

返回值

常见的返回值已记录在 此处,以下是此模块独有的字段

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回值:始终

示例: {"response": {"description": "字符串", "id": "字符串", "name": "字符串", "releaseVersion": "字符串", "runStatus": "字符串", "submitTime": 0, "validationSetIds": ["字符串"], "validationSetsRunDetails": [{"endTime": 0, "startTime": 0, "validationRunDetails": [{"validationId": "字符串", "validationMessage": "字符串", "validationName": "字符串", "validationStatus": "字符串"}], "validationSetId": "字符串", "validationStatus": "字符串", "version": "字符串"}], "validationStatus": "字符串"}, "version": "字符串"}

作者

  • Rafael Campos (@racampos)