cisco.dnac.sda_multicast – Resource module for Sda Multicast

Note

This plugin is part of the cisco.dnac collection (version 3.2.0).

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

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

Notes

Note

  • Does not support check_mode

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

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


Authors

  • Rafael Campos (@racampos)