cisco.dnac.images_site_wise_product_names_info 模块 – 镜像站点产品名称信息的信息模块
注意
此模块是 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_info
。
cisco.dnac 6.15.0 中的新增功能
概要
此模块表示模块 images_site_wise_product_names_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
已分配的查询参数。使用已分配/未分配进行筛选,`ASSIGNED` 选项将筛选与给定镜像关联的网络设备产品。`NOT_ASSIGNED` 选项将筛选尚未与给定镜像关联但适用于该镜像的网络设备产品。可用值:ASSIGNED、NOT_ASSIGNED。 |
|
Cisco DNA Center SDK 启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认值: |
|
附加标头。 |
|
ImageId 路径参数。软件镜像标识符。请参阅 `/dna/intent/api/v1/images` API 以获取 `imageId`。 |
|
限制查询参数。此页面要显示的记录数。最小值和最大值分别为 1 和 500。 |
|
偏移量查询参数。此页面要显示的第一个记录;第一个记录编号为 1。最小值为 1。 |
|
ProductId 查询参数。使用产品 ID (PID) 进行筛选。 |
|
ProductName 查询参数。使用网络设备产品名称进行筛选。支持部分大小写不敏感搜索。搜索至少需要 3 个字符。 |
|
推荐查询参数。使用推荐来源进行筛选。如果 `CISCO` 则表示分配的网络设备产品是由 Cisco 推荐的,如果 `USER` 则表示用户手动分配的。可用值:CISCO、USER。 |
|
Cisco DNA Center SDK 用于启用针对 JSON 模式验证请求正文的标志。 选项
|
注释
注意
使用的 SDK 方法为 software_image_management_swim.SoftwareImageManagementSwim.retrieves_network_device_product_names_assigned_to_a_software_image_v1
使用的路径为 get /dna/intent/api/v1/images/{imageId}/siteWiseProductNames
应注意,此模块是 images_site_wise_product_names_v1_info 的别名
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 关于软件镜像管理 (SWIM) RetrievesNetworkDeviceProductNamesAssignedToASoftwareImageV1 的文档
RetrievesNetworkDeviceProductNamesAssignedToASoftwareImageV1 API 的完整参考。
示例
- name: Get all Images Site Wise Product Names Info
cisco.dnac.images_site_wise_product_names_info:
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}}"
productName: string
productId: string
recommended: string
assigned: string
offset: 0
limit: 0
imageId: string
register: result
返回值
常见的返回值记录在 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应 已返回:始终 示例: |