cisco.dnac.sda_multicast module – Resource module for Sda Multicast
Note
This module is part of the cisco.dnac collection (version 6.6.1).
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
.
New in cisco.dnac 3.1.0
Synopsis
Manage operations create and delete of the resource Sda Multicast.
Add multicast in SDA fabric.
Delete multicast from SDA fabric.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.5.5
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Multicast Method. |
|
Multicast Type. |
|
Sda Multicast’s multicastVnInfo. |
|
ExternalRpIpAddress, required if multicastType is asm_with_external_rp. |
|
InternalRpIpAddress, required if multicastType is asm_with_internal_rp. |
|
Ip Pool Name, that is reserved to Fabric Site. |
|
Sda Multicast’s ssmInfo. |
|
Valid SSM group range ip address(e.g., 230.0.0.0). |
|
Valid SSM Wildcard Mask ip address(e.g.,0.255.255.255). |
|
Virtual Network Name, that is associated to Fabric Site. |
|
Full path of sda Fabric Site. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sda.Sda.add_multicast_in_sda_fabric, sda.Sda.delete_multicast_from_sda_fabric,
Paths used are post /dna/intent/api/v1/business/sda/multicast, delete /dna/intent/api/v1/business/sda/multicast,
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 AddMulticastInSDAFabric
Complete reference of the AddMulticastInSDAFabric API.
- Cisco DNA Center documentation for SDA DeleteMulticastFromSDAFabric
Complete reference of the DeleteMulticastFromSDAFabric API.
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
multicastType: string
multicastVnInfo:
- externalRpIpAddress: string
internalRpIpAddress:
- string
ipPoolName: string
ssmInfo:
ssmGroupRange: string
ssmWildcardMask: string
virtualNetworkName: 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 |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |