cisco.dnac.images_count_v1_info 模块 – Images Count V1 的信息模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.images_count_v1_info

cisco.dnac 6.15.0 中的新增功能

概要

  • 获取所有 Images Count V1。

  • 返回给定 `siteId` 的软件映像计数。siteId 的默认值为 global。

注意

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

要求

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

  • 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 的映像。

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

name

字符串

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

productNameOrdinal

浮点数

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

siteId

字符串

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

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_count_of_software_images_v1。

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解软件映像管理 (SWIM) ReturnsCountOfSoftwareImagesV1

ReturnsCountOfSoftwareImagesV1 API 的完整参考。

示例

- name: Get all Images Count V1
  cisco.dnac.images_count_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: string
    integrity: string
    hasAddonImages: True
    isAddonImages: True
  register: result

返回值

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

描述

dnac_response

字典

一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应

已返回: 始终

示例: {"response": {"count": 0}, "version": "string"}

作者

  • Rafael Campos (@racampos)