.. Document meta :orphan: .. 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 -- Resource module for Sensor Test Template Edit +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.1.2). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.sensor_test_template_edit`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation update of the resource Sensor Test Template Edit. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
locationInfoList
list / elements=string
Sensor Test Template Edit's locationInfoList.
allSensors
boolean
    Choices:
  • no
  • yes
All Sensors.
locationId
string
Location Id.
locationType
string
Location Type.
siteHierarchy
string
Site Hierarchy.
schedule
dictionary
Sensor Test Template Edit's schedule.
frequency
dictionary
Sensor Test Template Edit's frequency.
unit
string
Unit.
value
integer
Value.
scheduleRange
list / elements=string
Sensor Test Template Edit's scheduleRange.
day
string
Day.
timeRange
list / elements=string
Sensor Test Template Edit's timeRange.
frequency
dictionary
Sensor Test Template Edit's frequency.
unit
string
Unit.
value
integer
Value.
from
string
From.
to
string
To.
testScheduleMode
string
Test Schedule Mode.
templateName
string
Template Name.

.. Notes .. Seealso See Also -------- .. seealso:: `Sensor Test Template Edit reference `_ Complete reference of the Sensor Test Template Edit object model. .. 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: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "version": "string", "response": { "_id": "string", "name": "string", "version": 0, "modelVersion": 0, "startTime": 0, "lastModifiedTime": 0, "numAssociatedSensor": 0, "location": {}, "siteHierarchy": {}, "status": "string", "connection": "string", "frequency": {}, "rssiThreshold": 0, "numNeighborAPThreshold": 0, "scheduleInDays": 0, "wlans": [], "ssids": [ { "bands": {}, "ssid": "string", "profileName": "string", "authType": "string", "authTypeRcvd": {}, "psk": "string", "username": {}, "password": {}, "eapMethod": {}, "scep": true, "authProtocol": {}, "certfilename": {}, "certxferprotocol": "string", "certstatus": "string", "certpassphrase": {}, "certdownloadurl": {}, "numAps": 0, "numSensors": 0, "layer3webAuthsecurity": {}, "layer3webAuthuserName": {}, "layer3webAuthpassword": {}, "extWebAuthVirtualIp": {}, "layer3webAuthEmailAddress": {}, "qosPolicy": "string", "extWebAuth": true, "whiteList": true, "extWebAuthPortal": {}, "extWebAuthAccessUrl": {}, "extWebAuthHtmlTag": [], "thirdParty": { "selected": true }, "id": 0, "wlanId": 0, "wlc": {}, "validFrom": 0, "validTo": 0, "status": "string", "tests": [ { "name": "string", "config": [] } ] } ], "testScheduleMode": "string", "showWlcUpgradeBanner": true, "radioAsSensorRemoved": true, "encryptionMode": "string", "runNow": "string", "locationInfoList": [ { "locationId": "string", "locationType": "string", "allSensors": true, "siteHierarchy": "string", "macAddressList": [] } ], "schedule": { "testScheduleMode": "string", "scheduleRange": [ { "timeRange": [ { "from": "string", "to": "string", "frequency": { "value": 0, "unit": "string" } } ], "day": "string" } ], "startTime": 0, "frequency": { "value": 0, "unit": "string" } }, "tests": {}, "sensors": [], "apCoverage": [ { "bands": "string", "numberOfApsToTest": 0, "rssiThreshold": 0 } ], "testDurationEstimate": 0, "testTemplate": true, "legacyTestSuite": true, "tenantId": "string" } }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors