cisco.dnac.dna_event_snmp_config_info 模块 – 用于 Dna Event Snmp Config Info 的信息模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

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

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

configId

字符串

ConfigId 查询参数。SNMP 配置列表。

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

字典

其他标头。

limit

浮点数

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

offset

浮点数

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

order

字符串

顺序查询参数。

sortBy

字符串

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

validate_response_schema

布尔值

用于使 Cisco DNA Center SDK 能够验证请求正文是否符合 JSON 架构的标志。

选项

  • false

  • true ←(默认)

注释

注意

  • SDK 使用的方法为 event_management.EventManagement.get_snmp_destination_v1,

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

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Event Management GetSNMPDestinationV1

GetSNMPDestinationV1 API 的完整参考。

示例

- name: Get all Dna Event Snmp Config Info
  cisco.dnac.dna_event_snmp_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
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

返回值

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

描述

dnac_response

列表 / 元素=字典

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

返回:始终

示例: "[\n  {\n    \"version\": \"string\",\n    \"tenantId\": \"string\",\n    \"configId\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"ipAddress\": \"string\",\n    \"port\": 0,\n    \"snmpVersion\": \"string\",\n    \"community\": \"string\",\n    \"userName\": \"string\",\n    \"snmpMode\": \"string\",\n    \"snmpAuthType\": \"string\",\n    \"authPassword\": \"string\",\n    \"snmpPrivacyType\": \"string\",\n    \"privacyPassword\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)