cisco.dnac.event_snmp_config 模块 – 事件 SNMP 配置的资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.dnac.event_snmp_config。

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 event_snmp_config_v1 的别名

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
authPassword 字符串	身份验证密码。
community 字符串	仅当 snmpVersion 为 V2C 时才需要。
configId 字符串	配置 ID。
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"`
ipAddress 字符串	IP 地址。
name 字符串	名称。
port 字符串	端口。
privacyPassword 字符串	隐私密码。
snmpAuthType 字符串	SNMP 身份验证类型。
snmpMode 字符串	如果 snmpVersion 为 V3，则为必需项，且不能为 NONE。
snmpPrivacyType 字符串	SNMP 隐私类型。
snmpVersion 字符串	SNMP 版本。
userName 字符串	仅当 snmpVersion 为 V3 时才需要。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用针对 JSON 架构验证请求正文的标志。选项 `false` `true` ← (默认)

注释 

注意

使用的 SDK 方法为 event_management.EventManagement.create_snmp_destination_v1、event_management.EventManagement.update_snmp_destination_v1，
使用的路径为 post /dna/intent/api/v1/event/snmp-config、put /dna/intent/api/v1/event/snmp-config，
应注意，此模块是 event_snmp_config_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 事件管理 CreateSNMPDestinationV1 文档: CreateSNMPDestinationV1 API 的完整参考。
Cisco DNA Center 事件管理 UpdateSNMPDestinationV1 文档: UpdateSNMPDestinationV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.event_snmp_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
    authPassword: string
    community: string
    description: string
    ipAddress: string
    name: string
    port: string
    privacyPassword: string
    snmpAuthType: string
    snmpMode: string
    snmpPrivacyType: string
    snmpVersion: string
    userName: string

- name: Update all
  cisco.dnac.event_snmp_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
    authPassword: string
    community: string
    configId: string
    description: string
    ipAddress: string
    name: string
    port: string
    privacyPassword: string
    snmpAuthType: string
    snmpMode: string
    snmpPrivacyType: string
    snmpVersion: string
    userName: string

返回值 

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

键	描述
dnac_response 字典	一个字典或列表，包含 Cisco DNAC Python SDK 返回的响应。返回：总是示例： `{"apiStatus": "string", "errorMessage": {"errors": [{}]}, "statusMessage": "string"}`

作者

Rafael Campos (@racampos)