cisco.dnac.sda_multicast_virtual_networks_v1 模块 – Sda 组播虚拟网络 V1 的资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要

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

• 根据用户输入为虚拟网络添加组播。

• 根据 ID 删除虚拟网络的组播配置。

• 根据用户输入更新虚拟网络的组播配置。

注意

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

要求

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

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
dnac_debug boolean	用于 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 boolean	用于启用或禁用 SSL 证书验证的标志。 选项 false true ← (默认)
dnac_version 字符串	通知 SDK 要使用的 Cisco DNA Center 版本。 默认值: "2.3.7.6"
id 字符串	Id 路径参数。组播配置的 ID。
payload 列表 / elements=字典	Sda 组播虚拟网络的有效负载。
fabricId 字符串	此组播配置关联的 Fabric 站点的 ID。
ipPoolName 字符串	与 Fabric 站点关联的 IP 池的名称。
ipv4SsmRanges 列表 / elements=字符串	IPv4 源特定组播 (SSM) 范围。允许的范围为 225.0.0.0/8 到 239.0.0.0/8。SSM 范围不应与为 ASM 组播提供的范围冲突。
multicastRPs 列表 / elements=字典	Sda 组播虚拟网络的 multicastRPs。
ipv4Address 字符串	RP 的 IPv4 地址。对于外部 RP 配置，必须提供 ipv4Address 或 ipv6Address 中的一个。对于 Fabric RP，此地址由 SDA 分配，不应在 RP 创建请求期间提供，并且 SDA 分配的地址应在后续请求中保留。
ipv4AsmRanges 列表 / elements=字符串	IPv4 任意源组播范围。由给定组播 RP 服务的 IPv4 组播组范围的逗号分隔列表。只能提供 IPv4 范围。对于 Fabric RP，可以同时提供 IPv4 和 IPv6 范围。对于外部 RP，应为 IPv4 外部 RP 提供 IPv4 范围，并为 IPv6 外部 RP 提供 IPv6 范围。
ipv6Address 字符串	RP 的 IPv6 地址。对于外部 RP 配置，必须提供 ipv4Address 或 ipv6Address 中的一个。对于 Fabric RP，此地址由 SDA 分配，不应在 RP 创建请求期间提供，并且 SDA 分配的地址应在后续请求中保留。Ipv6Address 只能为具有双栈（IPv4 + IPv6）组播池的虚拟网络提供。
ipv6AsmRanges 列表 / elements=字符串	IPv6 任意源组播范围。由给定组播 RP 服务的 IPv6 组播组范围的逗号分隔列表。只能提供 IPv6 范围。只能为双栈组播池提供 IPv6 范围。对于 Fabric RP，可以同时提供 IPv4 和 IPv6 范围。对于外部 RP，应为 IPv4 外部 RP 提供 IPv4 范围，并为 IPv6 外部 RP 提供 IPv6 范围。
isDefaultV4RP boolean	指定是否为默认 IPv4 RP。 选项 false true
isDefaultV6RP boolean	指定是否为默认 IPv6 RP。 选项 false true
networkDeviceIds 列表 / elements=字符串	网络设备的 ID。这是 Fabric RP 的必填字段。一个 Fabric 站点最多可以有两个 Fabric RP，这些 RP 在所有组播虚拟网络之间共享。要在一个 Fabric 站点中配置两个 Fabric RP，这两个设备必须具有边界角色。在将 Fabric 边缘设备用作 RP 或使用双栈组播池的情况下，只能配置一个 RP。
rpDeviceLocation 字符串	RP 的设备位置。
virtualNetworkName 字符串	与 Fabric 站点关联的虚拟网络的名称。
validate_response_schema boolean	用于 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,

• 不支持 check_mode

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

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

另请参阅

另请参阅

关于 SDA AddMulticastVirtualNetworksV1 的 Cisco DNA Center 文档

AddMulticastVirtualNetworksV1 API 的完整参考。

关于 SDA DeleteMulticastVirtualNetworkByIdV1 的 Cisco DNA Center 文档

DeleteMulticastVirtualNetworkByIdV1 API 的完整参考。

关于 SDA UpdateMulticastVirtualNetworksV1 的 Cisco DNA Center 文档

UpdateMulticastVirtualNetworksV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.sda_multicast_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:
    - 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_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:
    - 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_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)

集合链接

• 问题跟踪器
• 存储库（源代码）