cisco.dnac.endpoint_analytics_endpoints_info 模块 – Endpoint Analytics 端点信息的 Information 模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 Playbook 中使用它，请指定：cisco.dnac.endpoint_analytics_endpoints_info。
cisco.dnac 6.16.0 中的新增功能
概要
此模块表示模块 endpoint_analytics_endpoints_v1_info 的别名
注意
此模块具有对应的 action 插件。
要求
执行此模块的主机需要满足以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
AiSpoofingTrustLevel 查询参数。由于 AI 欺骗而导致的端点的信任级别。可能的值为“低”、“中”、“高”。 |
|
AncPolicy 查询参数。ANC 策略。将只返回完全匹配的项。 |
|
AuthMethod 查询参数。身份验证方法。允许部分字符串。 |
|
ChangedProfileTrustLevel 查询参数。由于更改配置文件标签而导致的端点的信任级别。可能的值为“低”、“中”、“高”。 |
|
ConcurrentMacTrustLevel 查询参数。由于并发 MAC 地址而导致的端点的信任级别。可能的值为“低”、“中”、“高”。 |
|
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 黑名单的端点或不命中 IP 黑名单的端点的标志。 选项
|
|
Limit 查询参数。要获取的最大记录数。如果未提供，默认情况下将获取 50 条记录。一次最多可以获取 1000 条记录。如果需要获取更多记录，请使用分页。 |
|
MacAddress 查询参数。要搜索的 MAC 地址。允许部分字符串。 |
|
MacAddresses 查询参数。要筛选的 MAC 地址列表。将只返回完全匹配的项。 |
|
NatTrustLevel 查询参数。由于 NAT 访问而导致的端点的信任级别。可能的值为“低”、“中”、“高”。 |
|
偏移查询参数。记录开始获取数据的偏移量。偏移量从零开始。 |
|
OperatingSystem 查询参数。要搜索的操作系统。允许使用部分字符串。 |
|
Order 查询参数。用于排序的顺序。可能的值为 ‘asc’，‘desc’。 |
|
PostureStatus 查询参数。姿势状态。 |
|
ProfilingStatus 查询参数。端点的分析状态。可能的值为 ‘profiled’、‘partialProfiled’、‘notProfiled’。 |
|
RandomMac 查询参数。用于获取具有随机 MAC 地址或不具有随机 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},
应该注意的是，此模块是 endpoint_analytics_endpoints_v1_info 的别名
支持
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 Info
cisco.dnac.endpoint_analytics_endpoints_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 Info by id
cisco.dnac.endpoint_analytics_endpoints_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
返回值
此处记录了常见返回值 here，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应 返回： 始终 示例： |