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

Note

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

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 1.0.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.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

applicationVisibility

dictionary

Sites Telemetry Settings's applicationVisibility.

collector

dictionary

Sites Telemetry Settings's collector.

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

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_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 `/intent/api/v1/sites`.

snmpTraps

dictionary

Sites Telemetry Settings's snmpTraps.

externalTrapServers

list / elements=dictionary

External SNMP trap servers.

useBuiltinTrapServer

boolean

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

Choices:

syslogs

dictionary

Devices will be configured to send syslog messages to these servers with syslog severity level 6 (information) or worse.

externalSyslogServers

list / elements=dictionary

External syslog servers.

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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst 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: {}
    id: e298f95b-cd70-48ae-a590-b2076bfb6033
    snmpTraps: {}
    syslogs: {}
    wiredDataCollection: {}
    wirelessTelemetry: {}

Return Values

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

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)