cisco.catalystcenter.sda_multicast module -- Resource module for Sda Multicast

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.catalystcenter 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.

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

multicastMethod

string

Multicast Method.

multicastType

string

Multicast Type.

multicastVnInfo

list / elements=dictionary

Sda Multicast's multicastVnInfo.

externalRpIpAddress

string

ExternalRpIpAddress, required if multicastType is asm_with_external_rp.

internalRpIpAddress

list / elements=string

InternalRpIpAddress, required if multicastType is asm_with_internal_rp.

ipPoolName

string

Ip Pool Name, that is reserved to Fabric Site.

ssmInfo

list / elements=dictionary

Sda Multicast's ssmInfo.

ssmGroupRange

string

Valid SSM group range ip address(e.g., 230.0.0.0).

ssmWildcardMask

string

Valid SSM Wildcard Mask ip address(e.g.,0.255.255.255).

virtualNetworkName

string

Virtual Network Name, that is associated to Fabric Site.

siteNameHierarchy

string

SiteNameHierarchy query parameter.

validate_response_schema

boolean

Flag for Cisco Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK

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: Delete all
  cisco.catalystcenter.sda_multicast:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    siteNameHierarchy: string
- name: Create
  cisco.catalystcenter.sda_multicast:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    multicastMethod: string
    multicastType: string
    multicastVnInfo:
      - externalRpIpAddress: string
        internalRpIpAddress:
          - string
        ipPoolName: string
        ssmInfo:
          - ssmGroupRange: string
            ssmWildcardMask: string
        virtualNetworkName: string
    siteNameHierarchy: string

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}`

Authors

  • Rafael Campos (@racampos)