cisco.dnac.custom_issue_definitions_v1 模块 – 自定义问题定义 V1 的资源模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您使用的是 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:cisco.dnac.custom_issue_definitions_v1
。
cisco.dnac 6.15.0 中的新增功能
概要
管理资源自定义问题定义 V1 的创建、更新和删除操作。
使用提供的输入请求数据创建一个新的自定义问题定义。此问题定义的唯一标识符是 id。请注意,问题名称不能重复。定义基于 syslog。有关 API 使用的详细信息,请参阅 Open API 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- AssuranceUserDefinedIssueAPIs-1.0.0-resolved.yaml。
基于 Id 删除现有的自定义问题定义。只有全局配置文件问题有权删除问题定义,因此不需要配置文件 id。有关 API 使用的详细信息,请参阅 Open API 规范文档 - https //github.com/cisco-en-programmability/catalyst-center- api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceUserDefinedIssueAPIs-1.0.0-resolved.yaml。
基于提供的 Id 更新现有的自定义问题定义。有关 API 使用的详细信息,请参阅 Open API 规范文档 - https //github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- AssuranceUserDefinedIssueAPIs-1.0.0-resolved.yaml。
注意
此模块具有相应的 操作插件。
要求
在执行此模块的主机上需要满足以下要求。
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。 默认: |
|
其他标头。 |
|
Id 路径参数。自定义问题定义标识符。 |
|
已启用。 选项
|
|
已启用通知。 选项
|
|
名称。 |
|
优先级。 |
|
自定义问题定义的规则。 |
|
持续时间(分钟)。 |
|
设备。 |
|
助记符。 |
|
出现次数。 |
|
模式。 |
|
严重性。 |
|
Cisco DNA Center SDK 用于启用针对 JSON 架构验证请求主体的标志。 选项
|
注释
注意
使用的 SDK 方法包括 issues.Issues.creates_a_new_user_defined_issue_definitions_v1、issues.Issues.deletes_an_existing_custom_issue_definition_v1 和 issues.Issues.updates_an_existing_custom_issue_definition_based_on_the_provided_id_v1。
使用的路径包括 post /dna/intent/api/v1/customIssueDefinitions、delete /dna/intent/api/v1/customIssueDefinitions/{id} 和 put /dna/intent/api/v1/customIssueDefinitions/{id}。
不支持
check_mode
该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
参见
参见
- 有关 Issues CreatesANewUserDefinedIssueDefinitionsV1 的 Cisco DNA Center 文档
CreatesANewUserDefinedIssueDefinitionsV1 API 的完整参考。
- 有关 Issues DeletesAnExistingCustomIssueDefinitionV1 的 Cisco DNA Center 文档
DeletesAnExistingCustomIssueDefinitionV1 API 的完整参考。
- 有关 Issues UpdatesAnExistingCustomIssueDefinitionBasedOnTheProvidedIdV1 的 Cisco DNA Center 文档
UpdatesAnExistingCustomIssueDefinitionBasedOnTheProvidedIdV1 API 的完整参考。
示例
- name: Create
cisco.dnac.custom_issue_definitions_v1:
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}}"
state: present
description: string
headers: '{{my_headers | from_json}}'
isEnabled: true
isNotificationEnabled: true
name: string
priority: string
rules:
- durationInMinutes: 0
facility: string
mnemonic: string
occurrences: 0
pattern: string
severity: 0
- name: Update by id
cisco.dnac.custom_issue_definitions_v1:
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}}"
state: present
description: string
headers: '{{my_headers | from_json}}'
id: string
isEnabled: true
isNotificationEnabled: true
name: string
priority: string
rules:
- durationInMinutes: 0
facility: string
mnemonic: string
occurrences: 0
pattern: string
severity: 0
- name: Delete by id
cisco.dnac.custom_issue_definitions_v1:
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}}"
state: absent
id: string
返回值
通用返回值记录在此处,以下是此模块特有的字段。
键 |
描述 |
---|---|
一个字典或列表,包含 Cisco DNAC Python SDK 返回的响应。 返回: 始终 示例: |