cisco.dnac.endpoint_analytics_profiling_rules – Resource 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.

New in version 4.0.0: of cisco.dnac

Synopsis

  • Manage operations create, update and delete of the resource Endpoint Analytics Profiling Rules.

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
clusterId
string
Unique identifier for ML cluster. Only applicable for 'ML Rule'.
conditionGroups
dictionary
Endpoint Analytics Profiling Rules's conditionGroups.
condition
dictionary
Endpoint Analytics Profiling Rules's condition.
attribute
string
Endpoint Analytics Profiling Rules's attribute.
attributeDictionary
string
Endpoint Analytics Profiling Rules's attributeDictionary.
operator
string
Endpoint Analytics Profiling Rules's operator.
value
string
Endpoint Analytics Profiling Rules's value.
conditionGroup
list / elements=dictionary
Endpoint Analytics Profiling Rules's conditionGroup.
operator
string
Endpoint Analytics Profiling Rules's operator.
type
string
Endpoint Analytics Profiling Rules's type.
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.
isDeleted
boolean
    Choices:
  • no
  • yes
Flag to indicate whether the rule was deleted.
lastModifiedBy
string
User that last modified the rule. It is read-only, and is ignored if provided as part of input request.
lastModifiedOn
integer
Timestamp (in epoch milliseconds) of last modification. It is read-only, and is ignored if provided as part of input request.
pluginId
string
Plugin for the rule. Only applicable for 'Cisco Default' rules.
rejected
boolean
    Choices:
  • no
  • yes
Flag to indicate whether rule has been rejected by user or not. Only applicable for 'ML Rule'.
result
dictionary
Endpoint Analytics Profiling Rules's result.
deviceType
list / elements=string
List of device types determined by the current rule.
hardwareManufacturer
list / elements=string
List of hardware manufacturers determined by the current rule.
hardwareModel
list / elements=string
List of hardware models determined by the current rule.
operatingSystem
list / elements=string
List of operating systems determined by the current rule.
ruleId
string
Unique identifier for the rule. This is normally generated by the system, and client does not need to provide it for rules that need to be newly created.
ruleName
string
Human readable name for the rule.
rulePriority
integer
Priority for the rule.
ruleType
string
Type of the rule. Allowed values are 'Cisco Default - Static', 'Cisco Default - Dynamic', 'Custom Rule', 'ML Rule'.
ruleVersion
integer
Version of the rule.
sourcePriority
integer
Source priority for the rule.
usedAttributes
list / elements=string
List of attributes used in the rule. Only applicable for 'Cisco Default' rules.
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

  • Does not support 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: Create
  cisco.dnac.endpoint_analytics_profiling_rules:
    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}}"
    state: present
    clusterId: string
    conditionGroups:
      condition:
        attribute: string
        attributeDictionary: string
        operator: string
        value: string
      conditionGroup:
      - {}
      operator: string
      type: string
    isDeleted: true
    lastModifiedBy: string
    lastModifiedOn: 0
    pluginId: string
    rejected: true
    result:
      deviceType:
      - string
      hardwareManufacturer:
      - string
      hardwareModel:
      - string
      operatingSystem:
      - string
    ruleId: string
    ruleName: string
    rulePriority: 0
    ruleType: string
    ruleVersion: 0
    sourcePriority: 0
    usedAttributes:
    - string

- name: Update by id
  cisco.dnac.endpoint_analytics_profiling_rules:
    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}}"
    state: present
    clusterId: string
    conditionGroups:
      condition:
        attribute: string
        attributeDictionary: string
        operator: string
        value: string
      conditionGroup:
      - {}
      operator: string
      type: string
    isDeleted: true
    lastModifiedBy: string
    lastModifiedOn: 0
    pluginId: string
    rejected: true
    result:
      deviceType:
      - string
      hardwareManufacturer:
      - string
      hardwareModel:
      - string
      operatingSystem:
      - string
    ruleId: string
    ruleName: string
    rulePriority: 0
    ruleType: string
    ruleVersion: 0
    sourcePriority: 0
    usedAttributes:
    - string

- name: Delete by id
  cisco.dnac.endpoint_analytics_profiling_rules:
    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}}"
    state: absent
    ruleId: string

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:
{ "id": "string", "link": "string" }


Authors

  • Rafael Campos (@racampos)