cisco.catalystcenter.feature_templates_wireless_rrm_general_configurations module -- Resource module for Feature Templates Wireless Rrm General Configurations

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

New in cisco.catalystcenter 6.18.0

Synopsis

• Manage operations create, update and delete of the resource Feature Templates Wireless Rrm General Configurations.

• This API allows users to create a RRM General configuration feature template.

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

• This API allows users to update the details of a specific RRM General 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.

• 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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
designName string	The feature template design name. `Note ` The following characters are not allowed % & < > ' /.
featureAttributes dictionary	Feature Templates Wireless Rrm General Configurations's featureAttributes.
coverageHoleDetection boolean	Global Coverage Hole Detection. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
monitoringChannels string	The monitoringChannels attribute represents the scope of monitoring channels.
neighborDiscoverType string	The neighborDiscoverType attribute represents the type of neighbor discovery.
radioBand string	Radio Band 2_4GHZ is supported only on Cisco IOS-XE based Wireless Controllers running 17.9.1 and above.
throughputThreshold integer	Throughput Threshold.
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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are wireless.Wireless.create_r_r_m_general_configuration_feature_template, wireless.Wireless.delete_r_r_m_general_configuration_feature_template, wireless.Wireless.update_r_r_m_general_configuration_feature_template,

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

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

Complete reference of the CreateRRMGeneralConfigurationFeatureTemplate API.

Cisco DNA Center documentation for Wireless DeleteRRMGeneralConfigurationFeatureTemplate

Complete reference of the DeleteRRMGeneralConfigurationFeatureTemplate API.

Cisco DNA Center documentation for Wireless UpdateRRMGeneralConfigurationFeatureTemplate

Complete reference of the UpdateRRMGeneralConfigurationFeatureTemplate API.

Examples

---
- name: Create
  cisco.catalystcenter.feature_templates_wireless_rrm_general_configurations:
    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
    designName: string
    featureAttributes:
      coverageHoleDetection: true
      monitoringChannels: string
      neighborDiscoverType: string
      radioBand: string
      throughputThreshold: 0
    unlockedAttributes:
      - string
- name: Delete by id
  cisco.catalystcenter.feature_templates_wireless_rrm_general_configurations:
    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
    id: string
- name: Update by id
  cisco.catalystcenter.feature_templates_wireless_rrm_general_configurations:
    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
    designName: string
    featureAttributes:
      coverageHoleDetection: true
      monitoringChannels: string
      neighborDiscoverType: string
      radioBand: string
      throughputThreshold: 0
    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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)