cisco.dnac.custom_issue_definitions 模块 – 自定义问题定义的资源模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您使用的是 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 需求 以了解详细信息。

要在剧本中使用它,请指定:cisco.dnac.custom_issue_definitions

cisco.dnac 6.15.0 中的新增功能

概要

  • 此模块表示模块 custom_issue_definitions_v1 的别名

注意

此模块具有相应的 action 插件

需求

执行此模块的主机需要以下需求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

description

字符串

描述。

dnac_debug

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用调试。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

布尔值

标志,用于启用或禁用 SSL 证书验证。

选项

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 使用哪个版本的 Cisco DNA Center。

默认值: "2.3.7.6"

headers

字典

附加标头。

id

字符串

Id 路径参数。自定义问题定义标识符。

isEnabled

布尔值

已启用。

选项

  • false

  • true

isNotificationEnabled

布尔值

已启用通知。

选项

  • false

  • true

name

字符串

名称。

priority

字符串

优先级。

rules

列表 / 元素=字典

自定义问题定义的规则。

durationInMinutes

整数

持续时间(分钟)。

facility

字符串

设备。

mnemonic

字符串

助记符。

occurrences

整数

出现次数。

pattern

字符串

模式。

severity

整数

严重性。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用针对 JSON 架构的请求正文验证。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 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},

  • 需要注意的是,此模块是 custom_issue_definitions_v1 的别名

  • 不支持 check_mode

  • 插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参见

另请参见

Cisco DNA Center Issues CreatesANewUserDefinedIssueDefinitionsV1 文档

CreatesANewUserDefinedIssueDefinitionsV1 API 的完整参考。

Cisco DNA Center Issues DeletesAnExistingCustomIssueDefinitionV1 文档

DeletesAnExistingCustomIssueDefinitionV1 API 的完整参考。

Cisco DNA Center Issues UpdatesAnExistingCustomIssueDefinitionBasedOnTheProvidedIdV1 文档

UpdatesAnExistingCustomIssueDefinitionBasedOnTheProvidedIdV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.custom_issue_definitions:
    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:
    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:
    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

返回值

常见的返回值已记录在 此处,以下是此模块特有的字段

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回: 始终

示例: {"response": {"createdTime": 0, "description": "string", "id": "string", "isDeletable": true, "isEnabled": true, "isNotificationEnabled": true, "lastUpdatedTime": 0, "name": "string", "priority": "string", "profileId": "string", "rules": [{"durationInMinutes": 0, "facility": "string", "mnemonic": "string", "occurrences": 0, "pattern": "string", "severity": 0, "type": "string"}], "triggerId": "string"}}

作者

  • Rafael Campos (@racampos)