cisco.dnac.device_interface_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_interface_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有设备接口 V1。

  • 按 ID 获取设备接口 V1。

  • 返回所有可用的接口。此端点最多可以返回 500 个接口。

  • 返回给定接口 ID 的接口。

注意

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

字典

附加的头部。

id

字符串

Id 路径参数。接口 ID。

lastInputTime

字符串

LastInputTime 查询参数。最后输入时间。

lastOutputTime

字符串

LastOutputTime 查询参数。最后输出时间。

limit

整数

Limit 查询参数。

offset

整数

Offset 查询参数。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 devices.Devices.get_all_interfaces_v1、devices.Devices.get_interface_by_id_v1,

  • 使用的路径为 get /dna/intent/api/v1/interface、get /dna/intent/api/v1/interface/{id},

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 设备 GetAllInterfacesV1 文档

GetAllInterfacesV1 API 的完整参考。

Cisco DNA Center 设备 GetInterfaceByIdV1 文档

GetInterfaceByIdV1 API 的完整参考。

示例

- name: Get all Device Interface V1
  cisco.dnac.device_interface_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}}"
    offset: 0
    limit: 0
    lastInputTime: string
    lastOutputTime: string
  register: result

- name: Get Device Interface V1 by id
  cisco.dnac.device_interface_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
  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)