cisco.dnac.network_device_export_v1 模块 – 网络设备导出 V1 的资源模块

注意

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

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

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

要在 Playbook 中使用它,请指定:cisco.dnac.network_device_export_v1

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源网络设备导出 V1 的创建操作。

  • 将选定的网络设备导出到文件。

注意

此模块有一个相应的 操作插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceUuids

list / elements=string

设备 UUID 列表。

dnac_debug

boolean

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

选择

  • false ←(默认)

  • true

dnac_host

string / required

Cisco DNA Center 主机名。

dnac_password

string

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

dnac_port

integer

Cisco DNA Center 端口。

默认: 443

dnac_username

别名:user

string

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

默认: "admin"

dnac_verify

boolean

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

选择

  • false

  • true ←(默认)

dnac_version

string

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

默认: "2.3.7.6"

operationEnum

string

0 表示导出设备凭据详细信息,或 1 表示导出设备详细信息。

parameters

list / elements=string

需要导出到文件的设备参数列表。

password

string

当 operationEnum 值为 0 时,密码是必需的。

validate_response_schema

boolean

Cisco DNA Center SDK 启用针对 JSON 模式验证请求正文的标志。

选择

  • false

  • true ←(默认)

备注

注意

  • 使用的 SDK 方法是 devices.Devices.export_device_list_v1,

  • 使用的路径是 post /dna/intent/api/v1/network-device/file,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关设备 ExportDeviceListV1 的 Cisco DNA Center 文档

ExportDeviceListV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.network_device_export_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}}"
    deviceUuids:
    - string
    operationEnum: string
    parameters:
    - string
    password: string

返回值

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

描述

dnac_response

dictionary

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

返回: 总是

示例: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)