cisco.dnac.swim_trigger_activation 模块 – Swim 触发激活的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 swim_trigger_activation_v1 的别名

注意

此模块具有相应的 action 插件。

要求 

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

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 字典	其他标头。
payload 列表 / 元素=字典	Swim 触发激活的有效负载。
activateLowerImageVersion 布尔值	ActivateLowerImageVersion 标志。选择 `false` `true`
deviceUpgradeMode 字符串	Swim 触发激活的 deviceUpgradeMode。
deviceUuid 字符串	Swim 触发激活的 deviceUuid。
distributeIfNeeded 布尔值	DistributeIfNeeded 标志。选择 `false` `true`
imageUuidList 列表 / 元素=字符串	Swim 触发激活的 imageUuidList。
smuImageUuidList 列表 / 元素=字符串	Swim 触发激活的 smuImageUuidList。
scheduleValidate 布尔值	ScheduleValidate 查询参数。ScheduleValidate，在计划之前验证数据（可选）。选择 `false` `true`
validate_response_schema 布尔值	用于使 Cisco DNA Center SDK 能够根据 JSON 模式验证请求主体的标志。选择 `false` `true` ←（默认）

备注 

注意

使用的 SDK 方法是 software_image_management_swim.SoftwareImageManagementSwim.trigger_software_image_activation_v1，
使用的路径是 post /dna/intent/api/v1/image/activation/device，
应该注意的是，此模块是 swim_trigger_activation_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 文档，了解软件映像管理 (SWIM) TriggerSoftwareImageActivationV1: TriggerSoftwareImageActivationV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.swim_trigger_activation:
    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}}'
    payload:
    - activateLowerImageVersion: true
      deviceUpgradeMode: string
      deviceUuid: string
      distributeIfNeeded: true
      imageUuidList:
      - string
      smuImageUuidList:
      - string
    scheduleValidate: true

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表已返回：始终示例： `{"response": {"taskId": "字符串", "url": "字符串"}, "version": "字符串"}`

作者

Rafael Campos (@racampos)