.. 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 .. Anchors .. _ansible_collections.cisco.dnac.sda_multicast_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sda_multicast -- Resource module for Sda Multicast +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.2.2). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.sda_multicast`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create and delete of the resource Sda Multicast. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.3.1 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
fabricSiteNameHierarchy
string
FabricSiteNameHierarchy.
multicastMethod
string
Multicast methods.
multicastVnInfo
dictionary
Sda Multicast's multicastVnInfo.
externalRpIpAddress
string
External Rp Ip Address, required for muticastType=asm_with_external_rp.
ipPoolName
string
Ip Pool Name in fabricSiteNameHierarchy.
ssmGroupRange
string
Valid ssm group range ip address.
ssmInfo
dictionary
Source-specific multicast information, required if muticastType=ssm.
ssmWildcardMask
string
Valid ssm Wildcard Mask ip address.
virtualNetworkName
string
Virtual network name in fabricSiteNameHierarchy.
muticastType
string
Muticast type.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Sda Multicast reference `_ Complete reference of the Sda Multicast object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.dnac.sda_multicast: 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 fabricSiteNameHierarchy: string multicastMethod: string multicastVnInfo: externalRpIpAddress: string ipPoolName: string ssmGroupRange: string ssmInfo: {} ssmWildcardMask: string virtualNetworkName: string muticastType: string - name: Delete all cisco.dnac.sda_multicast: 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 fabricSiteNameHierarchy: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "status": "string", "description": "string", "taskId": "string", "taskStatusUrl": "string", "executionId": "string" }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors