cisco.dnac.images_v1_info 模块 – Images V1 的信息模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块,请参阅 要求 获取详细信息。

要在剧本中使用它,请指定:cisco.dnac.images_v1_info

cisco.dnac 6.15.0 中的新增功能

概要

  • 获取所有 Images V1。

  • 提供了指定站点的可用映像列表。站点的默认值设置为全局。该列表包括已导入到磁盘上的映像,以及来自 Cisco.com 的最新和建议的映像。

注意

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

要求

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

  • 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"

golden

布尔值

Golden 查询参数。设置为 `true` 时,它将检索标记为 golden 的映像。设置为 `false` 时,它将检索标记为未标记为 golden 的映像。

选择

  • false

  • true

hasAddonImages

布尔值

HasAddonImages 查询参数。设置为 `true` 时,它将检索具有附加映像的映像。设置为 `false` 时,它将检索不具有附加映像的映像。

选择

  • false

  • true

headers

字典

附加标头。

imported

布尔值

Imported 查询参数。当值设置为 `true` 时,它将包括物理导入的映像。相反,当值设置为 `false` 时,它将包括来自云的映像记录。云映像的标识符可用于将映像从 Cisco.com 下载到磁盘。

选择

  • false

  • true

integrity

字符串

Integrity 查询参数。使用完整性验证可用值 UNKNOWN、VERIFIED 筛选经过验证的映像。

isAddonImages

布尔值

IsAddonImages 查询参数。设置为 `true` 时,它将检索作为附加映像的映像。设置为 `false` 时,它将检索不作为附加映像的映像。

选择

  • false

  • true

limit

浮点数

Limit 查询参数。此页面要显示的记录数。最小值和最大值分别为 1 和 500。

name

字符串

Name 查询参数。使用软件映像或附加名称进行筛选。支持部分不区分大小写的搜索。搜索需要至少 3 个字符。

offset

浮点数

Offset 查询参数。此页面要显示的第一个记录;第一个记录编号为 1。最小值为 1。

productNameOrdinal

浮点数

ProductNameOrdinal 查询参数。产品名称序号是每个网络设备产品的唯一值。`productNameOrdinal` 可以从 API `/dna/intent/api/v1/siteWiseProductNames` 的响应中获得。

siteId

字符串

SiteId 查询参数。站点标识符,用于获取站点下所有可用产品的列表。默认值为全局站点。有关 `siteId`,请参阅 https://developer.cisco.com/docs/dna-center/get-site。

supervisorProductNameOrdinal

浮点数

SupervisorProductNameOrdinal 查询参数。主管引擎模块序号是每个主管模块的唯一值。`supervisorProductNameOrdinal` 可以从 API `/dna/intent/api/v1/siteWiseProductNames` 的响应中获得。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求正文的标志。

选择

  • false

  • true ←(默认)

version

字符串

Version 查询参数。使用映像版本进行筛选。支持部分不区分大小写的搜索。搜索需要至少 3 个字符。

注意

注意

  • 使用的 SDK 方法是 software_image_management_swim.SoftwareImageManagementSwim.returns_list_of_software_images_v1,

  • 使用的路径是 get /dna/intent/api/v1/images,

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅

另请参阅

Cisco DNA Center 软件映像管理 (SWIM) 文档 ReturnsListOfSoftwareImagesV1

ReturnsListOfSoftwareImagesV1 API 的完整参考。

示例

- name: Get all Images V1
  cisco.dnac.images_v1_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

返回值

常见返回值已在这里记录,以下是此模块特有的字段

描述

dnac_response

字典

由 Cisco DNAC Python SDK 返回的响应的字典或列表

返回: 总是

示例: {"response": [{"ciscoLatest": true, "goldenTaggingDetails": [{"deviceRoles": ["string"], "deviceTags": ["string"], "inheritedSiteId": "string", "inheritedSiteName": "string"}], "hasAddonImages": true, "id": "string", "imageType": "string", "imported": true, "integrityStatus": "string", "isAddonImage": true, "isGoldenTagged": true, "name": "string", "productNames": [{"id": "string", "productName": "string", "productNameOrdinal": 0, "supervisorProductName": "string", "supervisorProductNameOrdinal": 0}], "recommended": "string", "version": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)