cisco.dnac.endpoint_analytics_profiling_rules_v1_info module – Information module for Endpoint Analytics Profiling Rules V1
Note
This module is part of the cisco.dnac collection (version 6.27.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.endpoint_analytics_profiling_rules_v1_info.
New in cisco.dnac 6.16.0
Synopsis
Get all Endpoint Analytics Profiling Rules V1.
Get Endpoint Analytics Profiling Rules V1 by id.
Fetches details of the profiling rule for the given ‘ruleId’.
This API fetches the list of profiling rules. It can be used to show profiling rules in client applications, or export those from an environment. ‘POST /profiling-rules/bulk’ API can be used to import such exported rules into another environment. If this API is used to export rules to be imported into another Cisco DNA Center system, then ensure that ‘includeDeleted’ parameter is ‘true’, so that deleted rules get synchronized correctly. Use query parameters to filter the data, as required. If no filter is provided, then it will include only rules of type ‘Custom Rule’ in the response. By default, the response is limited to 500 records. Use ‘limit’ parameter to fetch higher number of records, if required. ‘GET /profiling-rules/count’ API can be used to find out the total number of rules in the system.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
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:
|
|
Limit query parameter. Maximum number of records to be fetched. If not provided, 500 records will be fetched by default. To fetch all the records in the system, provide a large value for this parameter. |
|
Offset query parameter. Record offset to start data fetch at. Offset starts at zero. |
|
Order query parameter. Order to be used for sorting. |
|
RuleId path parameter. Unique rule identifier. |
|
RuleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. |
|
SortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are a_i_endpoint_analytics.AIEndpointAnalytics.get_details_of_a_single_profiling_rule_v1, a_i_endpoint_analytics.AIEndpointAnalytics.get_list_of_profiling_rules_v1,
Paths used are get /dna/intent/api/v1/endpoint-analytics/profiling-rules, get /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId},
Supports
check_modeThe 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 Endpoint Analytics Profiling Rules V1
cisco.dnac.endpoint_analytics_profiling_rules_v1_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}}"
ruleType: string
includeDeleted: True
limit: 0
offset: 0
sortBy: string
order: string
register: result
- name: Get Endpoint Analytics Profiling Rules V1 by id
cisco.dnac.endpoint_analytics_profiling_rules_v1_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}}"
ruleId: string
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: |