cisco.dnac.event_subscription_details_syslog_v1_info 模块 – 事件订阅详情 Syslog V1 信息模块

注意

此模块是 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_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有事件订阅详情 Syslog V1。

  • 获取指定 connectorType 的订阅详情列表。

注意

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

要求

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

  • 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

字典

附加的 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,

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 事件管理 GetSyslogSubscriptionDetailsV1 文档

GetSyslogSubscriptionDetailsV1 API 的完整参考。

示例

- name: Get all Event Subscription Details Syslog V1
  cisco.dnac.event_subscription_details_syslog_v1_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\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"connectorType\": \"string\",\n    \"syslogConfig\": {\n      \"configId\": \"string\",\n      \"name\": \"string\",\n      \"description\": \"string\",\n      \"host\": \"string\",\n      \"port\": \"string\",\n      \"protocol\": \"string\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)