cisco.dnac.event_syslog_config_info 模块 – 事件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_info

cisco.dnac 3.1.0中的新增功能

概要

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

注意

此模块具有相应的 action插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

configId

字符串

ConfigId 查询参数。syslog服务器的配置ID。

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

字典

附加的header。

limit

浮点数

Limit 查询参数。结果集中要限制的syslog配置数量,默认值为10。

name

字符串

Name 查询参数。syslog服务器的名称。

offset

浮点数

Offset 查询参数。结果集中要偏移的syslog配置数量,默认值为0。

order

字符串

Order 查询参数。

protocol

字符串

Protocol 查询参数。syslog服务器的协议。

sortBy

字符串

SortBy 查询参数。SortBy 字段名称。

validate_response_schema

布尔值

用于Cisco DNA Center SDK以启用根据JSON模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

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

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

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center关于事件管理GetSyslogDestinationV1的文档

GetSyslogDestinationV1 API的完整参考。

示例

- name: Get all Event Syslog Config Info
  cisco.dnac.event_syslog_config_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}}"
    configId: string
    name: string
    protocol: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"apiStatus": "string", "errorMessage": {"errors": ["string"]}, "statusMessage": [{"configId": "string", "description": "string", "host": "string", "name": "string", "port": 0, "protocol": "string", "tenantId": "string", "version": "string"}]}

作者

  • Rafael Campos (@racampos)