cisco.dnac.endpoint_analytics_profiling_rules 模块 – 终端分析分析规则的资源模块

注意

此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.endpoint_analytics_profiling_rules

cisco.dnac 6.16.0 中的新增功能

概要

  • 此模块表示模块 endpoint_analytics_profiling_rules_v1 的别名

注意

此模块具有相应的 操作插件

要求

执行此模块的主机需要满足以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

clusterId

字符串

ML 集群的唯一标识符。仅适用于“ML 规则”。

conditionGroups

字典

终端分析分析规则的 conditionGroups。

condition

字典

终端分析分析规则的 condition。

attribute

字符串

终端分析分析规则的 attribute。

attributeDictionary

字符串

终端分析分析规则的 attributeDictionary。

operator

字符串

终端分析分析规则的 operator。

value

字符串

终端分析分析规则的 value。

conditionGroup

列表 / 元素=字符串

终端分析分析规则的 conditionGroup。

operator

字符串

终端分析分析规则的 operator。

type

字符串

终端分析分析规则的 type。

dnac_debug

布尔值

用于 Cisco DNA Center SDK 以启用调试的标志。

选择

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认: "admin"

dnac_verify

布尔值

用于启用或禁用 SSL 证书验证的标志。

选择

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 使用哪个版本的 Cisco DNA Center。

默认: "2.3.7.6"

isDeleted

布尔值

指示是否已删除规则的标志。

选择

  • false

  • true

lastModifiedBy

字符串

上次修改规则的用户。它是只读的,如果作为输入请求的一部分提供,则会被忽略。

lastModifiedOn

整数

上次修改的时间戳(以 epoch 毫秒为单位)。它是只读的,如果作为输入请求的一部分提供,则会被忽略。

pluginId

字符串

规则的插件。仅适用于“Cisco 默认”规则。

rejected

布尔值

指示用户是否已拒绝该规则的标志。仅适用于“ML 规则”。

选择

  • false

  • true

result

字典

终端分析分析规则的结果。

deviceType

列表 / 元素=字符串

当前规则确定的设备类型列表。

hardwareManufacturer

列表 / 元素=字符串

当前规则确定的硬件制造商列表。

hardwareModel

列表 / 元素=字符串

当前规则确定的硬件型号列表。

operatingSystem

列表 / 元素=字符串

当前规则确定的操作系统列表。

ruleId

字符串

规则的唯一标识符。这通常由系统生成,客户端无需为需要新创建的规则提供它。

ruleName

字符串

规则的人类可读名称。

rulePriority

整数

规则的优先级。

ruleType

字符串

规则的类型。

ruleVersion

整数

规则的版本。

sourcePriority

整数

规则的源优先级。

usedAttributes

列表 / 元素=字符串

规则中使用的属性列表。仅适用于“Cisco 默认”规则。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用根据 JSON 架构验证请求正文的标志。

选择

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 ai_endpoint_analytics.AIEndpointAnalytics.create_a_profiling_rule_v1、ai_endpoint_analytics.AIEndpointAnalytics.delete_an_existing_profiling_rule_v1、ai_endpoint_analytics.AIEndpointAnalytics.update_an_existing_profiling_rule_v1,

  • 使用的路径是 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},

  • 应该注意的是,此模块是 endpoint_analytics_profiling_rules_v1 的别名

  • 不支持 check_mode

  • 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数供 Cisco DNAC Python SDK 用于建立连接

示例

- 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:
      - 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

- 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:
      - 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

- 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

返回值

通用返回值已在此处记录 此处,以下是此模块特有的字段

描述

dnac_response

字典

一个字典或列表,包含 Cisco DNAC Python SDK 返回的响应

返回: 始终

示例: {"id": "string", "link": "string"}

作者

  • Rafael Campos (@racampos)