cisco.dnac.endpoint_analytics_endpoints_v1_info 模块 – Endpoint Analytics Endpoints 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_v1_info。
cisco.dnac 6.16.0 中的新增功能
概要
获取所有 Endpoint Analytics Endpoints V1。
按 id 获取 Endpoint Analytics Endpoints V1。
获取给定唯一标识符“epId”的端点的详细信息。
查询端点，可以选择使用各种筛选器和分页条件。 “GET /endpoints/count”API 可用于查找与筛选器条件匹配的端点总数。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
AiSpoofingTrustLevel 查询参数。由于 AI 欺骗而导致的端点的信任级别。 可能的值为“low”、“medium”、“high”。 |
|
AncPolicy 查询参数。 ANC 策略。 只会返回完全匹配项。 |
|
AuthMethod 查询参数。 身份验证方法。 允许使用部分字符串。 |
|
ChangedProfileTrustLevel 查询参数。 由于更改配置文件标签而导致的端点的信任级别。 可能的值为“low”、“medium”、“high”。 |
|
ConcurrentMacTrustLevel 查询参数。由于并发 MAC 地址而导致的端点的信任级别。 可能的值为“low”、“medium”、“high”。 |
|
DeviceType 查询参数。要搜索的设备类型。 允许使用部分字符串。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用哪个版本的 Cisco DNA Center。 默认值： |
|
EpId 路径参数。端点的唯一标识符。 |
|
HardwareManufacturer 查询参数。要搜索的硬件制造商。 允许使用部分字符串。 |
|
HardwareModel 查询参数。要搜索的硬件型号。 允许使用部分字符串。 |
|
其他标头。 |
|
Include 查询参数。应包含在响应中的数据集。 默认情况下，此参数的值为空，响应将仅包含端点的基本详细信息。 要包含其他数据集或字典，请发送以逗号分隔的以下值列表 “ALL” - 包括所有属性。“CDP”、“DHCP”等 - 包括给定字典中的属性。 要获取字典的完整列表，请使用相应的 GET API。“ANC” - 包括 ANC 策略相关详细信息。“TRUST” - 包括信任分数详细信息。 |
|
Ip 查询参数。 要搜索的 IP 地址。 允许使用部分字符串。 |
|
IpBlocklistDetected 查询参数。 用于提取命中 IP 黑名单或未命中的端点的标志。 选项
|
|
Limit 查询参数。要获取的最大记录数。如果未提供，则默认获取 50 条记录。一次最多可以获取 1000 条记录。如果需要获取更多记录，请使用分页。 |
|
MacAddress 查询参数。要搜索的 MAC 地址。允许使用部分字符串。 |
|
MacAddresses 查询参数。用于筛选的 MAC 地址列表。仅返回完全匹配项。 |
|
NatTrustLevel 查询参数。由于 NAT 访问，端点的信任级别。可能的值为 ‘low’、‘medium’、‘high’。 |
|
Offset 查询参数。开始获取数据的记录偏移量。偏移量从零开始。 |
|
OperatingSystem 查询参数。要搜索的操作系统。允许使用部分字符串。 |
|
Order 查询参数。用于排序的顺序。可能的值为 ‘asc’、‘desc’。 |
|
PostureStatus 查询参数。姿势状态。 |
|
ProfilingStatus 查询参数。端点的分析状态。可能的值为 ‘profiled’、‘partialProfiled’、‘notProfiled’。 |
|
RandomMac 查询参数。用于获取具有随机 MAC 的端点的标志。 选项
|
|
Registered 查询参数。用于获取手动注册或未注册端点的标志。 选项
|
|
SortBy 查询参数。用于对结果进行排序的列名。请注意，如果请求排序，则获取可能需要更长时间。可能的值为 ‘macAddress’、‘ip’。 |
|
TrustScore 查询参数。端点的总体信任分数。它可以作为数字值（例如 5）或范围（例如 3-7）提供。如果要搜索所有未分配信任分数的端点，请提供值 ‘-’。 |
|
UnauthPortDetected 查询参数。用于获取暴露未经授权端口的端点的标志。 选项
|
|
Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。 选项
|
|
WeakCredDetected 查询参数。用于获取具有弱凭据的端点的标志。 选项
|
备注
注意
使用的 SDK 方法是 ai_endpoint_analytics.AIEndpointAnalytics.get_endpoint_details_v1, aiendpoint_analytics.AIEndpointAnalytics.query_the_endpoints_v1,
使用的路径是 get /dna/intent/api/v1/endpoint-analytics/endpoints, get /dna/intent/api/v1/endpoint-analytics/endpoints/{epId},
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center AI 端点分析 GetEndpointDetailsV1 的文档
GetEndpointDetailsV1 API 的完整参考。
- Cisco DNA Center AI 端点分析 QueryTheEndpointsV1 的文档
QueryTheEndpointsV1 API 的完整参考。
示例
- name: Get all Endpoint Analytics Endpoints V1
cisco.dnac.endpoint_analytics_endpoints_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
limit: 0
offset: 0
sortBy: string
order: string
include: string
register: result
- name: Get Endpoint Analytics Endpoints V1 by id
cisco.dnac.endpoint_analytics_endpoints_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}}"
include: string
epId: string
register: result
返回值
常见返回值记录在此处 这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco DNAC Python SDK 返回的响应 返回: 总是 示例: |