cisco.dnac.sda_provision_devices_info 模块 – SDA 设备配置信息信息模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

  • 此模块代表模块 sda_provision_devices_v1_info 的别名

注意

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

需求

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

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

limit

浮点数

Limit 查询参数。要返回的最大设备数。

networkDeviceId

字符串

NetworkDeviceId 查询参数。网络设备的 ID。

offset

浮点数

Offset 查询参数。分页的起始记录。

siteId

字符串

SiteId 查询参数。站点层次结构的 ID。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用针对 JSON 架构的请求主体的验证。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法为 sda.Sda.get_provisioned_devices_v1,

  • 使用的路径为 get /dna/intent/api/v1/sda/provisionDevices,

  • 需要注意的是,此模块是 sda_provision_devices_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center SDA GetProvisionedDevicesV1 文档

GetProvisionedDevicesV1 API 的完整参考。

示例

- name: Get all Sda Provision Devices Info
  cisco.dnac.sda_provision_devices_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
    networkDeviceId: string
    siteId: string
    offset: 0
    limit: 0
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"response": [{"id": "string", "networkDeviceId": "string", "siteId": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)