cisco.dnac.sites_telemetry_settings 模块 – 用于站点遥测设置的资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新功能

概要 

此模块表示模块 sites_telemetry_settings_v1 的别名

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
applicationVisibility 字典	站点遥测设置的 applicationVisibility。
collector 字典	站点遥测设置的 collector。
address 字符串	IP 地址。如果收集类型为“TelemetryBrokerOrUDPDirector”，则此字段值为强制性，否则为可选。示例 “250.162.252.170”、“2001 db8 3c4d 15 1a2f 1a2b”。
collectorType 字符串	收集器类型。
port 整数	最小值 1；最大值 65535。如果收集类型为“TelemetryBrokerOrUDPDirector”，则此字段值为强制性，否则为可选。
enableOnWiredAccessDevices 布尔值	在有线接入设备的网络设备站点分配时，默认启用 Netflow 应用程序遥测和基于控制器的应用程序识别 (CBAR)。选项 `false` `true`
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"`
id 字符串	Id 路径参数。站点 ID，可从 `/dna/intent/api/v1/sites` 中的 `id` 属性检索。
snmpTraps 字典	站点遥测设置的 snmpTraps。
externalTrapServers 列表 / 元素=字符串	外部 SNMP trap 服务器。示例 “250.162.252.170”,”2001 db8 3c4d 15 1a2f 1a2b”。
useBuiltinTrapServer 布尔值	启用此服务器作为来自您的网络的 SNMP trap 和消息的目标服务器。选项 `false` `true`
syslogs 字典	站点遥测设置的 syslogs。
externalSyslogServers 列表 / 元素=字符串	外部 syslog 服务器。示例 “250.162.252.170”、“2001 db8 3c4d 15 1a2f 1a2b”。
useBuiltinSyslogServer 布尔值	启用此服务器作为 syslog 消息的目标服务器。选项 `false` `true`
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式的请求正文验证。选项 `false` `true` ← (默认)
wiredDataCollection 字典	站点遥测设置的 wiredDataCollection。
enableWiredDataCollectio 布尔值	跟踪网络中有线端点的存在、位置和移动。从端点接收的流量用于提取和存储其身份信息（MAC 地址和 IP 地址）。其他功能，例如 IEEE 802.1X、Web 身份验证、Cisco 安全组（以前称为 TrustSec）、SD-Access 和 Assurance，都依赖于此身份信息才能正常运行。有线端点数据收集允许在分配到清单中接入角色的设备上执行设备跟踪策略。选项 `false` `true`
wirelessTelemetry 字典	站点遥测设置的 wirelessTelemetry。
enableWirelessTelemetry 布尔值	在无线控制器上启用流式遥测，以便确定无线控制器、接入点和无线客户端的运行状况。选项 `false` `true`

备注 

注意

使用的 SDK 方法是 network_settings.NetworkSettings.set_telemetry_settings_for_a_site_v1,
使用的路径是 put /dna/intent/api/v1/sites/{id}/telemetrySettings,
应注意，此模块是 sites_telemetry_settings_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 文档，了解 Network Settings SetTelemetrySettingsForASiteV1: SetTelemetrySettingsForASiteV1 API 的完整参考。

示例 

- name: Update all
  cisco.dnac.sites_telemetry_settings:
    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
    applicationVisibility:
      collector:
        address: string
        collectorType: string
        port: 0
      enableOnWiredAccessDevices: true
    id: string
    snmpTraps:
      externalTrapServers:
      - string
      useBuiltinTrapServer: true
    syslogs:
      externalSyslogServers:
      - string
      useBuiltinSyslogServer: true
    wiredDataCollection:
      enableWiredDataCollectio: true
    wirelessTelemetry:
      enableWirelessTelemetry: true

返回值 

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

键	描述
dnac_response 字典	一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应返回：总是示例： `{"response": {"taskId": "字符串", "url": "字符串"}, "version": "字符串"}`

作者

Rafael Campos (@racampos)