cisco.dnac.custom_issue_definitions_info 模块 – 自定义问题定义信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定: cisco.dnac.custom_issue_definitions_info
。
cisco.dnac 6.15.0 中的新增功能
摘要
此模块表示模块 custom_issue_definitions_v1_info 的别名。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
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。 默认值: |
|
Facility 查询参数。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。 选项
|
|
Limit 查询参数。要返回的记录的最大数量。 |
|
Mnemonic 查询参数。syslog 助记符名称。 |
|
Name 查询参数。UDI 问题名称列表。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是基于 1 的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序,升序或降序。 |
|
Priority 查询参数。问题优先级值,可能的值为 P1、P2、P3、P4。P1 需要立即关注并可能对网络操作产生广泛影响的关键问题。P2 可能影响多个设备或客户端的主要问题。P3 对网络影响局部或最小的次要问题。P4 可能不是立即问题但解决它可以优化网络性能的警告问题。 |
|
ProfileId 查询参数。用于获取与配置文件关联的自定义问题定义的配置文件标识符。默认为全局。对于自定义配置文件,它是配置文件 UUID。例如 3fa85f64-5717-4562-b3fc-2c963f66afa6。 |
|
Severity 查询参数。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,
需要注意的是,此模块是 custom_issue_definitions_v1_info 的别名。
支持
check_mode
插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
参见
另请参见
- 有关 Issues GetAllTheCustomIssueDefinitionsBasedOnTheGivenFiltersV1 的 Cisco DNA Center 文档
GetAllTheCustomIssueDefinitionsBasedOnTheGivenFiltersV1 API 的完整参考。
示例
- name: Get all Custom Issue Definitions Info
cisco.dnac.custom_issue_definitions_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 返回的响应的字典或列表 返回:始终 示例: |