cisco.dnac.sensor_test_template_edit – Resource module for Sensor Test Template Edit

Note

This plugin is part of the cisco.dnac collection (version 3.1.1).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.sensor_test_template_edit.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Manage operation update of the resource Sensor Test Template Edit.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

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.

See Also

See also

Sensor Test Template Edit reference

Complete reference of the Sensor Test Template Edit object model.

Examples

- 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

Return Values

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

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" } }


Authors

  • Rafael Campos (@racampos)