cisco.dnac.sda_layer3_virtual_networks_v1 模块 – Sda Layer3 虚拟网络 V1 资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要

  • 管理 Sda Layer3 虚拟网络 V1 资源的创建、更新和删除操作。

  • 根据用户输入添加第 3 层虚拟网络。

  • 根据用户输入删除第 3 层虚拟网络。

  • 根据用户输入更新第 3 层虚拟网络。

注意

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

要求

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

  • 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"

payload

列表 / 元素=字典

Sda Layer3 虚拟网络的有效负载。

anchoredSiteId

字符串

此第 3 层虚拟网络要锚定的结构站点结构 ID。

fabricIds

列表 / 元素=字符串

此第 3 层虚拟网络要分配到的结构的 ID。

virtualNetworkName

字符串

第 3 层虚拟网络的名称。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

virtualNetworkName

字符串

VirtualNetworkName 查询参数。第 3 层虚拟网络的名称。

备注

注意

  • 使用的 SDK 方法是 sda.Sda.add_layer3_virtual_networks_v1、sda.Sda.delete_layer3_virtual_networks_v1、sda.Sda.update_layer3_virtual_networks_v1,

  • 使用的路径是 post /dna/intent/api/v1/sda/layer3VirtualNetworks、delete /dna/intent/api/v1/sda/layer3VirtualNetworks、put /dna/intent/api/v1/sda/layer3VirtualNetworks,

  • 不支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center SDA AddLayer3VirtualNetworksV1 文档

AddLayer3VirtualNetworksV1 API 的完整参考。

Cisco DNA Center SDA DeleteLayer3VirtualNetworksV1 文档

DeleteLayer3VirtualNetworksV1 API 的完整参考。

Cisco DNA Center SDA UpdateLayer3VirtualNetworksV1 文档

UpdateLayer3VirtualNetworksV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.sda_layer3_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:
    - anchoredSiteId: string
      fabricIds:
      - string
      virtualNetworkName: string

- name: Delete all
  cisco.dnac.sda_layer3_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
    virtualNetworkName: string

- name: Update all
  cisco.dnac.sda_layer3_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:
    - anchoredSiteId: string
      fabricIds:
      - string
      id: string
      virtualNetworkName: string

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)