cisco.dnac.event_syslog_config 模块 – 事件 Syslog 配置的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。 您需要进一步的要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:cisco.dnac.event_syslog_config

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

此模块具有相应的 操作插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

configId

字符串

仅在更新 syslog 配置时需要。

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"

host

字符串

主机。

name

字符串

名称。

port

整数

端口。

protocol

字符串

协议。

validate_response_schema

布尔值

Cisco DNA Center SDK 用于启用针对 JSON 模式验证请求体的标志。

选择

  • false

  • true ←(默认)

备注

注意

  • 使用的 SDK 方法是 event_management.EventManagement.create_syslog_destination_v1,event_management.EventManagement.update_syslog_destination_v1,

  • 使用的路径是 post /dna/intent/api/v1/event/syslog-config,put /dna/intent/api/v1/event/syslog-config,

  • 应该注意的是,此模块是 event_syslog_config_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 有关事件管理 CreateSyslogDestinationV1 的文档

CreateSyslogDestinationV1 API 的完整参考。

Cisco DNA Center 有关事件管理 UpdateSyslogDestinationV1 的文档

UpdateSyslogDestinationV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.event_syslog_config:
    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
    configId: string
    description: string
    host: string
    name: string
    port: 0
    protocol: string

- name: Create
  cisco.dnac.event_syslog_config:
    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
    configId: string
    description: string
    host: string
    name: string
    port: 0
    protocol: string

返回值

通用返回值在此处记录 此处,以下是此模块独有的字段

描述

dnac_response

字典

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

已返回: 总是

示例: {"apiStatus": "string", "errorMessage": {"errors": ["string"]}, "statusMessage": "string"}

作者

  • Rafael Campos (@racampos)