cisco.dnac.path_trace_v1 模块 – 路径追踪 V1 资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.dnac.path_trace_v1。

cisco.dnac 3.1.0 中的新增功能

摘要 

管理资源路径追踪 V1 的创建和删除操作。
启动新的流量分析，并带有周期性刷新和统计数据收集选项。返回请求 ID 和任务 ID 以获取结果并跟踪进度。
通过其 ID 删除流量分析请求。

注意

此模块具有相应的 action 插件。

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
controlPath 布尔值	控制路径追踪。选项 `false` `true`
destIP 字符串	目标 IP 地址。
destPort 字符串	目标端口，范围 1-65535。
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"`
flowAnalysisId 字符串	FlowAnalysisId 路径参数。流量分析请求 ID。
inclusions 列表 / 元素=字符串	{INTERFACE-STATS, QOS-STATS, DEVICE-STATS, PERFORMANCE-STATS, ACL-TRACE} 的子集。
periodicRefresh 布尔值	每 30 秒定期刷新路径。选项 `false` `true`
protocol 字符串	协议 - TCP、UDP 之一 - 留空时检查两者。
sourceIP 字符串	源 IP 地址。
sourcePort 字符串	源端口，范围 1-65535。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

使用的 SDK 方法为 path_trace.PathTrace.deletes_pathtrace_by_id_v1、path_trace.PathTrace.initiate_a_new_pathtrace_v1，
使用的路径为 post /dna/intent/api/v1/flow-analysis、delete /dna/intent/api/v1/flow-analysis/{flowAnalysisId}，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 路径追踪 InitiateANewPathtraceV1 文档: InitiateANewPathtraceV1 API 的完整参考。
Cisco DNA Center 路径追踪 DeletesPathtraceByIdV1 文档: DeletesPathtraceByIdV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.path_trace_v1:
    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}}"
    state: present
    controlPath: true
    destIP: string
    destPort: string
    inclusions:
    - string
    periodicRefresh: true
    protocol: string
    sourceIP: string
    sourcePort: string

- name: Delete by id
  cisco.dnac.path_trace_v1:
    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}}"
    state: absent
    flowAnalysisId: string

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回：始终示例： `{"response": {"flowAnalysisId": "字符串", "taskId": "字符串", "url": "字符串"}, "version": "字符串"}`

作者

Rafael Campos (@racampos)