cisco.dnac.network_device_equipment_info 模块 – 网络设备设备信息信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块network_device_equipment_v1_info的别名。

注意

此模块具有相应的 action插件

需求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceUuid

字符串

DeviceUuid路径参数。

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"

headers

字典

附加头。

type

字符串

类型查询参数。类型值可以是电源、风扇、机箱、背板、模块、处理器、其他、SFP。如果未提及类型,则会为设备获取所有设备。

validate_response_schema

布尔值

用于Cisco DNA Center SDK以启用根据JSON模式验证请求主体的标志。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的SDK方法是devices.Devices.get_the_details_of_physical_components_of_the_given_device_v1,

  • 使用的路径是get /dna/intent/api/v1/network-device/{deviceUuid}/equipment,

  • 需要注意的是,此模块是network_device_equipment_v1_info的别名。

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center文档,了解Devices GetTheDetailsOfPhysicalComponentsOfTheGivenDeviceV1

GetTheDetailsOfPhysicalComponentsOfTheGivenDeviceV1 API的完整参考。

示例

- name: Get all Network Device Equipment Info
  cisco.dnac.network_device_equipment_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}}"
    type: string
    deviceUuid: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"response": [{"description": "string", "instanceUuid": "string", "manufacturer": "string", "name": "string", "operationalStateCode": "string", "productId": "string", "serialNumber": "string", "vendorEquipmentType": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)