cisco.dnac.profiling_rules_count_info module – Information module for Profiling Rules Count
Note
This module is part of the cisco.dnac collection (version 6.20.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.profiling_rules_count_info
.
New in cisco.dnac 4.0.0
Synopsis
Get all Profiling Rules Count.
This API fetches the count of profiling rules based on the filter values provided in the query parameters. The filter parameters are same as that of ‘GET /profiling-rules’ API, excluding the pagination and sort parameters.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.9
Parameters
Parameter |
Comments |
---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
IncludeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. Choices:
|
|
RuleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are policy.Policy.get_count_of_profiling_rules,
Paths used are get /dna/intent/api/v1/endpoint-analytics/profiling-rules/count,
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
Examples
- name: Get all Profiling Rules Count
cisco.dnac.profiling_rules_count_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:
custom: value
ruleType: string
includeDeleted: True
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |