cisco.dnac.sda_multicast_virtual_networks module – Resource module for Sda Multicast Virtual Networks

Note

This module is part of the cisco.dnac collection (version 6.40.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.sda_multicast_virtual_networks.

New in cisco.dnac 6.15.0

Synopsis

• Manage operations create, update and delete of the resource Sda Multicast Virtual Networks.

• Adds multicast for virtual networks based on user input.

• Deletes a multicast configuration for a virtual network based on id.

• Updates multicast configurations for virtual networks based on user input.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.10.1

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: false ← (default) true
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: "admin"
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: "2.3.7.6"
id string	Id path parameter. ID of the multicast configuration.
payload list / elements=dictionary	Sda Multicast Virtual Networks’s payload.
fabricId string	ID of the fabric site this multicast configuration is associated with.
ipPoolName string	Name of the IP Pool associated with the fabric site.
ipv4SsmRanges list / elements=string	IPv4 Source Specific Multicast (SSM) ranges. Allowed ranges are from 225.0.0.0/8 to 239.0.0.0/8. SSM ranges should not conflict with ranges provided for ASM multicast.
multicastRPs list / elements=dictionary	Sda Multicast Virtual Networks’s multicastRPs.
ipv4Address string	IPv4 address of the RP. For external RP configuration, exactly one of ipv4Address or ipv6Address must be provided. For fabric RP, this address is allocated by SDA and should not be provided during RP creation request and SDA allocated address should be retained in subsequent requests.
ipv4AsmRanges list / elements=string	IPv4 Any Source Multicast ranges. Comma seperated list of IPv4 multicast group ranges that will be served by a given Multicast RP. Only IPv4 ranges can be provided. For fabric RP, both IPv4 and IPv6 ranges can be provided together. For external RP, IPv4 ranges should be provided for IPv4 external RP and IPv6 ranges should be provided for IPv6 external RP.
ipv6Address string	IPv6 address of the RP. For external RP configuration, exactly one of ipv4Address or ipv6Address must be provided. For fabric RP, this address is allocated by SDA and should not be provided during RP creation request and SDA allocated address should be retained in subsequent requests. Ipv6Address can only be provided for virtual networks with dual stack (IPv4 + IPv6) multicast pool.
ipv6AsmRanges list / elements=string	IPv6 Any Source Multicast ranges. Comma seperated list of IPv6 multicast group ranges that will be served by a given Multicast RP. Only IPv6 ranges can be provided. IPv6 ranges can only be provided for dual stack multicast pool. For fabric RP, both IPv4 and IPv6 ranges can be provided together. For external RP, IPv4 ranges should be provided for IPv4 external RP and IPv6 ranges should be provided for IPv6 external RP.
isDefaultV4RP boolean	Specifies whether it is a default IPv4 RP. Choices: false true
isDefaultV6RP boolean	Specifies whether it is a default IPv6 RP. Choices: false true
networkDeviceIds list / elements=string	IDs of the network devices. This is a required field for fabric RPs. There can be maximum of two fabric RPs for a fabric site and these are shared across all multicast virtual networks. For configuring two fabric RPs in a fabric site both devices must have border roles. Only one RP can be configured in scenarios where a fabric edge device is used as RP or a dual stack multicast pool is used.
rpDeviceLocation string	Device location of the RP.
virtualNetworkName string	Name of the virtual network associated with the fabric site.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)

Notes

Note

• SDK Method used are sda.Sda.add_multicast_virtual_networks, sda.Sda.delete_multicast_virtual_network_by_id, sda.Sda.update_multicast_virtual_networks,

• Paths used are 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,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA AddMulticastVirtualNetworks

Complete reference of the AddMulticastVirtualNetworks API.

Cisco DNA Center documentation for SDA DeleteMulticastVirtualNetworkById

Complete reference of the DeleteMulticastVirtualNetworkById API.

Cisco DNA Center documentation for SDA UpdateMulticastVirtualNetworks

Complete reference of the UpdateMulticastVirtualNetworks API.

Examples

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)