cisco.dnac.configuration_template_deploy_v1 模块 – 配置模板部署 V1 资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源配置模板部署 V1 的创建操作。

  • 部署模板的 API。

注意

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

要求

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

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

forcePushTemplate

布尔值

ForcePushTemplate 标志。

选项

  • false

  • true

isComposite

布尔值

复合模板标志。

选项

  • false

  • true

mainTemplateId

字符串

版本化模板的主模板 UUID。

memberTemplateDeploymentInfo

列表 / 元素=字符串

MemberTemplateDeploymentInfo。

targetInfo

列表 / 元素=字典

配置模板部署的 targetInfo。

hostName

字符串

如果 targetType 为 MANAGED_DEVICE_HOSTNAME,则需要设备的主机名。

id

字符串

如果 targetType 为 MANAGED_DEVICE_UUID,则需要目标的 UUID。

params

字典

要配置的模板参数/值。

resourceParams

列表 / 元素=字符串

要配置的资源参数。有关使用详情,请参阅功能页面。

type

字符串

设备的目标类型。

versionedTemplateId

字符串

要配置的版本化模板 UUID。

templateId

字符串

要配置的模板的 UUID。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 configuration_templates.ConfigurationTemplates.deploy_template_v1,

  • 使用的路径为 post /dna/intent/api/v1/template-programmer/template/deploy,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 配置模板 DeployTemplateV1 文档

DeployTemplateV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.configuration_template_deploy_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}}"
    forcePushTemplate: true
    isComposite: true
    mainTemplateId: string
    memberTemplateDeploymentInfo:
    - string
    targetInfo:
    - hostName: string
      id: string
      params: {}
      resourceParams:
      - string
      type: string
      versionedTemplateId: string
    templateId: string

返回值

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

描述

dnac_response

字典

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

返回: 始终

示例: {"deploymentId": "字符串", "deploymentName": "字符串", "devices": [{"detailedStatusMessage": "字符串", "deviceId": "字符串", "duration": "字符串", "endTime": "字符串", "identifier": "字符串", "ipAddress": "字符串", "name": "字符串", "startTime": "字符串", "status": "字符串", "targetType": "字符串"}], "duration": "字符串", "endTime": "字符串", "projectName": "字符串", "startTime": "字符串", "status": "字符串", "statusMessage": "字符串", "templateName": "字符串", "templateVersion": "字符串"}

作者

  • Rafael Campos (@racampos)