cisco.dnac.filter_groups_info module -- Information module for Filter Groups

Note

This module is part of the cisco.dnac collection (version 6.46.0).

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

New in cisco.dnac 6.46.0

Synopsis

• Get all Filter Groups.

• Get Filter Groups by id. - > Returns the details of filter group for the given id. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst- center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-FilterGroups-1.0.0-resolved.yaml. - > Returns the details of filter groups for given search criteria specified in query parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- FilterGroups-1.0.0-resolved.yaml.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.11.0

• python >= 3.12

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"`
headers dictionary	Additional headers.
id string	Id query parameter. Filter Group id. Examples `?id=2ee1b9f0-8036-443b-bad0-7692760af1b5`(single id requested) `?id=2ee1b9f0-8036-443b-bad0-7692760af1b5&id=ae368f0b-f4e3-4e8f-a914-011cbd19bb51` (multiple ids requested).
limit integer	Limit query parameter. Maximum number of records to return.
name string	Name query parameter. Filter Group name. Examples `?name=SJC Wireless`(single name requested) `?name=SJC Wireless&name=Global Wired` (multiple names requested).
offset integer	Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.
type string	Type query parameter. Type of the filter group. Examples type=Generic (single Filter Group type requested) type=Generic&type=Site (multiple Filter Group types requested).
validate_response_schema boolean	Flag for Cisco DNA 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.get_the_filter_group_details_for_the_given_id, devices.Devices.get_the_filter_groups_for_given_search_criteria,

• Paths used are get /dna/intent/api/v1/filterGroups, get /dna/intent/api/v1/filterGroups/{id},

• Supports 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 Devices GetTheFilterGroupDetailsForTheGivenId

Complete reference of the GetTheFilterGroupDetailsForTheGivenId API.

Cisco DNA Center documentation for Devices GetTheFilterGroupsForGivenSearchCriteria

Complete reference of the GetTheFilterGroupsForGivenSearchCriteria API.

Examples

---
- name: Get all Filter Groups
  cisco.dnac.filter_groups_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
    name: string
    type: string
    offset: 0
    limit: 0
  register: result
- name: Get Filter Groups by id
  cisco.dnac.filter_groups_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

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": {"filters": [{"displayValue": "string", "key": "string", "operator": "string", "value": "string"}], "id": "string", "name": "string", "type": "string"}}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)