W3cubDocs

/Ansible

cisco.dnac.sites_telemetry_settings module – Resource module for Sites Telemetry Settings

Note

This module is part of the cisco.dnac collection (version 6.31.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.sites_telemetry_settings.

New in cisco.dnac 6.15.0

Synopsis

  • This module represents an alias of the module sites_telemetry_settings_v1

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

applicationVisibility

dictionary

Sites Telemetry Settings’s applicationVisibility.

collector

dictionary

Sites Telemetry Settings’s collector.

address

string

IP Address. If collection type is ‘TelemetryBrokerOrUDPDirector’, this field value is mandatory otherwise it is optional. Examples “250.162.252.170”, “2001 db8 3c4d 15 1a2f 1a2b”.

collectorType

string

Collector Type.

port

integer

Min 1; Max 65535. If collection type is ‘TelemetryBrokerOrUDPDirector’, this field value is mandatory otherwise it is optional.

enableOnWiredAccessDevices

boolean

Enable Netflow Application Telemetry and Controller Based Application Recognition (CBAR) by default upon network device site assignment for wired access devices.

Choices:

  • false
  • true

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)
  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false
  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

id

string

Id path parameter. Site Id, retrievable from the `id` attribute in `/dna/intent/api/v1/sites`.

snmpTraps

dictionary

Sites Telemetry Settings’s snmpTraps.

externalTrapServers

list / elements=string

External SNMP trap servers. Example “250.162.252.170”,”2001 db8 3c4d 15 1a2f 1a2b”.

useBuiltinTrapServer

boolean

Enable this server as a destination server for SNMP traps and messages from your network.

Choices:

  • false
  • true

syslogs

dictionary

Sites Telemetry Settings’s syslogs.

externalSyslogServers

list / elements=string

External syslog servers. Example “250.162.252.170”, “2001 db8 3c4d 15 1a2f 1a2b”.

useBuiltinSyslogServer

boolean

Enable this server as a destination server for syslog messages.

Choices:

  • false
  • true

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false
  • true ← (default)

wiredDataCollection

dictionary

Sites Telemetry Settings’s wiredDataCollection.

enableWiredDataCollectio

boolean

Track the presence, location, and movement of wired endpoints in the network. Traffic received from endpoints is used to extract and store their identity information (MAC address and IP address). Other features, such as IEEE 802.1X, web authentication, Cisco Security Groups (formerly TrustSec), SD-Access, and Assurance, depend on this identity information to operate properly. Wired Endpoint Data Collection enables Device Tracking policies on devices assigned to the Access role in Inventory.

Choices:

  • false
  • true

wirelessTelemetry

dictionary

Sites Telemetry Settings’s wirelessTelemetry.

enableWirelessTelemetry

boolean

Enables Streaming Telemetry on your wireless controllers in order to determine the health of your wireless controller, access points and wireless clients.

Choices:

  • false
  • true

Notes

Note

  • SDK Method used are network_settings.NetworkSettings.set_telemetry_settings_for_a_site_v1,
  • Paths used are put /dna/intent/api/v1/sites/{id}/telemetrySettings,
  • It should be noted that this module is an alias of sites_telemetry_settings_v1
  • Does not support check_mode
  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Network Settings SetTelemetrySettingsForASiteV1

Complete reference of the SetTelemetrySettingsForASiteV1 API.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/sites_telemetry_settings_module.html