cisco.dnac.system_issue_definitions_v1_info 模块 – 系统问题定义 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您正在使用 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.system_issue_definitions_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有系统问题定义 V1。
获取所有系统问题定义。支持的过滤器包括 id、name、profileId 和定义启用状态。问题触发器定义在配置文件和设备类型之间可能有所不同。因此，查询参数中的 `profileId` 和 `deviceType` 非常重要，默认值为全局配置文件和所有设备类型。有关 API 用法的详细信息，请参阅 OpenAPI 规范文档 - https //github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- issueAndHealthDefinitions-1.0.0-resolved.yaml。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
属性查询参数。这些是系统问题定义响应中支持的属性。默认情况下，所有属性都包含在响应中。 |
|
DeviceType 查询参数。这些是系统问题定义支持的设备系列/类型。如果未输入设备类型，则认为所有设备类型都适用。 |
|
用于启用 Cisco DNA Center SDK 调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
附加头。 |
|
Id 查询参数。定义标识符。示例 id=015d9cba-4f53-4087-8317-7e49e5ffef46（单个实体 ID 请求） id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47（查询参数中的多个 ID）。 |
|
IssueEnabled 查询参数。问题定义的启用状态，为 true 或 false。 选项
|
|
Limit 查询参数。要返回的最大记录数。 |
|
Name 查询参数。系统定义的问题名称列表。（例如“BGP_Down”）示例 name=BGP_Down（请求单个实体 uuid） name=BGP_Down&name=BGP_Flap（用 & 运算符分隔的多个问题名称）。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是一个基于 1 的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序，升序或降序。 |
|
Priority 查询参数。问题优先级，可能的值为 P1、P2、P3、P4。`P1` 需要立即关注并可能对网络运行产生广泛影响的严重问题。`P2` 可能影响多个设备或客户端的主要问题。`P3` 对网络影响局部或极小的次要问题。`P4` 可能不是立即问题但解决它可以优化网络性能的警告问题。 |
|
ProfileId 查询参数。要获取与其关联的问题定义的配置文件标识符。默认为 `global`。有关详细信息，请参阅网络设计配置文件文档。 |
|
SortBy 查询参数。响应中要排序的字段。 |
|
用于启用 Cisco DNA Center SDK 对照 JSON 模式验证请求主体的标志。 选项
|
备注
注意
使用的 SDK 方法是 issues.Issues.returns_all_issue_trigger_definitions_for_given_filters_v1，
使用的路径是 get /dna/intent/api/v1/systemIssueDefinitions，
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
参见
另见
- 有关 Issues ReturnsAllIssueTriggerDefinitionsForGivenFiltersV1 的 Cisco DNA Center 文档
ReturnsAllIssueTriggerDefinitionsForGivenFiltersV1 API 的完整参考。
示例
- name: Get all System Issue Definitions V1
cisco.dnac.system_issue_definitions_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}}"
deviceType: string
profileId: string
id: string
name: string
priority: string
issueEnabled: True
attribute: string
offset: 0
limit: 0
sortBy: string
order: string
register: result
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值：始终 示例： |