cisco.dnac.network_device_range_v1_info 模块 – 网络设备范围 V1 信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有网络设备范围 V1。

  • 返回给定分页范围内的网络设备列表。可以检索到的最大记录数为 500。

注意

此模块具有相应的 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

字典

附加的 header。

recordsToReturn

整数

RecordsToReturn 路径参数。要返回的记录数 1<= recordsToReturn <= 500。

startIndex

整数

StartIndex 路径参数。起始索引 >=1。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

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

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 设备 GetNetworkDeviceByPaginationRangeV1 文档

GetNetworkDeviceByPaginationRangeV1 API 的完整参考。

示例

- name: Get all Network Device Range V1
  cisco.dnac.network_device_range_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}}"
    startIndex: 0
    recordsToReturn: 0
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"response": [{"apEthernetMacAddress": "字符串", "apManagerInterfaceIp": "字符串", "associatedWlcIp": "字符串", "bootDateTime": "字符串", "collectionInterval": "字符串", "collectionStatus": "字符串", "description": "字符串", "deviceSupportLevel": "字符串", "dnsResolvedManagementAddress": "字符串", "errorCode": "字符串", "errorDescription": "字符串", "family": "字符串", "hostname": "字符串", "id": "字符串", "instanceTenantId": "字符串", "instanceUuid": "字符串", "interfaceCount": "字符串", "inventoryStatusDetail": "字符串", "lastDeviceResyncStartTime": "字符串", "lastUpdateTime": 0, "lastUpdated": "字符串", "lineCardCount": "字符串", "lineCardId": "字符串", "location": "字符串", "locationName": "字符串", "macAddress": "字符串", "managedAtleastOnce": true, "managementIpAddress": "字符串", "managementState": "字符串", "memorySize": "字符串", "pendingSyncRequestsCount": "字符串", "platformId": "字符串", "reachabilityFailureReason": "字符串", "reachabilityStatus": "字符串", "reasonsForDeviceResync": "字符串", "reasonsForPendingSyncRequests": "字符串", "role": "字符串", "roleSource": "字符串", "serialNumber": "字符串", "series": "字符串", "snmpContact": "字符串", "snmpLocation": "字符串", "softwareType": "字符串", "softwareVersion": "字符串", "tagCount": "字符串", "tunnelUdpPort": "字符串", "type": "字符串", "upTime": "字符串", "uptimeSeconds": 0, "vendor": "字符串", "waasDeviceMode": "字符串"}], "version": "字符串"}

作者

  • Rafael Campos (@racampos)