cisco.catalystcenter.filter_groups module -- Resource module for Filter Groups

Note

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

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

New in cisco.catalystcenter 2.3.0

Synopsis

• Manage operations create, update and delete of the resource Filter Groups.

• Creates filter group with given filters. - > Deletes the given filter group. Delete will fail and throws validation error if the given filter group is associated with any entity.

• Updates the filter group for given id. The request payload should contain complete definition of the Filter Group.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug aliases: dnac_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 aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_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 aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
filters list / elements=dictionary	List of filters used in this Filter Group.
displayValue dictionary	This field stores desriptive equivalent of the `value` field. For example, this field can be used to store site hierarchy name while the `value` field stores site hierarchy id.
key string	Field names which are supported by this API as filter keys.
operator string	Type of filter operator to use for querying data. `in` and `notIn` operator takes multiple values and applies the filters.
value dictionary	This should be array if `operator` is `in` and `notIn`. For all other operators this should be a string or a number.
headers dictionary	Additional headers.
id string	Id path parameter. The id of the filter group to be updated.
name string	Filter Group name. Only alphabhets, digits and space is allowed for name.
type string	The type of the Filter Group.
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 devices.Devices.create_filter_group, devices.Devices.delete_a_filter_group, devices.Devices.update_filter_group,

• Paths used are post /dna/intent/api/v1/filterGroups, delete /dna/intent/api/v1/filterGroups/{id}, put /dna/intent/api/v1/filterGroups/{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

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Devices CreateFilterGroup

Complete reference of the CreateFilterGroup API.

Cisco Catalyst Center documentation for Devices DeleteAFilterGroup

Complete reference of the DeleteAFilterGroup API.

Cisco Catalyst Center documentation for Devices UpdateFilterGroup

Complete reference of the UpdateFilterGroup API.

Examples

---
- name: Create
  cisco.catalystcenter.filter_groups:
    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
    filters:
      - displayValue: {}
        key: string
        operator: string
        value: {}
    headers: '{{my_headers | from_json}}'
    name: string
    type: string
- name: Update by id
  cisco.catalystcenter.filter_groups:
    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
    filters:
      - displayValue: {}
        key: string
        operator: string
        value: {}
    headers: '{{my_headers | from_json}}'
    id: string
    name: string
    type: string
- name: Delete by id
  cisco.catalystcenter.filter_groups:
    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
    headers: '{{my_headers | from_json}}'
    id: string

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"id": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)