cisco.dnac.network_device_interface_poe_v1_info 模块 – 网络设备接口 Poe V1 信息模块

注意

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

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

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

要在剧本中使用它,请指定: cisco.dnac.network_device_interface_poe_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有网络设备接口 Poe V1。

  • 返回设备的 POE 接口详细信息,其中 deviceuuid 是必需的,并接受逗号分隔的接口名称(可选),并返回该特定接口的信息,其中 operStatus = operationalStatus。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceUuid

字符串

DeviceUuid 路径参数。设备的 UUID。

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

字典

附加标头。

interfaceNameList

字符串

InterfaceNameList 查询参数。逗号分隔的接口名称。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

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

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 设备 ReturnsPOEInterfaceDetailsForTheDeviceV1 文档

ReturnsPOEInterfaceDetailsForTheDeviceV1 API 的完整参考。

示例

- name: Get all Network Device Interface Poe V1
  cisco.dnac.network_device_interface_poe_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}}"
    interfaceNameList: string
    deviceUuid: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回: 始终

示例: {"response": [{"adminStatus": "string", "allocatedPower": "string", "interfaceName": "string", "maxPortPower": "string", "operStatus": "string", "portPowerDrawn": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)