cisco.dnac.event_subscription_details_syslog_info 模块 – 事件订阅详细信息syslog信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

此模块具有相应的 action 插件

需求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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

字典

附加头。

instanceId

字符串

InstanceId查询参数。特定配置的实例ID。

limit

浮点数

Limit查询参数。结果集中要限制的Syslog订阅详细信息的数量,其默认值为10。

name

字符串

Name查询参数。特定配置的名称。

offset

浮点数

Offset查询参数。结果集中要偏移的Syslog订阅详细信息的数量,其默认值为0。

order

字符串

Order查询参数。

sortBy

字符串

SortBy查询参数。SortBy字段名。

validate_response_schema

布尔值

用于Cisco DNA Center SDK的标志,用于启用根据JSON模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

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

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

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

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

GetSyslogSubscriptionDetailsV1 API的完整参考。

示例

- name: Get all Event Subscription Details Syslog Info
  cisco.dnac.event_subscription_details_syslog_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}}"
    name: string
    instanceId: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

返回值

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

描述

dnac_response

列表 / 元素=字典

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

返回:始终

示例: "[\n  {\n    \"instanceId\": \"字符串\",\n    \"name\": \"字符串\",\n    \"description\": \"字符串\",\n    \"connectorType\": \"字符串\",\n    \"syslogConfig\": {\n      \"configId\": \"字符串\",\n      \"name\": \"字符串\",\n      \"description\": \"字符串\",\n      \"host\": \"字符串\",\n      \"port\": \"字符串\",\n      \"protocol\": \"字符串\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)