cisco.dnac.discovery_job_v1_info 模块 – 发现作业 V1 信息模块

注意

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

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

要安装它,请使用: ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,有关详细信息,请参见 要求

要在剧本中使用它,请指定: cisco.dnac.discovery_job_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有发现作业 V1。

  • 按 ID 获取发现作业 V1。

  • 返回给定发现 ID 的发现作业列表。结果可以根据 IP 选项进行过滤。可以使用“按范围获取发现”API 获取发现 ID。

  • 返回给定 IP 的发现作业列表。

注意

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

要求

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

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

headers

字典

附加的报头。

id

字符串

Id 路径参数。发现 ID。

ipAddress

字符串

IpAddress 查询参数。

limit

整数

Limit 查询参数。

name

字符串

Name 查询参数。

offset

整数

Offset 查询参数。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 discovery.Discovery.get_discovery_jobs_by_ip_v1、discovery.Discovery.get_list_of_discoveries_by_discovery_id_v1,

  • 使用的路径是 get /dna/intent/api/v1/discovery/job、get /dna/intent/api/v1/discovery/{id}/job,

  • 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 的 GetDiscoveryJobsByIPV1 发现文档

GetDiscoveryJobsByIPV1 API 的完整参考。

Cisco DNA Center 的 GetListOfDiscoveriesByDiscoveryIdV1 发现文档

GetListOfDiscoveriesByDiscoveryIdV1 API 的完整参考。

示例

- name: Get all Discovery Job V1
  cisco.dnac.discovery_job_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}}"
    offset: 0
    limit: 0
    ipAddress: string
    name: string
  register: result

- name: Get Discovery Job V1 by id
  cisco.dnac.discovery_job_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}}"
    offset: 0
    limit: 0
    ipAddress: string
    id: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回值:始终

示例: {"response": [{"attributeInfo": {}, "cliStatus": "string", "discoveryStatus": "string", "endTime": "string", "httpStatus": "string", "id": "string", "inventoryCollectionStatus": "string", "inventoryReachabilityStatus": "string", "ipAddress": "string", "jobStatus": "string", "name": "string", "netconfStatus": "string", "pingStatus": "string", "snmpStatus": "string", "startTime": "string", "taskId": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)