cisco.catalystcenter.feature_templates_wireless_event_driven_rrmconfigurations_id module -- Resource module for Feature Templates Wireless Event Driven Rrmconfigurations Id

Note

This module is part of the cisco.catalystcenter collection (version 2.2.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_event_driven_rrmconfigurations_id.

New in cisco.catalystcenter 6.18.0

Synopsis

  • Manage operations update and delete of the resource Feature Templates Wireless Event Driven Rrmconfigurations Id.

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

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

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

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

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

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

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

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

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

designName

string

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

featureAttributes

dictionary

Feature Templates Wireless Event Driven Rrmconfigurations Id's featureAttributes.

eventDrivenRrmCustomThresholdVal

integer

Event Driven Radio Resource Management (RRM) Custom Threshold Val is only supported for `CUSTOM` Event Driven RRM Threshold Level.

eventDrivenRrmEnable

boolean

Event Driven Radio Resource Management (RRM) Enable, when set `true` Event Driven RRM is Enabled.

Choices:

eventDrivenRrmThresholdLevel

string

Event Driven Radio Resource Management (RRM) Threshold Level is only supported when Event Driven RRM is `Enabled`.

radioBand

string

Radio Band.

id

string

Id path parameter. Event Driven RRM 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:

Notes

Note

  • SDK Method used are wireless.Wireless.delete_event_driven_r_r_m_configuration_feature_template, wireless.Wireless.update_event_driven_r_r_m_configuration_feature_template,

  • Paths used are delete /dna/intent/api/v1/featureTemplates/wireless/eventDrivenRRMConfigurations/{id}, put /dna/intent/api/v1/featureTemplates/wireless/eventDrivenRRMConfigurations/{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 DeleteEventDrivenRRMConfigurationFeatureTemplate

Complete reference of the DeleteEventDrivenRRMConfigurationFeatureTemplate API.

Cisco DNA Center documentation for Wireless UpdateEventDrivenRRMConfigurationFeatureTemplate

Complete reference of the UpdateEventDrivenRRMConfigurationFeatureTemplate API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.feature_templates_wireless_event_driven_rrmconfigurations_id:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: absent
    id: string
- name: Update by id
  cisco.catalystcenter.feature_templates_wireless_event_driven_rrmconfigurations_id:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    designName: string
    featureAttributes:
      eventDrivenRrmCustomThresholdVal: 0
      eventDrivenRrmEnable: true
      eventDrivenRrmThresholdLevel: string
      radioBand: 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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)