cisco.dnac.sda_layer2_virtual_networks_v1 模块 – Sda Layer2 虚拟网络 V1 资源模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.dnac.sda_layer2_virtual_networks_v1。

cisco.dnac 6.15.0 中的新增功能

摘要 

管理 Sda Layer2 虚拟网络 V1 资源的创建、更新和删除操作。
根据用户输入添加第 2 层虚拟网络。
根据 ID 删除第 2 层虚拟网络。
根据用户输入删除第 2 层虚拟网络。
根据用户输入更新第 2 层虚拟网络。

注意

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

要求 

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

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 查询参数。分配第 2 层虚拟网络的结构的 ID。
id 字符串	Id 路径参数。第 2 层虚拟网络的 ID。
payload 列表 / 元素=字典	Sda Layer2 虚拟网络的有效负载。
associatedLayer3VirtualNetworkName 字符串	与第 2 层虚拟网络关联的第 3 层虚拟网络的名称。提供此字段是为了支持与虚拟网络锚定相关的请求。在关联之前，必须已将第 3 层虚拟网络添加到结构。此字段必须存在于所有有效负载元素中或不存在于任何元素中。
fabricId 字符串	此第 2 层虚拟网络要分配到的结构的 ID。
isFabricEnabledWireless 布尔值	设置为 true 以启用无线。默认值为 false。选项 `false` `true`
trafficType 字符串	服务的流量类型。
vlanId 整数	第 2 层虚拟网络的 VLAN 的 ID。允许的 VLAN 范围是 2-4093，但保留的 VLAN 1002-1005 和 2046 除外。如果部署在结构区域上，则此 vlanId 必须与结构站点上相应的第 2 层虚拟网络的 vlanId 匹配。
vlanName 字符串	第 2 层虚拟网络的 VLAN 的名称。只能包含字母数字字符、下划线和连字符。
trafficType 字符串	TrafficType 查询参数。第 2 层虚拟网络的流量类型。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用针对 JSON 架构验证请求主体的标志。选项 `false` `true` ← (默认)
vlanId 浮点数	VlanId 查询参数。第 2 层虚拟网络的 VLAN ID。
vlanName 字符串	VlanName 查询参数。第 2 层虚拟网络的 VLAN 名称。

注释 

注意

使用的 SDK 方法是 sda.Sda.add_layer2_virtual_networks_v1、sda.Sda.delete_layer2_virtual_network_by_id_v1、sda.Sda.update_layer2_virtual_networks_v1，
使用的路径是 post /dna/intent/api/v1/sda/layer2VirtualNetworks、delete /dna/intent/api/v1/sda/layer2VirtualNetworks、delete /dna/intent/api/v1/sda/layer2VirtualNetworks/{id}、put /dna/intent/api/v1/sda/layer2VirtualNetworks，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center SDA AddLayer2VirtualNetworksV1 文档: AddLayer2VirtualNetworksV1 API 的完整参考。
Cisco DNA Center SDA DeleteLayer2VirtualNetworkByIdV1 文档: DeleteLayer2VirtualNetworkByIdV1 API 的完整参考。
Cisco DNA Center SDA DeleteLayer2VirtualNetworksV1 文档: DeleteLayer2VirtualNetworksV1 API 的完整参考。
Cisco DNA Center SDA UpdateLayer2VirtualNetworksV1 文档: UpdateLayer2VirtualNetworksV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.sda_layer2_virtual_networks_v1:
    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}}"
    state: present
    payload:
    - associatedLayer3VirtualNetworkName: string
      fabricId: string
      isFabricEnabledWireless: true
      trafficType: string
      vlanId: 0
      vlanName: string

- name: Delete all
  cisco.dnac.sda_layer2_virtual_networks_v1:
    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}}"
    state: absent
    associatedLayer3VirtualNetworkName: string
    fabricId: string
    trafficType: string
    vlanId: 0
    vlanName: string

- name: Update all
  cisco.dnac.sda_layer2_virtual_networks_v1:
    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}}"
    state: present
    payload:
    - associatedLayer3VirtualNetworkName: string
      fabricId: string
      id: string
      isFabricEnabledWireless: true
      trafficType: string
      vlanId: 0
      vlanName: string

- name: Delete by id
  cisco.dnac.sda_layer2_virtual_networks_v1:
    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}}"
    state: absent
    id: string

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回：始终示例： `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)