cisco.dnac.endpoint_analytics_endpoints 模块 – 端点分析端点的资源模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.endpoint_analytics_endpoints

cisco.dnac 6.16.0 中的新增功能

概要

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

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceType

字符串

此端点所代表的设备类型。

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"

epId

字符串

EpId 路径参数。端点的唯一标识符。

hardwareManufacturer

字符串

端点的硬件制造商。

hardwareModel

字符串

端点的硬件型号。

macAddress

字符串

端点的 MAC 地址。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 ai_endpoint_analytics.AIEndpointAnalytics.delete_an_endpoint_v1、aiendpoint_analytics.AIEndpointAnalytics.register_an_endpoint_v1、aiendpoint_analytics.AIEndpointAnalytics.update_a_registered_endpoint_v1,

  • 使用的路径是 post /dna/intent/api/v1/endpoint-analytics/endpoints、delete /dna/intent/api/v1/endpoint-analytics/endpoints/{epId}、put /dna/intent/api/v1/endpoint-analytics/endpoints/{epId},

  • 需要注意的是,此模块是 endpoint_analytics_endpoints_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

AI 端点分析 RegisterAnEndpointV1 的 Cisco DNA Center 文档

RegisterAnEndpointV1 API 的完整参考。

AI 端点分析 DeleteAnEndpointV1 的 Cisco DNA Center 文档

DeleteAnEndpointV1 API 的完整参考。

AI 端点分析 UpdateARegisteredEndpointV1 的 Cisco DNA Center 文档

UpdateARegisteredEndpointV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.endpoint_analytics_endpoints:
    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
    deviceType: string
    hardwareManufacturer: string
    hardwareModel: string
    macAddress: string

- name: Update by id
  cisco.dnac.endpoint_analytics_endpoints:
    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
    deviceType: string
    epId: string
    hardwareManufacturer: string
    hardwareModel: string

- name: Delete by id
  cisco.dnac.endpoint_analytics_endpoints:
    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
    epId: string

返回值

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

描述

dnac_response

字典

Cisco DNAC Python SDK 返回的响应字典或列表

返回值:始终返回

示例: {}

作者

  • Rafael Campos (@racampos)