cisco / cisco.dnac / 6.13.3 / module / endpoint_analytics_profiling_rules_info Information module for Endpoint Analytics Profiling Rules | "added in version" 4.0.0 of cisco.dnac" Authors: Rafael Campos (@racampos) This plugin has a corresponding action plugin.cisco.dnac.endpoint_analytics_profiling_rules_info (6.13.3) — module
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections: - name: cisco.dnac version: 6.13.3
Get all Endpoint Analytics Profiling Rules.
Get Endpoint Analytics Profiling Rules 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.
- name: Get all Endpoint Analytics Profiling Rules cisco.dnac.endpoint_analytics_profiling_rules_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 limit: 0 offset: 0 sortBy: string order: string register: result
- name: Get Endpoint Analytics Profiling Rules by id cisco.dnac.endpoint_analytics_profiling_rules_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 ruleId: string register: result
limit: description: - '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. ' type: int order: description: - Order query parameter. Order to be used for sorting. type: str offset: description: - Offset query parameter. Record offset to start data fetch at. Offset starts at zero. type: int ruleId: description: - RuleId path parameter. Unique rule identifier. type: str sortBy: description: - 'SortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. ' type: str headers: description: Additional headers. type: dict ruleType: description: - RuleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to 'Custom Rule'. type: str dnac_host: description: - The Cisco DNA Center hostname. required: true type: str dnac_port: default: 443 description: - The Cisco DNA Center port. type: int dnac_debug: default: false description: - Flag for Cisco DNA Center SDK to enable debugging. type: bool dnac_verify: default: true description: - Flag to enable or disable SSL certificate verification. type: bool dnac_version: default: 2.3.5.3 description: - Informs the SDK which version of Cisco DNA Center to use. type: str dnac_password: description: - The Cisco DNA Center password to authenticate. type: str dnac_username: aliases: - user default: admin description: - The Cisco DNA Center username to authenticate. type: str includeDeleted: description: - IncludeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. type: bool validate_response_schema: default: true description: - Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. type: bool
dnac_response: description: A dictionary or list with the response returned by the Cisco DNAC Python SDK returned: always sample: "{\n \"ruleId\": \"string\",\n \"ruleName\": \"string\",\n \"ruleType\"\ : \"string\",\n \"ruleVersion\": 0,\n \"rulePriority\": 0,\n \"sourcePriority\"\ : 0,\n \"isDeleted\": true,\n \"lastModifiedBy\": \"string\",\n \"lastModifiedOn\"\ : 0,\n \"pluginId\": \"string\",\n \"clusterId\": \"string\",\n \"rejected\"\ : true,\n \"result\": {\n \"deviceType\": [\n \"string\"\n ],\n \ \ \"hardwareManufacturer\": [\n \"string\"\n ],\n \"hardwareModel\"\ : [\n \"string\"\n ],\n \"operatingSystem\": [\n \"string\"\n\ \ ]\n },\n \"conditionGroups\": {\n \"type\": \"string\",\n \"condition\"\ : {\n \"attribute\": \"string\",\n \"operator\": \"string\",\n \ \ \"value\": \"string\",\n \"attributeDictionary\": \"string\"\n },\n\ \ \"operator\": \"string\",\n \"conditionGroup\": [\n {}\n ]\n \ \ },\n \"usedAttributes\": [\n \"string\"\n ]\n}\n" type: dict