cisco.dnac.endpoint_analytics_profiling_rules_bulk module -- Resource module for Endpoint Analytics Profiling Rules Bulk

Note

This module is part of the cisco.dnac collection (version 6.28.0).

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_bulk.

New in cisco.dnac 6.16.0

Synopsis

  • This module represents an alias of the module endpoint_analytics_profiling_rules_bulk_v1

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

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

profilingRules

list / elements=dictionary

Endpoint Analytics Profiling Rules Bulk's profilingRules.

clusterId

string

Unique identifier for ML cluster. Only applicable for 'ML Rule'.

conditionGroups

dictionary

Endpoint Analytics Profiling Rules Bulk's conditionGroups.

condition

dictionary

Endpoint Analytics Profiling Rules Bulk's condition.

attribute

string

Endpoint Analytics Profiling Rules Bulk's attribute.

attributeDictionary

string

Endpoint Analytics Profiling Rules Bulk's attributeDictionary.

operator

string

Endpoint Analytics Profiling Rules Bulk's operator.

value

string

Endpoint Analytics Profiling Rules Bulk's value.

conditionGroup

list / elements=string

Endpoint Analytics Profiling Rules Bulk's conditionGroup.

operator

string

Endpoint Analytics Profiling Rules Bulk's operator.

type

string

Endpoint Analytics Profiling Rules Bulk's type.

isDeleted

boolean

Flag to indicate whether the rule was deleted.

Choices:

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

Flag to indicate whether rule has been rejected by user or not. Only applicable for 'ML Rule'.

Choices:

result

dictionary

Endpoint Analytics Profiling Rules Bulk'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.

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

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.import_profiling_rules_in_bulk_v1,

  • Paths used are post /dna/intent/api/v1/endpoint-analytics/profiling-rules/bulk,

  • It should be noted that this module is an alias of endpoint_analytics_profiling_rules_bulk_v1

  • 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

Examples

- name: Create
  cisco.dnac.endpoint_analytics_profiling_rules_bulk:
    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}}"
    profilingRules:
    - clusterId: string
      conditionGroups:
        condition:
          attribute: string
          attributeDictionary: string
          operator: string
          value: string
        conditionGroup:
        - string
        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

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{}`

Authors

  • Rafael Campos (@racampos)