cisco.dnac.network_device_image_updates_v1_info 模块 – 网络设备镜像更新 V1 信息模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要

  • 获取所有网络设备镜像更新 V1。

  • 根据给定的筛选条件返回网络设备镜像更新列表。

注意

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

要求

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

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

endTime

浮点数

EndTime 查询参数。镜像更新在给定时间之前启动(自 UNIX 纪元以来的毫秒数)。

headers

字典

附加的头部。

hostName

字符串

HostName 查询参数。镜像更新的网络设备的主机名。支持不区分大小写的部分搜索。

id

字符串

Id 查询参数。在 parentId 下每个网络设备的唯一更新 ID。

imageName

字符串

ImageName 查询参数。更新的软件镜像名称。

limit

浮点数

Limit 查询参数。此页要显示的记录数。

managementAddress

字符串

ManagementAddress 查询参数。网络设备的管理地址。

networkDeviceId

字符串

NetworkDeviceId 查询参数。网络设备 ID。

offset

浮点数

Offset 查询参数。此页要显示的第一条记录;第一条记录编号为 1。

order

字符串

Order 查询参数。是否应使用升序或降序排列来排序响应。

parentId

字符串

ParentId 查询参数。具有此父 ID 的更新。

sortBy

字符串

SortBy 查询参数。响应中要排序的属性。

startTime

浮点数

StartTime 查询参数。镜像更新在给定时间之后启动(自 UNIX 纪元以来的毫秒数)。

status

字符串

Status 查询参数。镜像更新的状态。可用值 FAILURE、SUCCESS、IN_PROGRESS、PENDING。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

注释

注意

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

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 软件镜像管理 (SWIM) GetNetworkDeviceImageUpdatesV1 文档

GetNetworkDeviceImageUpdatesV1 API 的完整参考。

示例

- name: Get all Network Device Image Updates V1
  cisco.dnac.network_device_image_updates_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}}"
    id: string
    parentId: string
    networkDeviceId: string
    status: string
    imageName: string
    hostName: string
    managementAddress: string
    startTime: 0
    endTime: 0
    sortBy: string
    order: string
    offset: 0
    limit: 0
  register: result

返回值

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

描述

dnac_response

字典

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

返回: 始终

示例: {"response": [{"endTime": 0, "hostName": "string", "id": "string", "managementAddress": "string", "networkDeviceId": "string", "parentId": "string", "startTime": 0, "status": "string", "type": "string", "updateImageVersion": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)