cisco.dnac.swim_trigger_distribution_v1 模块 – Swim Trigger Distribution V1 的资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.dnac.swim_trigger_distribution_v1。

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源 Swim Trigger Distribution V1 的创建操作。

  • 在给定设备上分发软件映像。软件映像必须先成功导入到 DNA 中心，然后才能分发。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

payload

list / elements=dictionary

Swim Trigger Distribution 的有效负载。

deviceUuid

string

Swim Trigger Distribution 的 deviceUuid。

imageUuid

string

Swim Trigger Distribution 的 imageUuid。

validate_response_schema

boolean

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 software_image_management_swim.SoftwareImageManagementSwim.trigger_software_image_distribution_v1,

  • 使用的路径是 post /dna/intent/api/v1/image/distribution,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关软件映像管理 (SWIM) TriggerSoftwareImageDistributionV1 的 Cisco DNA 中心文档

TriggerSoftwareImageDistributionV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.swim_trigger_distribution_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}}"
    payload:
    - deviceUuid: string
      imageUuid: string

返回值

通用返回值记录在此处，以下是此模块特有的字段

键

描述

dnac_response

dictionary

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

已返回: 始终

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

作者

  • Rafael Campos (@racampos)