cisco.dnac.endpoint_analytics_endpoints_count_v1_info 模块 – 端点分析端点数 V1 信息模块

注意

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

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

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

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

cisco.dnac 6.16.0 中的新增功能

概要

  • 获取所有端点分析端点数 V1。

  • 获取匹配给定筛选条件的端点总数。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

aiSpoofingTrustLevel

字符串

AiSpoofingTrustLevel 查询参数。由于 AI 欺骗导致的端点信任级别。可能的值为“低”、“中”、“高”。

ancPolicy

字符串

AncPolicy 查询参数。ANC 策略。仅返回完全匹配项。

authMethod

字符串

AuthMethod 查询参数。身份验证方法。允许部分字符串。

changedProfileTrustLevel

字符串

ChangedProfileTrustLevel 查询参数。由于更改配置文件标签导致的端点信任级别。可能的值为“低”、“中”、“高”。

concurrentMacTrustLevel

字符串

ConcurrentMacTrustLevel 查询参数。由于并发 MAC 地址导致的端点信任级别。可能的值为“低”、“中”、“高”。

deviceType

字符串

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"

hardwareManufacturer

字符串

HardwareManufacturer 查询参数。要搜索的硬件制造商。允许部分字符串。

hardwareModel

字符串

HardwareModel 查询参数。要搜索的硬件型号。允许部分字符串。

headers

字典

附加头。

ip

字符串

Ip 查询参数。要搜索的 IP 地址。允许部分字符串。

ipBlocklistDetected

布尔值

IpBlocklistDetected 查询参数。用于获取命中 IP 黑名单或未命中的端点的标志。

选项

  • false

  • true

macAddress

字符串

MacAddress 查询参数。要搜索的 MAC 地址。允许部分字符串。

macAddresses

列表 / 元素=字符串

MacAddresses 查询参数。要筛选的 MAC 地址列表。仅返回完全匹配项。

natTrustLevel

字符串

NatTrustLevel 查询参数。由于 NAT 访问导致的端点信任级别。可能的值为“低”、“中”、“高”。

operatingSystem

字符串

OperatingSystem 查询参数。要搜索的操作系统。允许部分字符串。

postureStatus

字符串

PostureStatus 查询参数。姿态状态。

profilingStatus

字符串

ProfilingStatus 查询参数。端点的分析状态。可能的值为“已分析”、“部分分析”、“未分析”。

randomMac

布尔值

RandomMac 查询参数。用于获取具有随机 MAC 地址或不具有随机 MAC 地址的端点的标志。

选项

  • false

  • true

registered

布尔值

Registered 查询参数。用于获取手动注册或未注册的端点的标志。

选项

  • false

  • true

trustScore

字符串

TrustScore 查询参数。端点的整体信任分数。它可以作为数值(例如 5)或范围(例如 3-7)提供。如果您想搜索信任分数未分配的所有端点,请将值提供为“-”。

unauthPortDetected

布尔值

UnauthPortDetected 查询参数。用于获取公开未授权端口或未公开未授权端口的端点的标志。

选项

  • false

  • true

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用针对 JSON 架构的请求正文的验证。

选项

  • false

  • true ← (默认)

weakCredDetected

布尔值

WeakCredDetected 查询参数。用于获取具有弱凭据或不具有弱凭据的端点的标志。

选项

  • false

  • true

备注

注意

  • 使用的 SDK 方法为 ai_endpoint_analytics.AIEndpointAnalytics.fetch_the_count_of_endpoints_v1,

  • 使用的路径为 get /dna/intent/api/v1/endpoint-analytics/endpoints/count,

  • 支持 check_mode

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

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

另请参见

另请参见

有关 AI 端点分析 FetchTheCountOfEndpointsV1 的 Cisco DNA Center 文档

FetchTheCountOfEndpointsV1 API 的完整参考。

示例

- name: Get all Endpoint Analytics Endpoints Count V1
  cisco.dnac.endpoint_analytics_endpoints_count_v1_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    profilingStatus: string
    macAddress: string
    macAddresses: []
    ip: string
    deviceType: string
    hardwareManufacturer: string
    hardwareModel: string
    operatingSystem: string
    registered: True
    randomMac: True
    trustScore: string
    authMethod: string
    postureStatus: string
    aiSpoofingTrustLevel: string
    changedProfileTrustLevel: string
    natTrustLevel: string
    concurrentMacTrustLevel: string
    ipBlocklistDetected: True
    unauthPortDetected: True
    weakCredDetected: True
    ancPolicy: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"count": 0}

作者

  • Rafael Campos (@racampos)