cisco.dnac.interface_network_device_range_info 模块 – 接口网络设备范围信息的 Information 模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 interface_network_device_range_v1_info 的别名

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceId

字符串

DeviceId 路径参数。设备 ID。

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

字典

附加标头。

recordsToReturn

整数

RecordsToReturn 路径参数。要返回的记录数。

startIndex

整数

StartIndex 路径参数。起始索引。

validate_response_schema

布尔值

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

选择

  • false

  • true ←(默认)

注释

注意

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

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

  • 应注意,此模块是 interface_network_device_range_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解设备 GetDeviceInterfacesBySpecifiedRangeV1

GetDeviceInterfacesBySpecifiedRangeV1 API 的完整参考。

示例

- name: Get all Interface Network Device Range Info
  cisco.dnac.interface_network_device_range_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}}"
    deviceId: string
    startIndex: 0
    recordsToReturn: 0
  register: result

返回值

通用返回值记录在此处,以下是此模块独有的字段

描述

dnac_response

字典

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

已返回:始终

示例: {"response": [{"addresses": [{"address": {"ipAddress": {"address": "字符串"}, "ipMask": {"address": "字符串"}, "isInverseMask": true}, "type": "字符串"}], "adminStatus": "字符串", "className": "字符串", "description": "字符串", "deviceId": "字符串", "duplex": "字符串", "id": "字符串", "ifIndex": "字符串", "instanceTenantId": "字符串", "instanceUuid": "字符串", "interfaceType": "字符串", "ipv4Address": "字符串", "ipv4Mask": "字符串", "isisSupport": "字符串", "lastIncomingPacketTime": 0, "lastOutgoingPacketTime": 0, "lastUpdated": "字符串", "macAddress": "字符串", "mappedPhysicalInterfaceId": "字符串", "mappedPhysicalInterfaceName": "字符串", "mediaType": "字符串", "mtu": "字符串", "name": "字符串", "nativeVlanId": "字符串", "ospfSupport": "字符串", "pid": "字符串", "portMode": "字符串", "portName": "字符串", "portType": "字符串", "serialNo": "字符串", "series": "字符串", "speed": "字符串", "status": "字符串", "vlanId": "字符串", "voiceVlan": "字符串"}], "version": "字符串"}

作者

  • Rafael Campos (@racampos)