cisco.dnac.sda_layer2_virtual_networks_info 模块 – SDA 二层虚拟网络信息模块

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 需求 了解详情。

要在 playbook 中使用它，请指定： cisco.dnac.sda_layer2_virtual_networks_info。

cisco.dnac 6.15.0 中的新增功能

概要

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

注意

此模块具有相应的 action 插件。

需求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

associatedLayer3VirtualNetworkName

字符串

AssociatedLayer3VirtualNetworkName 查询参数。关联的 3 层虚拟网络的名称。

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 查询参数。分配二层虚拟网络的结构的 ID。

headers

字典

附加的报头。

id

字符串

Id 查询参数。二层虚拟网络的 ID。

limit

浮点数

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

offset

浮点数

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

trafficType

字符串

TrafficType 查询参数。二层虚拟网络的流量类型。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

vlanId

浮点数

VlanId 查询参数。二层虚拟网络的 VLAN ID。

vlanName

字符串

VlanName 查询参数。二层虚拟网络的 VLAN 名称。

注释

注意

  • 使用的 SDK 方法是 sda.Sda.get_layer2_virtual_networks_v1，

  • 使用的路径是 get /dna/intent/api/v1/sda/layer2VirtualNetworks，

  • 需要注意的是，此模块是 sda_layer2_virtual_networks_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center SDA GetLayer2VirtualNetworksV1 文档

GetLayer2VirtualNetworksV1 API 的完整参考。

示例

- name: Get all Sda Layer2 Virtual Networks Info
  cisco.dnac.sda_layer2_virtual_networks_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
    fabricId: string
    vlanName: string
    vlanId: 0
    trafficType: string
    associatedLayer3VirtualNetworkName: string
    offset: 0
    limit: 0
  register: result

返回值

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

键

描述

dnac_response

字典

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

返回：始终

示例： {"response": [{"associatedLayer3VirtualNetworkName": "string", "fabricId": "string", "id": "string", "isFabricEnabledWireless": true, "trafficType": "string", "vlanId": 0, "vlanName": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)