cisco.dnac.feature_templates_wireless_multicast_configurations_id module – Resource module for Feature Templates Wireless Multicast Configurations Id

Note

This module is part of the cisco.dnac collection (version 6.41.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.18.0

Synopsis

  • Manage operations update and delete of the resource Feature Templates Wireless Multicast Configurations Id.

  • This API allows users to delete a specific Multicast configuration feature template by ID.

  • This API allows users to update the details of a specific Multicast configuration feature template by ID.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.10.1

  • python >= 3.5

Parameters

Parameter

Comments

designName

string

The feature template design name. `Note ` The following characters are not allowed % & < > ‘ /.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

featureAttributes

dictionary

Feature Templates Wireless Multicast Configurations Id’s featureAttributes.

globalMulticastEnabled

boolean

Global Multicast Enabled.

Choices:

  • false

  • true

multicastIpv4Address

string

Multicast Ipv4 address must be between 224.0.0.0 and 239.255.255.255. Note This is only supported when multicastIpv4Mode is set to MULTICAST.

multicastIpv4Mode

string

Multicast Ipv4 Mode.

multicastIpv6Address

string

Multicast Ipv6 Address must start with FF0 or 11,2,3,4,5,8, or E. Note This is only supported when multicastIpv6Mode is set to MULTICAST.

multicastIpv6Mode

string

Multicast Ipv6 Mode.

id

string

Id path parameter. Multicast Configuration Feature Template Id.

unlockedAttributes

list / elements=string

Attributes unlocked in design can be changed at device provision time. `Note ` unlockedAttributes can only contain the attributes defined under featureAttributes.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are wireless.Wireless.delete_multicast_configuration_feature_template, wireless.Wireless.update_multicast_configuration_feature_template,

  • Paths used are delete /dna/intent/api/v1/featureTemplates/wireless/multicastConfigurations/{id}, put /dna/intent/api/v1/featureTemplates/wireless/multicastConfigurations/{id},

  • 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 Wireless DeleteMulticastConfigurationFeatureTemplate

Complete reference of the DeleteMulticastConfigurationFeatureTemplate API.

Cisco DNA Center documentation for Wireless UpdateMulticastConfigurationFeatureTemplate

Complete reference of the UpdateMulticastConfigurationFeatureTemplate API.

Examples

---
- name: Delete by id
  cisco.dnac.feature_templates_wireless_multicast_configurations_id:
    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
    id: string
- name: Update by id
  cisco.dnac.feature_templates_wireless_multicast_configurations_id:
    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
    designName: string
    featureAttributes:
      globalMulticastEnabled: true
      multicastIpv4Address: string
      multicastIpv4Mode: string
      multicastIpv6Address: string
      multicastIpv6Mode: string
    id: string
    unlockedAttributes:
      - 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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)