cisco.dnac.images_info 模块 – 图像信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,有关详细信息,请参见 要求。
要在 playbook 中使用它,请指定:cisco.dnac.images_info
。
cisco.dnac 6.15.0 中的新增功能
概要
此模块代表模块 images_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用于 Cisco DNA Center SDK 以启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值: |
|
Golden 查询参数。设置为 `true` 时,它将检索标记为已标记为黄金的镜像。设置为 `false` 时,它将检索标记为未标记为黄金的镜像。 选项
|
|
HasAddonImages 查询参数。设置为 `true` 时,它将检索具有附加镜像的镜像。设置为 `false` 时,它将检索没有附加镜像的镜像。 选项
|
|
附加标头。 |
|
Imported 查询参数。当值为 `true` 时,它将包含物理导入的镜像。相反,当值为 `false` 时,它将包含来自云的镜像记录。云镜像的标识符可用于从 Cisco.com 下载镜像到磁盘。 选项
|
|
Integrity 查询参数。使用已验证的镜像进行筛选,可用值 UNKNOWN、VERIFIED。 |
|
IsAddonImages 查询参数。设置为 `true` 时,它将检索作为附加镜像的镜像。设置为 `false` 时,它将检索不是附加镜像的镜像。 选项
|
|
Limit 查询参数。此页要显示的记录数。最小值和最大值分别为 1 和 500。 |
|
Name 查询参数。使用软件镜像或附加名称进行筛选。支持部分不区分大小写的搜索。搜索至少需要 3 个字符。 |
|
Offset 查询参数。此页要显示的第一条记录;第一条记录编号为 1。最小值为 1。 |
|
ProductNameOrdinal 查询参数。产品名称序数是每个网络设备产品的唯一值。ProductNameOrdinal 可从 API `/dna/intent/api/v1/siteWiseProductNames` 的响应中获取。 |
|
SiteId 查询参数。站点标识符,用于获取站点下所有可用产品的列表。默认值为全局站点。请参见 https //developer.cisco.com/docs/dna-center/get-site 获取 `siteId`。 |
|
SupervisorProductNameOrdinal 查询参数。主管引擎模块序数是每个主管模块的唯一值。`supervisorProductNameOrdinal` 可从 API `/dna/intent/api/v1/siteWiseProductNames` 的响应中获取。 |
|
用于 Cisco DNA Center SDK 的标志,用于根据 JSON 模式启用请求主体的验证。 选项
|
|
Version 查询参数。使用镜像版本进行筛选。支持部分不区分大小写的搜索。搜索至少需要 3 个字符。 |
备注
注意
使用的 SDK 方法为 software_image_management_swim.SoftwareImageManagementSwim.returns_list_of_software_images_v1,
使用的路径为 get /dna/intent/api/v1/images,
需要注意的是,此模块是 images_v1_info 的别名
支持
check_mode
插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
参见
另请参见
- Cisco DNA Center 文档,关于软件镜像管理 (SWIM) ReturnsListOfSoftwareImagesV1
ReturnsListOfSoftwareImagesV1 API 的完整参考。
示例
- name: Get all Images Info
cisco.dnac.images_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}}"
siteId: string
productNameOrdinal: 0
supervisorProductNameOrdinal: 0
imported: True
name: string
version: string
golden: True
integrity: string
hasAddonImages: True
isAddonImages: True
offset: 0
limit: 0
register: result
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
Cisco DNAC Python SDK 返回的响应的字典或列表 返回值:始终返回 示例: |