cisco.dnac.endpoint_analytics_profiling_rules_info – Information module for Endpoint Analytics Profiling Rules

Note

This plugin is part of the cisco.dnac collection (version 4.0.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.

To use it in a playbook, specify: cisco.dnac.endpoint_analytics_profiling_rules_info.

New in version 4.0.0: of cisco.dnac

Synopsis

• Get all Endpoint Analytics Profiling Rules.

• Get Endpoint Analytics Profiling Rules by id.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.0

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
dnac_debug boolean	Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required		The Cisco DNA Center hostname.
dnac_password string		The Cisco DNA Center password to authenticate.
dnac_port string	Default: 443	The Cisco DNA Center port.
dnac_username string	Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string	Default: "2.2.3.3"	Informs the SDK which version of Cisco DNA Center to use.
headers dictionary		Additional headers.
includeDeleted boolean	Choices: no yes	IncludeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched.
limit integer		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 integer		Offset query parameter. Record offset to start data fetch at. Offset starts at zero.
order string		Order query parameter. Order to be used for sorting.
ruleId string		RuleId path parameter. Unique rule identifier.
ruleType string		RuleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to 'Custom Rule'.
sortBy string		SortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• 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

Endpoint Analytics Profiling Rules reference

Complete reference of the Endpoint Analytics Profiling Rules object model.

Examples

- 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

Return Values

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "ruleId": "string", "ruleName": "string", "ruleType": "string", "ruleVersion": 0, "rulePriority": 0, "sourcePriority": 0, "isDeleted": true, "lastModifiedBy": "string", "lastModifiedOn": 0, "pluginId": "string", "clusterId": "string", "rejected": true, "result": { "deviceType": [ "string" ], "hardwareManufacturer": [ "string" ], "hardwareModel": [ "string" ], "operatingSystem": [ "string" ] }, "conditionGroups": { "type": "string", "condition": { "attribute": "string", "operator": "string", "value": "string", "attributeDictionary": "string" }, "operator": "string", "conditionGroup": [ {} ] }, "usedAttributes": [ "string" ] }

Authors

• Rafael Campos (@racampos)