cisco.dnac.sda_port_channels_v1_info 模块 – 用于 Sda 端口通道 V1 的信息模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新功能

概要

  • 获取所有 Sda 端口通道 V1。

  • 返回与提供的查询参数匹配的端口通道列表。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

connectedDeviceType

字符串

ConnectedDeviceType 查询参数。端口通道的连接设备类型。允许的值为 TRUNK、EXTENDED_NODE。

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"

fabricId

字符串

FabricId 查询参数。设备分配到的 fabric 的 ID。

headers

字典

其他标头。

limit

浮点数

Limit 查询参数。要返回的最大记录数。

networkDeviceId

字符串

NetworkDeviceId 查询参数。网络设备的 ID。

offset

浮点数

Offset 查询参数。分页的起始记录。

portChannelName

字符串

PortChannelName 查询参数。端口通道的名称。

validate_response_schema

布尔值

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

选项

  • false

  • true ←(默认)

备注

注意

  • 使用的 SDK 方法是 sda.Sda.get_port_channels_v1,

  • 使用的路径是 get /dna/intent/api/v1/sda/portChannels,

  • 支持 check_mode

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

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

另请参阅

另请参阅

SDA GetPortChannelsV1 的 Cisco DNA Center 文档

GetPortChannelsV1 API 的完整参考。

示例

- name: Get all Sda Port Channels V1
  cisco.dnac.sda_port_channels_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}}"
    fabricId: string
    networkDeviceId: string
    portChannelName: string
    connectedDeviceType: string
    offset: 0
    limit: 0
  register: result

返回值

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

描述

dnac_response

字典

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

返回: 总是

示例: {"response": [{"connectedDeviceType": "string", "description": "string", "fabricId": "string", "id": "string", "interfaceNames": ["string"], "networkDeviceId": "string", "portChannelName": "string", "protocol": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)