.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sda_multicast_virtual_networks module -- Resource module for Sda Multicast Virtual Networks ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.28.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.sda_multicast_virtual_networks`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.15.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module sda\_multicast\_virtual\_networks\_v1 .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. ID of the multicast configuration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sda Multicast Virtual Networks's payload. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of the fabric site this multicast configuration is associated with. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/ippoolname: .. rst-class:: ansible-option-title **ipPoolName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the IP Pool associated with the fabric site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/ipv4ssmranges: .. rst-class:: ansible-option-title **ipv4SsmRanges** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps: .. rst-class:: ansible-option-title **multicastRPs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sda Multicast Virtual Networks's multicastRPs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/ipv4address: .. rst-class:: ansible-option-title **ipv4Address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/ipv4asmranges: .. rst-class:: ansible-option-title **ipv4AsmRanges** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/ipv6address: .. rst-class:: ansible-option-title **ipv6Address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/ipv6asmranges: .. rst-class:: ansible-option-title **ipv6AsmRanges** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/isdefaultv4rp: .. rst-class:: ansible-option-title **isDefaultV4RP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies whether it is a default IPv4 RP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/isdefaultv6rp: .. rst-class:: ansible-option-title **isDefaultV6RP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies whether it is a default IPv6 RP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/networkdeviceids: .. rst-class:: ansible-option-title **networkDeviceIds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/multicastrps/rpdevicelocation: .. rst-class:: ansible-option-title **rpDeviceLocation** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device location of the RP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-payload/virtualnetworkname: .. rst-class:: ansible-option-title **virtualNetworkName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the virtual network associated with the fabric site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are sda.Sda.add\_multicast\_virtual\_networks\_v1, sda.Sda.delete\_multicast\_virtual\_network\_by\_id\_v1, sda.Sda.update\_multicast\_virtual\_networks\_v1, - 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, - It should be noted that this module is an alias of sda\_multicast\_virtual\_networks\_v1 - Does not support \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for SDA AddMulticastVirtualNetworksV1 `_ Complete reference of the AddMulticastVirtualNetworksV1 API. `Cisco DNA Center documentation for SDA DeleteMulticastVirtualNetworkByIdV1 `_ Complete reference of the DeleteMulticastVirtualNetworkByIdV1 API. `Cisco DNA Center documentation for SDA UpdateMulticastVirtualNetworksV1 `_ Complete reference of the UpdateMulticastVirtualNetworksV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_multicast_virtual_networks_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors