.. 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.sensor_test_template_edit_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sensor_test_template_edit module -- Resource module for Sensor Test Template Edit ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.6.4). 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.sensor_test_template_edit`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation update of the resource Sensor Test Template Edit. - Intent API to deploy, schedule, or edit and existing SENSOR test template. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.sensor_test_template_edit_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.5.5 - 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.sensor_test_template_edit_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.sensor_test_template_edit_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.sensor_test_template_edit_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.sensor_test_template_edit_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.sensor_test_template_edit_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.sensor_test_template_edit_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.sensor_test_template_edit_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.sensor_test_template_edit_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.3.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-locationinfolist: .. rst-class:: ansible-option-title **locationInfoList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor Test Template Edit's locationInfoList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-locationinfolist/allsensors: .. rst-class:: ansible-option-title **allSensors** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
All Sensors. .. 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.sensor_test_template_edit_module__parameter-locationinfolist/locationid: .. rst-class:: ansible-option-title **locationId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Location Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-locationinfolist/locationtype: .. rst-class:: ansible-option-title **locationType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Location Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-locationinfolist/sitehierarchy: .. rst-class:: ansible-option-title **siteHierarchy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site Hierarchy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule: .. rst-class:: ansible-option-title **schedule** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sensor Test Template Edit's schedule. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/frequency: .. rst-class:: ansible-option-title **frequency** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sensor Test Template Edit's frequency. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/frequency/unit: .. rst-class:: ansible-option-title **unit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/frequency/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange: .. rst-class:: ansible-option-title **scheduleRange** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor Test Template Edit's scheduleRange. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange/day: .. rst-class:: ansible-option-title **day** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Day. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange/timerange: .. rst-class:: ansible-option-title **timeRange** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor Test Template Edit's timeRange. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange/timerange/frequency: .. rst-class:: ansible-option-title **frequency** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sensor Test Template Edit's frequency. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange/timerange/frequency/unit: .. rst-class:: ansible-option-title **unit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange/timerange/frequency/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange/timerange/from: .. rst-class:: ansible-option-title **from** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
From. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/schedulerange/timerange/to: .. rst-class:: ansible-option-title **to** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
To. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-schedule/testschedulemode: .. rst-class:: ansible-option-title **testScheduleMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Test Schedule Mode. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_module__parameter-templatename: .. rst-class:: ansible-option-title **templateName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Template Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_test_template_edit_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
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are sensors.Sensors.edit\_sensor\_test\_template, - Paths used are put /dna/intent/api/v1/AssuranceScheduleSensorTest, - 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 Sensors EditSensorTestTemplate `_ Complete reference of the EditSensorTestTemplate API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update all cisco.dnac.sensor_test_template_edit: 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}}" locationInfoList: - allSensors: true locationId: string locationType: string siteHierarchy: string schedule: frequency: unit: string value: 0 scheduleRange: - day: string timeRange: - frequency: unit: string value: 0 from: string to: string testScheduleMode: string templateName: string .. 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.sensor_test_template_edit_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": {"\_id": "string", "apCoverage": [{"bands": "string", "numberOfApsToTest": 0, "rssiThreshold": 0}], "connection": "string", "encryptionMode": "string", "frequency": {}, "lastModifiedTime": 0, "legacyTestSuite": true, "location": {}, "locationInfoList": [{"allSensors": true, "locationId": "string", "locationType": "string", "macAddressList": [{}], "siteHierarchy": "string"}], "modelVersion": 0, "name": "string", "numAssociatedSensor": 0, "numNeighborAPThreshold": 0, "radioAsSensorRemoved": true, "rssiThreshold": 0, "runNow": "string", "schedule": {"frequency": {"unit": "string", "value": 0}, "scheduleRange": [{"day": "string", "timeRange": [{"frequency": {"unit": "string", "value": 0}, "from": "string", "to": "string"}]}], "startTime": 0, "testScheduleMode": "string"}, "scheduleInDays": 0, "sensors": [{}], "showWlcUpgradeBanner": true, "siteHierarchy": {}, "ssids": [{"authProtocol": {}, "authType": "string", "authTypeRcvd": {}, "bands": {}, "certdownloadurl": {}, "certfilename": {}, "certpassphrase": {}, "certstatus": "string", "certxferprotocol": "string", "eapMethod": {}, "extWebAuth": true, "extWebAuthAccessUrl": {}, "extWebAuthHtmlTag": [{}], "extWebAuthPortal": {}, "extWebAuthVirtualIp": {}, "id": 0, "layer3webAuthEmailAddress": {}, "layer3webAuthpassword": {}, "layer3webAuthsecurity": {}, "layer3webAuthuserName": {}, "numAps": 0, "numSensors": 0, "password": {}, "profileName": "string", "psk": "string", "qosPolicy": "string", "scep": true, "ssid": "string", "status": "string", "tests": [{"config": [{}], "name": "string"}], "thirdParty": {"selected": true}, "username": {}, "validFrom": 0, "validTo": 0, "whiteList": true, "wlanId": 0, "wlc": {}}], "startTime": 0, "status": "string", "tenantId": "string", "testDurationEstimate": 0, "testScheduleMode": "string", "testTemplate": true, "tests": {}, "version": 0, "wlans": [{}]}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors