cisco.dnac.sda_multicast_virtual_networks 模块 – SDA 多播虚拟网络资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要

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

注意

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

要求

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

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

id

字符串

ID 路径参数。多播配置的 ID。

payload

列表 / 元素=字典

SDA 多播虚拟网络的有效负载。

fabricId

字符串

此多播配置关联的结构站点 ID。

ipPoolName

字符串

与结构站点关联的 IP 池的名称。

ipv4SsmRanges

列表 / 元素=字符串

IPv4 源特定多播 (SSM) 范围。允许的范围是从 225.0.0.0/8 到 239.0.0.0/8。SSM 范围不应与为 ASM 多播提供的范围冲突。

multicastRPs

列表 / 元素=字典

SDA 多播虚拟网络的 multicastRPs。

ipv4Address

字符串

RP 的 IPv4 地址。对于外部 RP 配置，必须提供 ipv4Address 或 ipv6Address 中的一个。对于结构 RP，此地址由 SDA 分配，在 RP 创建请求期间不应提供，并且在后续请求中应保留 SDA 分配的地址。

ipv4AsmRanges

列表 / 元素=字符串

IPv4 任何源多播范围。给定多播 RP 将服务的 IPv4 多播组范围的逗号分隔列表。只能提供 IPv4 范围。对于结构 RP，可以一起提供 IPv4 和 IPv6 范围。对于外部 RP，应为 IPv4 外部 RP 提供 IPv4 范围，应为 IPv6 外部 RP 提供 IPv6 范围。

ipv6Address

字符串

RP 的 IPv6 地址。对于外部 RP 配置，必须提供 ipv4Address 或 ipv6Address 中的一个。对于结构 RP，此地址由 SDA 分配，在 RP 创建请求期间不应提供，并且在后续请求中应保留 SDA 分配的地址。Ipv6Address 只能用于具有双栈 (IPv4 + IPv6) 多播池的虚拟网络。

ipv6AsmRanges

列表 / 元素=字符串

IPv6 任何源多播范围。给定多播 RP 将服务的 IPv6 多播组范围的逗号分隔列表。只能提供 IPv6 范围。IPv6 范围只能用于双栈多播池。对于结构 RP，可以一起提供 IPv4 和 IPv6 范围。对于外部 RP，应为 IPv4 外部 RP 提供 IPv4 范围，应为 IPv6 外部 RP 提供 IPv6 范围。

isDefaultV4RP

布尔值

指定它是否为默认 IPv4 RP。

选项

  • false

  • true

isDefaultV6RP

布尔值

指定它是否为默认 IPv6 RP。

选项

  • false

  • true

networkDeviceIds

列表 / 元素=字符串

网络设备的 ID。这是结构 RP 的必填字段。结构站点最多可以有两个结构 RP，这些 RP 在所有多播虚拟网络中共享。要在结构站点中配置两个结构 RP，这两个设备都必须具有边界角色。在将结构边缘设备用作 RP 或使用双栈多播池的场景中，只能配置一个 RP。

rpDeviceLocation

字符串

RP 的设备位置。

virtualNetworkName

字符串

与 Fabric 站点关联的虚拟网络名称。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法为 sda.Sda.add_multicast_virtual_networks_v1、sda.Sda.delete_multicast_virtual_network_by_id_v1、sda.Sda.update_multicast_virtual_networks_v1。

  • 使用的路径为 post /dna/intent/api/v1/sda/multicast/virtualNetworks、delete /dna/intent/api/v1/sda/multicast/virtualNetworks/{id}、put /dna/intent/api/v1/sda/multicast/virtualNetworks。

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

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档，关于 SDA AddMulticastVirtualNetworksV1

AddMulticastVirtualNetworksV1 API 的完整参考。

Cisco DNA Center 文档，关于 SDA DeleteMulticastVirtualNetworkByIdV1

DeleteMulticastVirtualNetworkByIdV1 API 的完整参考。

Cisco DNA Center 文档，关于 SDA UpdateMulticastVirtualNetworksV1

UpdateMulticastVirtualNetworksV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.sda_multicast_virtual_networks:
    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:
    - fabricId: string
      ipPoolName: string
      ipv4SsmRanges:
      - string
      multicastRPs:
      - ipv4Address: string
        ipv4AsmRanges:
        - string
        ipv6Address: string
        ipv6AsmRanges:
        - string
        isDefaultV4RP: true
        isDefaultV6RP: true
        networkDeviceIds:
        - string
        rpDeviceLocation: string
      virtualNetworkName: string

- name: Update all
  cisco.dnac.sda_multicast_virtual_networks:
    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:
    - fabricId: string
      id: string
      ipPoolName: string
      ipv4SsmRanges:
      - string
      multicastRPs:
      - ipv4Address: string
        ipv4AsmRanges:
        - string
        ipv6Address: string
        ipv6AsmRanges:
        - string
        isDefaultV4RP: true
        isDefaultV6RP: true
        networkDeviceIds:
        - string
        rpDeviceLocation: string
      virtualNetworkName: string

- name: Delete by id
  cisco.dnac.sda_multicast_virtual_networks:
    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)