cisco.dnac.custom_issue_definitions_v1_info 模块 – 自定义问题定义 V1 的信息模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您正在使用 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在剧本中使用它,请指定: cisco.dnac.custom_issue_definitions_v1_info
。
cisco.dnac 6.15.0 中的新功能
概要
获取所有自定义问题定义 V1。
检索现有的基于 syslog 的自定义问题定义。支持的过滤器包括 id、名称、profileId、定义启用状态、优先级、严重性、设施和助记符。问题定义配置可能因配置文件而异,因此在查询参数中指定配置文件 ID 非常重要,默认配置文件是全局的。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
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 版本。 默认值: |
|
设施查询参数。syslog 设施名称。 |
|
其他标头。 |
|
Id 查询参数。自定义问题定义标识符,以及配置文件中的唯一标识符。示例 id=6bef213c-19ca-4170-8375-b694e251101c(请求单个实体 uuid)id=6bef213c-19ca-4170-8375-b694e251101c&id=19ca-4170-8375-b694e251101c-6bef213c(在查询参数中请求多个 Id)。 |
|
IsEnabled 查询参数。自定义问题定义的启用状态,为 true 或 false。 选项
|
|
限制查询参数。要返回的最大记录数。 |
|
助记符查询参数。syslog 助记符名称。 |
|
名称查询参数。UDI 问题名称的列表。 |
|
偏移量查询参数。指定 API 返回的所有记录中的起始点。这是一个基于 1 的偏移量。起始值为 1。 |
|
顺序查询参数。字段的排序顺序,升序或降序。 |
|
优先级查询参数。问题优先级值,可能的值为 P1、P2、P3、P4。P1 一个需要立即关注并且可能对网络运行产生广泛影响的关键问题。P2 一个可能影响多个设备或客户端的重大问题。P3 一个影响局部或最小的次要问题。P4 一个警告问题,它可能不是立即的问题,但解决它可以优化网络性能。 |
|
ProfileId 查询参数。用于获取与自定义问题定义关联的配置文件的配置文件标识符。默认值为 global。对于自定义配置文件,它是配置文件 UUID。示例 3fa85f64-5717-4562-b3fc-2c963f66afa6。 |
|
严重性查询参数。syslog 严重级别。0 紧急,1 警报,2 严重。3 错误,4 警告,5 通知,6 信息。示例 severity=1&severity=2(支持使用 & 分隔符的多值)。 |
|
SortBy 查询参数。响应中用于排序的字段。 |
|
用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求正文的标志。 选项
|
备注
注意
使用的 SDK 方法为 issues.Issues.get_all_the_custom_issue_definitions_based_on_the_given_filters_v1,
使用的路径为 get /dna/intent/api/v1/customIssueDefinitions,
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数供 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 文档,了解 Issues GetAllTheCustomIssueDefinitionsBasedOnTheGivenFiltersV1
GetAllTheCustomIssueDefinitionsBasedOnTheGivenFiltersV1 API 的完整参考。
示例
- name: Get all Custom Issue Definitions V1
cisco.dnac.custom_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}}"
id: string
profileId: string
name: string
priority: string
isEnabled: True
severity: 0
facility: string
mnemonic: string
limit: 0
offset: 0
sortBy: string
order: string
register: result
返回值
常见的返回值记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应 返回: 始终 示例: |