cisco.dnac.device_details_v1_info 模块 – 设备详细信息 V1 信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有设备详细信息 V1。

  • 返回通过 MAC 地址、设备名称或 UUID 在任何给定时间点检索到的详细网络设备信息。

注意

此模块具有相应的 action 插件

要求

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

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

headers

字典

附加头。

identifier

字符串

标识符查询参数。“macAddress”、“nwDeviceName”、“uuid”(不区分大小写)中的一个。

searchBy

字符串

SearchBy 查询参数。网络设备的 MAC 地址、设备名称或 UUID。

timestamp

浮点数

时间戳查询参数。以毫秒为单位的设备数据的 UTC 时间戳。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

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

  • 使用的路径是 get /dna/intent/api/v1/device-detail,

  • 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 设备 GetDeviceDetailV1 文档

GetDeviceDetailV1 API 的完整参考。

示例

- name: Get all Device Details V1
  cisco.dnac.device_details_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}}"
    timestamp: 0
    identifier: string
    searchBy: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"HALastResetReason": "字符串", "adminState": "字符串", "airQuality": "字符串", "airQualityScore": 0, "apGroup": "字符串", "apType": "字符串", "avgTemperature": 0, "collectionStatus": "字符串", "communicationState": "字符串", "connectedTime": "字符串", "connectivityStatus": 0, "cpu": 0, "cpuScore": 0, "deviceGroupHierarchyId": "字符串", "deviceSeries": "字符串", "ethernetMac": "字符串", "featureFlagList": ["字符串"], "flexGroup": "字符串", "freeMbuf": 0, "freeMbufScore": 0, "freeTimer": 0, "freeTimerScore": 0, "haStatus": "字符串", "homeApEnabled": "字符串", "icapCapability": "字符串", "interference": "字符串", "interferenceScore": 0, "ip_addr_managementIpAddr": "字符串", "lastBootTime": 0, "ledFlashEnabled": "字符串", "ledFlashSeconds": "字符串", "location": "字符串", "macAddress": "字符串", "maintenanceMode": true, "managementIpAddr": "字符串", "maxTemperature": 0, "memory": "字符串", "memoryScore": 0, "mode": "字符串", "noise": "字符串", "noiseScore": 0, "nwDeviceFamily": "字符串", "nwDeviceId": "字符串", "nwDeviceName": "字符串", "nwDeviceRole": "字符串", "nwDeviceType": "字符串", "opState": "字符串", "osType": "字符串", "overallHealth": 0, "packetPool": 0, "packetPoolScore": 0, "platformId": "字符串", "policyTagName": "字符串", "powerCalendarProfile": "字符串", "powerMode": "字符串", "powerProfile": "字符串", "powerSaveMode": "字符串", "powerSaveModeCapable": "字符串", "powerType": "字符串", "protocol": "字符串", "redundancyMode": "字符串", "redundancyPeerState": "字符串", "redundancyPeerStateDerived": "字符串", "redundancyState": "字符串", "redundancyStateDerived": "字符串", "regulatoryDomain": "字符串", "resetReason": "字符串", "rfTagName": "字符串", "ringStatus": true, "serialNumber": "字符串", "siteHierarchyGraphId": "字符串", "siteTagName": "字符串", "softwareVersion": "字符串", "stackType": "字符串", "subMode": "字符串", "tagIdList": [{}], "timestamp": 0, "upTime": "字符串", "utilization": "字符串", "utilizationScore": 0, "wqe": 0, "wqeScore": 0}

作者

  • Rafael Campos (@racampos)