cisco.dnac.sda_multicast – Resource module for Sda Multicast

Note

This plugin is part of the cisco.dnac collection (version 4.0.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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create and delete of the resource Sda Multicast.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.0

• python >= 3.5

Parameters

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.3.3"	Informs the SDK which version of Cisco DNA Center to use.
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, that is reserved to fabricSiteNameHierarchy.
	ssmGroupRange string		Valid SSM group range ip address(e.g., 230.0.0.0).
	ssmInfo dictionary		Source-specific multicast information, required if muticastType=ssm.
	ssmWildcardMask string		Valid SSM Wildcard Mask ip address(e.g.,0.255.255.255).
	virtualNetworkName string		Virtual Network Name, that is associated to fabricSiteNameHierarchy.
muticastType string			Muticast Type.
siteNameHierarchy string			Full path of sda fabric siteNameHierarchy.
validate_response_schema boolean		Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

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

See Also

See also

Sda Multicast reference

Complete reference of the Sda Multicast object model.

Examples

- 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
    multicastMethod: string
    multicastVnInfo:
      externalRpIpAddress: string
      ipPoolName: string
      ssmGroupRange: string
      ssmInfo: {}
      ssmWildcardMask: string
      virtualNetworkName: string
    muticastType: string
    siteNameHierarchy: 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
    siteNameHierarchy: string

Return Values

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

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", "executionStatusUrl": "string", "executionId": "string" }

Authors

• Rafael Campos (@racampos)