.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.sites_telemetry_settings_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sites_telemetry_settings module -- Resource module for Sites Telemetry Settings ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.28.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.sites_telemetry_settings`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.15.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module sites\_telemetry\_settings\_v1 .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.sites_telemetry_settings_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-applicationvisibility: .. rst-class:: ansible-option-title **applicationVisibility** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sites Telemetry Settings's applicationVisibility. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-applicationvisibility/collector: .. rst-class:: ansible-option-title **collector** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sites Telemetry Settings's collector. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-applicationvisibility/collector/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-applicationvisibility/collector/collectortype: .. rst-class:: ansible-option-title **collectorType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Collector Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-applicationvisibility/collector/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Min 1; Max 65535. If collection type is 'TelemetryBrokerOrUDPDirector', this field value is mandatory otherwise it is optional. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-applicationvisibility/enableonwiredaccessdevices: .. rst-class:: ansible-option-title **enableOnWiredAccessDevices** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable Netflow Application Telemetry and Controller Based Application Recognition (CBAR) by default upon network device site assignment for wired access devices. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Site Id, retrievable from the \`id\` attribute in \`/dna/intent/api/v1/sites\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-snmptraps: .. rst-class:: ansible-option-title **snmpTraps** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sites Telemetry Settings's snmpTraps. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-snmptraps/externaltrapservers: .. rst-class:: ansible-option-title **externalTrapServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
External SNMP trap servers. Example "250.162.252.170","2001 db8 3c4d 15 1a2f 1a2b". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-snmptraps/usebuiltintrapserver: .. rst-class:: ansible-option-title **useBuiltinTrapServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable this server as a destination server for SNMP traps and messages from your network. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-syslogs: .. rst-class:: ansible-option-title **syslogs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sites Telemetry Settings's syslogs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-syslogs/externalsyslogservers: .. rst-class:: ansible-option-title **externalSyslogServers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
External syslog servers. Example "250.162.252.170", "2001 db8 3c4d 15 1a2f 1a2b". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-syslogs/usebuiltinsyslogserver: .. rst-class:: ansible-option-title **useBuiltinSyslogServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable this server as a destination server for syslog messages. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-wireddatacollection: .. rst-class:: ansible-option-title **wiredDataCollection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sites Telemetry Settings's wiredDataCollection. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-wireddatacollection/enablewireddatacollectio: .. rst-class:: ansible-option-title **enableWiredDataCollectio** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-wirelesstelemetry: .. rst-class:: ansible-option-title **wirelessTelemetry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sites Telemetry Settings's wirelessTelemetry. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__parameter-wirelesstelemetry/enablewirelesstelemetry: .. rst-class:: ansible-option-title **enableWirelessTelemetry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enables Streaming Telemetry on your wireless controllers in order to determine the health of your wireless controller, access points and wireless clients. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Network Settings SetTelemetrySettingsForASiteV1 `_ Complete reference of the SetTelemetrySettingsForASiteV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.sites_telemetry_settings_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors