cisco.catalystcenter.endpoint_analytics_profiling_rules module -- Resource module for Endpoint Analytics Profiling-Rules

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.endpoint_analytics_profiling_rules.

New in cisco.catalystcenter 6.16.0

Synopsis 

Manage operations create, update and delete of the resource Endpoint Analytics Profiling-Rules.
Creates profiling rule from the request body.
Deletes the profiling rule for the given 'ruleId'.
Updates the profiling rule for the given 'ruleId'.

Note

This module has a corresponding action plugin.

Requirements 

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

catalystcentersdk >= 3.1.3.0.0
python >= 3.5

Parameters 

Parameter	Comments
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
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.
isDeleted boolean	Flag to indicate whether the rule was deleted. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
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.
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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes 

Note

SDK Method used are ai_endpoint_analytics.AiEndpointAnalytics.create_a_profiling_rule, ai_endpoint_analytics.AiEndpointAnalytics.delete_an_existing_profiling_rule, ai_endpoint_analytics.AiEndpointAnalytics.update_an_existing_profiling_rule,
Paths used are post /dna/intent/api/v1/endpoint-analytics/profiling-rules, delete /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId}, put /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId},
Does not support check_mode
The plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK

Examples 

---
- name: Create
  cisco.catalystcenter.endpoint_analytics_profiling-rules:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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.catalystcenter.endpoint_analytics_profiling-rules:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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.catalystcenter.endpoint_analytics_profiling-rules:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    ruleId: 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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"id": "string", "link": "string"}`

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.catalystcenter.endpoint_analytics_profiling_rules module -- Resource module for Endpoint Analytics Profiling-Rules

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 