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

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要更多要求才能使用此模块，详情请参见要求。

要在剧本中使用它，请指定：cisco.dnac.images_site_wise_product_names。

cisco.dnac 6.15.0 中的新增功能

概要 

此模块表示模块 images_site_wise_product_names_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"`
imageId 字符串	ImageId 路径参数。软件镜像标识符。请参考 `/dna/intent/api/v1/images` API 获取 `imageId`。
productNameOrdinal 浮点数	产品名称序号是每个网络设备产品的唯一值。
siteIds 列表 / 元素=字符串	需要分配此镜像的站点。参考 https://developer.cisco.com/docs/dna-center/#!sites。
validate_response_schema 布尔值	用于 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}，
需要注意的是，此模块是 images_site_wise_product_names_v1 的别名。
不支持 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 的完整参考。
思科 DNA Center 软件镜像管理 (SWIM) 更新网络设备产品名称分配给软件镜像 V1 的站点列表文档: UpdateTheListOfSitesForTheNetworkDeviceProductNameAssignedToTheSoftwareImageV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.images_site_wise_product_names:
    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:
    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:
    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 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回：始终示例： `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)