cisco.catalystcenter.sites_telemetry_settings module -- Resource module for Sites Telemetry Settings

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

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

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

New in cisco.catalystcenter 6.15.0

Synopsis

  • Manage operation update of the resource Sites Telemetry Settings. - > Sets telemetry settings for the given site; `null` values indicate that the setting will be inherited from the parent site.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

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:

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

Default: :ansible-option-default:`"3.1.6.0"`

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:

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:

validate_response_schema

boolean

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

Choices:

wiredDataCollection

dictionary

Sites Telemetry Settings's wiredDataCollection.

enableWiredDataCollection

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:

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:

Notes

Note

  • SDK Method used are network_settings.NetworkSettings.set_telemetry_settings_for_a_site,

  • Paths used are put /dna/intent/api/v1/sites/{id}/telemetrySettings,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Network Settings SetTelemetrySettingsForASite

Complete reference of the SetTelemetrySettingsForASite API.

Examples

---
- name: Update all
  cisco.catalystcenter.sites_telemetry_settings:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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:
      enableWiredDataCollection: 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: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)