cisco.dnac.endpoint_analytics_profiling_rules_info 模块 – 端点分析分析规则信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在剧本中使用它,请指定:cisco.dnac.endpoint_analytics_profiling_rules_info
。
cisco.dnac 6.16.0 中的新增功能
概要
此模块代表模块 endpoint_analytics_profiling_rules_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认: |
|
附加的 headers。 |
|
IncludeDeleted 查询参数。指示是否应将已删除规则作为获取的记录的一部分的标志。 选项
|
|
Limit 查询参数。要获取的记录的最大数量。如果未提供,则默认情况下将获取 500 条记录。要获取系统中的所有记录,请为此参数提供较大的值。 |
|
Offset 查询参数。从中开始数据获取的记录偏移量。偏移量从零开始。 |
|
Order 查询参数。用于排序的顺序。 |
|
RuleId 路径参数。唯一的规则标识符。 |
|
RuleType 查询参数。使用逗号分隔的规则类型列表来过滤数据。默认为“自定义规则”。 |
|
SortBy 查询参数。用于对结果排序的列的名称。请注意,如果请求排序,则获取可能需要更多时间。 |
|
用于 Cisco DNA Center SDK 以启用针对 JSON 架构验证请求体的标志。 选项
|
注释
注意
使用的 SDK 方法是 ai_endpoint_analytics.AIEndpointAnalytics.get_details_of_a_single_profiling_rule_v1、ai_endpoint_analytics.AIEndpointAnalytics.get_list_of_profiling_rules_v1,
使用的路径是 get /dna/intent/api/v1/endpoint-analytics/profiling-rules、get /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId},
需要注意的是,此模块是 endpoint_analytics_profiling_rules_v1_info 的别名
支持
check_mode
该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
示例
- name: Get all Endpoint Analytics Profiling Rules Info
cisco.dnac.endpoint_analytics_profiling_rules_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}}"
ruleType: string
includeDeleted: True
limit: 0
offset: 0
sortBy: string
order: string
register: result
- name: Get Endpoint Analytics Profiling Rules Info by id
cisco.dnac.endpoint_analytics_profiling_rules_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}}"
ruleId: string
register: result
返回值
常见的返回值已在此处记录 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回:始终 示例: |