cisco.dnac.device_configurations_export_v1 模块 – 用于设备配置导出 V1 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

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

  • 将设备配置导出到加密的 zip 文件。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceId

字符串

需要导出配置的设备的 UUID。

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"

password

字符串

用于保护导出配置的 zip 文件的密码。必须至少包含 8 个字符、一个小写字母、一个大写字母、一个数字和一个特殊字符(-=;,./~!@#$%^&*()_+{}| ?)。它可能不包含空格或字符 <>。

validate_response_schema

布尔值

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

选择

  • false

  • true ←(默认)

注释

注意

  • 使用的 SDK 方法为 configuration_archive.ConfigurationArchive.export_device_configurations_v1,

  • 使用的路径为 post /dna/intent/api/v1/network-device-archive/cleartext,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关配置存档 ExportDeviceConfigurationsV1 的 Cisco DNA Center 文档

ExportDeviceConfigurationsV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.device_configurations_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}}"
    deviceId: string
    password: string

返回值

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

描述

dnac_response

字典

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

已返回: 始终

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

作者

  • Rafael Campos (@racampos)