cisco.dnac.images_site_wise_product_names_v1 模块 – 图像站点产品名称 V1 的资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要 

管理资源“图像站点产品名称 V1”的创建、更新和删除操作。
为给定的图像标识符分配网络设备产品名称和站点。有关获取 imageId 的信息，请参阅 `/dna/intent/api/v1/images` API。
此 API 从给定软件映像的所有站点取消分配网络设备产品名称。
更新分配给软件映像的网络设备产品名称的站点列表。有关获取 `imageId` 和 `productNameOrdinal` 的信息，请参阅 `/dna/intent/api/v1/images` 和 `/dna/intent/api/v1/images/{imageId}/siteWiseProductNames` GET API。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
dnac_debug boolean	用于启用调试的 Cisco DNA Center SDK 标志。选项 `false` ← (默认) `true`
dnac_host string / 必需	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"`
imageId string	ImageId 路径参数。软件映像标识符。有关获取 `imageId` 的信息，请参阅 `/dna/intent/api/v1/images` API。
productNameOrdinal float	产品名称序号是每个网络设备产品的唯一值。
siteIds list / elements=string	需要分配此映像的站点。参考 https://developer.cisco.com/docs/dna-center/#!sites。
validate_response_schema boolean	用于启用 Cisco DNA Center SDK 验证请求正文与 JSON 模式的标志。选项 `false` `true` ← (默认)

注释 

注意

使用的 SDK 方法为 software_image_management_swim.SoftwareImageManagementSwim.assign_network_device_product_name_to_the_given_software_image_v1, software_image_management_swim.SoftwareImageManagementSwim.unassign_network_device_product_name_from_the_given_software_image_v1, software_image_management_swim.SoftwareImageManagementSwim.update_the_list_of_sites_for_the_network_device_product_name_assigned_to_the_software_image_v1,
使用的路径为 post /dna/intent/api/v1/images/{imageId}/siteWiseProductNames, delete /dna/intent/api/v1/images/{imageId}/siteWiseProductNames/{productNameOrdinal}, put /dna/intent/api/v1/images/{imageId}/siteWiseProductNames/{productNameOrdinal},
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 关于软件映像管理 (SWIM) AssignNetworkDeviceProductNameToTheGivenSoftwareImageV1 的文档: AssignNetworkDeviceProductNameToTheGivenSoftwareImageV1 API 的完整参考。
Cisco DNA Center 关于软件映像管理 (SWIM) UnassignNetworkDeviceProductNameFromTheGivenSoftwareImageV1 的文档: UnassignNetworkDeviceProductNameFromTheGivenSoftwareImageV1 API 的完整参考。
Cisco DNA Center 关于软件映像管理 (SWIM) UpdateTheListOfSitesForTheNetworkDeviceProductNameAssignedToTheSoftwareImageV1 的文档: UpdateTheListOfSitesForTheNetworkDeviceProductNameAssignedToTheSoftwareImageV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.images_site_wise_product_names_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}}"
    state: present
    imageId: string
    productNameOrdinal: 0
    siteIds:
    - string

- name: Delete by name
  cisco.dnac.images_site_wise_product_names_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}}"
    state: absent
    imageId: string
    productNameOrdinal: 0

- name: Update by name
  cisco.dnac.images_site_wise_product_names_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}}"
    state: present
    imageId: string
    productNameOrdinal: 0
    siteIds:
    - string

返回值 

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

键	描述
dnac_response dictionary	包含 Cisco DNAC Python SDK 返回的响应的字典或列表已返回: 总是示例: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)